{"id":24143312,"url":"https://github.com/little-core-labs/hypercore-upload-server","last_synced_at":"2025-09-19T11:31:59.843Z","repository":{"id":57270183,"uuid":"265569120","full_name":"little-core-labs/hypercore-upload-server","owner":"little-core-labs","description":"File ingestion with Hypercore over WebSockets","archived":false,"fork":false,"pushed_at":"2020-06-16T20:42:09.000Z","size":41,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-09-01T16:56:15.926Z","etag":null,"topics":["hypercore","server","upload"],"latest_commit_sha":null,"homepage":"","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/little-core-labs.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":"2020-05-20T13:10:25.000Z","updated_at":"2021-07-28T15:26:39.000Z","dependencies_parsed_at":"2022-08-25T02:51:37.189Z","dependency_job_id":null,"html_url":"https://github.com/little-core-labs/hypercore-upload-server","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/little-core-labs/hypercore-upload-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/little-core-labs%2Fhypercore-upload-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/little-core-labs%2Fhypercore-upload-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/little-core-labs%2Fhypercore-upload-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/little-core-labs%2Fhypercore-upload-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/little-core-labs","download_url":"https://codeload.github.com/little-core-labs/hypercore-upload-server/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/little-core-labs%2Fhypercore-upload-server/sbom","scorecard":{"id":592979,"data":{"date":"2025-08-11","repo":{"name":"github.com/little-core-labs/hypercore-upload-server","commit":"3dcf7d17382d4607600c101fe027964160fd1dfb"},"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":"Code-Review","score":0,"reason":"Found 0/14 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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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-20T22:25:46.264Z","repository_id":57270183,"created_at":"2025-08-20T22:25:46.265Z","updated_at":"2025-08-20T22:25:46.265Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275927963,"owners_count":25554310,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-19T02:00:09.700Z","response_time":108,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["hypercore","server","upload"],"created_at":"2025-01-12T05:14:59.934Z","updated_at":"2025-09-19T11:31:59.562Z","avatar_url":"https://github.com/little-core-labs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"hypercore-upload-server\n=======================\n\n\u003e File ingestion with Hypercore over WebSockets\n\n## Installation\n\n```sh\n$ npm install hypercore-upload-server\n```\n\n## Example\n\n### Server\n\nSee [example/server.js](example/server.js)\n\n### Client\n\nSee [example/client.js](example/client.js)\n\n## Usage\n\n```js\nconst { Server } = require('hypercore-upload-server')\nconst path = require('path')\nconst raf = require('random-access-file')\n\nconst dataDir = '/path/to/data/dir'\n\nconst server = new Server({\n  // storage for Corestore and it's Hypercore instances\n  storage(filename) {\n    return raf(path.reolve(dataDir, filename))\n  },\n\n  // write uploaded chunks somewhere, like S3, the filesystem, or a Hyperdrive\n  onwrite(key, offset, buffer, metadata, callback) {\n    const filename = path.resolve(data, metadata.name)\n    touch(filename, (err) =\u003e {\n      if (err) { return callback(err) }\n      fs.open(filename, fs.constants.O_RDWR | fs.constants.O_CREAT, (err, fd) =\u003e {\n        if (err) { return callback(err) }\n        fs.write(fd, buffer, 0, buffer.length, offset, (err) =\u003e {\n          if (err) { return callback(err) }\n          fs.close(fd, callback)\n        })\n      })\n    })\n  }\n})\n```\n\n## API\n\n### `server = new Server(opts)`\n\nCreate a new `Server` for hypercore uploads over websockets where `opts`\ncan be:\n\n```js\n{\n  corestore: null, // a corestore for a hypercore/hypertrie factory\n  storage: null // an optional random access storage factory for a `Corestore` instance\n  onwrite: (key, offset, data, metadata, callback) =\u003e { ... }, // called when data for a key at an offset needs to be written\n  gc: {\n    timeout: 5 * 1000 // timeout in milliseconds before a worker thread GC's any resources\n  }\n}\n```\n\nSee [`example/server.js`](example/server.js) for a complete example.\n\n\n#### `server.listen(port[, host[, callback]])`\n\nListen on a given `port` an optional `host` calling `callback(err)` upon\nerror or success.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flittle-core-labs%2Fhypercore-upload-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flittle-core-labs%2Fhypercore-upload-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flittle-core-labs%2Fhypercore-upload-server/lists"}