{"id":15789924,"url":"https://github.com/gettocat/orwelldb","last_synced_at":"2026-04-27T23:32:39.366Z","repository":{"id":57316368,"uuid":"103441789","full_name":"gettocat/orwelldb","owner":"gettocat","description":"Library wich syncronize data beetween blockchain and database","archived":false,"fork":false,"pushed_at":"2019-09-19T18:11:43.000Z","size":252,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-09T12:48:10.673Z","etag":null,"topics":["blockchain","database","orwell","orwelldb","protocol","synchronization"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gettocat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-13T19:27:54.000Z","updated_at":"2019-09-19T18:11:45.000Z","dependencies_parsed_at":"2022-08-25T21:11:01.642Z","dependency_job_id":null,"html_url":"https://github.com/gettocat/orwelldb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gettocat/orwelldb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gettocat%2Forwelldb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gettocat%2Forwelldb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gettocat%2Forwelldb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gettocat%2Forwelldb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gettocat","download_url":"https://codeload.github.com/gettocat/orwelldb/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gettocat%2Forwelldb/sbom","scorecard":{"id":424748,"data":{"date":"2025-08-11","repo":{"name":"github.com/gettocat/orwelldb","commit":"23fb707dcd7ae03563542e6949a1d065dde9d888"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-19T01:59:45.176Z","repository_id":57316368,"created_at":"2025-08-19T01:59:45.176Z","updated_at":"2025-08-19T01:59:45.176Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32360110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-27T20:07:02.737Z","status":"ssl_error","status_checked_at":"2026-04-27T20:07:00.910Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","database","orwell","orwelldb","protocol","synchronization"],"created_at":"2024-10-04T22:04:12.850Z","updated_at":"2026-04-27T23:32:39.348Z","avatar_url":"https://github.com/gettocat.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Idea\n\n[![](https://gettocat.github.io/orwelldb/orwelldb_overview.jpeg)](https://gettocat.github.io/orwelldb/orwelldb_overview.jpeg)\n\n# orwelldb\nLibrary which synchronize data between blockchain and database\n\n# based\nAll protocol based on network bitcoin types, like var_int, var_str and other. You can find this types and parser/builder for that in my another package: [bitPony](https://github.com/gettocat/bitPony)\n\n# Orwelldb usage\n\n## install\n```\nnpm install orwelldb\n```\n\n## add to app\n```js\nvar orwelldb = require('orwelldb');\n```\n\n## interface\n```js\n\norwelldb.import(orwell_params, 'script or array of script')//returns Promise object\norwelldb.export(orwell_params, execFunction)//returns Promise object\norwelldb.$(orwell_params) //access to db api. return Promise\norwelldb.datascript //datascript builder/parser\n\n```\n\n## orwell params\n\n```js\n{\n\tadapter: mysqlAdapter,//database adapter object or empty for using native (nosql lokijs)\n\tname: 'db1',//database name\n\tpublic_key: \"\", //writer or owner public key\n\tkeystore: {//keystore settings, for example can be used another user to keystore, or another adapter\n\t\tadapter: mysqlAdapter, //keystore db adapter\n\t\tname: 'keystore', //keystore database name\n\t\toptions: { //keystore adapter options (for mysql need auth data)\n\t\t\tdbuser: 'orwelldb',\n\t\t\tdbpass: '',\n\t\t\tmodelspath: '../_tests/models/keystore' //node-orm2 use models file with shema defenition\n\t\t}\n\t},\n\toptions: { //adapter options\n\t\tdbuser: 'orwelldb',\n\t\tdbpass: '',\n\t\tmodelspath: '../_tests/models/index' \n\t}\n}\n```\n\n## import\n\n```js\nnew orwellsb.import(orwell_params, 'ef....datascript hex...')\n.then(function (results) {\n    //results is array of import result\n})\n.catch(function (e) {\n    //error if have\n})\n\n```\n\n### import result\n```js\n{ \n    operation: 'update',//operation insert/update\n    data: //data from database (with meta data)\n     { oid: 1,\n       writeScript: 5560,\n       owner_key: '',\n       privileges: [],\n       meta: [Object],\n       '$loki': 1 },\n    scenario: //scenario, datascript generated from\n     { operation: 'create', //datascript operation\n       dataset: 'posts', //dataset name\n       content: { oid: 1,\n                  writeScript: 5560,\n                  owner_key: '',\n                  privileges: [], }, \n       algorithm: 'rsa' }, //if have keystore for this db\\dataset - encryption is enabled\n    status: 0  //0 = ok, another status from 0 or 'ok' its error, error description in error field.\n }\n```\n\n\n## export\n\n```js\norwelldb.export(orwell_params, function (db) {\n\n        //actions in this function create datascript after result.\n        //must return promise!\n        //operations generated datascript in version 0.0.1: write, create, setSettings\n        //for example create dataset posts, after that write data {oid: '7f5aea2ff97f', title: 'test1', 'text': 'what?!'}\n\treturn db.create('posts', {privileges: [], writeScript: ''})\n\t\t\t.then(function (res) {\n\t\t\t\treturn db.write(\"posts\", {oid: '7f5aea2ff97f', title: 'test1', 'text': 'what?!'})\n\t\t\t})\n})\n\t.then(function (hex) {\n\n\t\t//hex - datascript, contains all operation in one transaction\n                //ef....\n                // create dataset posts then write data\n\n\t})\n```\n\n## database \n```js\nvar $ = orwelldb.$;\n\n$(orwell_options)\n.then(function (db) {\n\treturn db.getCollection(\"posts\")\n})\n.then(function (dataset) {//first time may be throwned, but second and next - okay\n\treturn dataset.findItems()\n})\n.then(function (list) {\n\t\n})\n.catch(function (err) {\n\tconsole.log(err)\n})\n```\n\ninterface descriped in wiki.\n\n## datascript\n```js\nvar datascript = orwelldb.datascript;\n```\n\n### parse\n```js\nvar obj = new datascript('hex or buffer', pem);\nobj.toJSON();\n```\nreturn:\n```js\n{\n        dataset: 'dataset name',\n        operator: 'operation',//write, create, settings\n        content: {},//data\n        canRead: true, // if false - datascript encrypted, need pem\n        success: true // if false - datascript is not valid\n}\n```\n\n### build\n```js\nvar obj = new datascript({\n    operation: 'write',\n    dataset: 'posts',\n    content: obj, \n    algorithm: 'rsa' // rsa or ecdh\n}, pem);\nobj.toHEX(); //returns hex string of datascript buffer.\n```\n\nMore information and examples you can read in orwelldb wiki: [wiki](https://github.com/gettocat/orwelldb/wiki)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgettocat%2Forwelldb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgettocat%2Forwelldb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgettocat%2Forwelldb/lists"}