{"id":22646375,"url":"https://github.com/fireblocks/ncw-backend-demo","last_synced_at":"2025-04-12T00:34:27.464Z","repository":{"id":189003681,"uuid":"679591268","full_name":"fireblocks/ncw-backend-demo","owner":"fireblocks","description":"Fireblocks Non custodial wallet demo backend","archived":false,"fork":false,"pushed_at":"2025-03-24T09:34:34.000Z","size":1815,"stargazers_count":11,"open_issues_count":15,"forks_count":18,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-24T10:35:19.091Z","etag":null,"topics":["ncw"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/fireblocks.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-17T07:20:07.000Z","updated_at":"2025-03-24T09:34:38.000Z","dependencies_parsed_at":"2023-09-26T16:12:09.885Z","dependency_job_id":"72194cae-c437-4557-9407-0085a2ca7b2a","html_url":"https://github.com/fireblocks/ncw-backend-demo","commit_stats":null,"previous_names":["fireblocks/ncw-backend-demo"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fireblocks%2Fncw-backend-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fireblocks%2Fncw-backend-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fireblocks%2Fncw-backend-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fireblocks%2Fncw-backend-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fireblocks","download_url":"https://codeload.github.com/fireblocks/ncw-backend-demo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501700,"owners_count":21114676,"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","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":["ncw"],"created_at":"2024-12-09T06:10:11.107Z","updated_at":"2025-04-12T00:34:27.436Z","avatar_url":"https://github.com/fireblocks.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cimg src=\"assets/images/logo.png\" width=\"30px\"/\u003e Non-Custodial Wallet Demo backend\n\n## Description\n\nThis is a demo application showcasing the capabilities of the Fireblocks platform with regard to Non Custodial Wallets.\n\n## Structure\n\n### modules tree\n\n- `src` - the main module of the project\n  - `model` - DB model entities\n  - `migrations` - DB migrations\n  - `subscribers` - DB subscribers\n  - `controllers` - Express request handlers\n  - `middleware` - Express middleware\n  - `routes` - Express route mapping\n  - `interfaces` - Type interfaces\n  - `services` - Business logic\n  - `test` - test related\n  - `util` - utlities\n\n## Usage\n\n### Configurations\n\nThe following environment variables are required,\n\n- General\n  - `PORT` - API listen port\n  - `ORIGIN_WEB_SDK` - (optional) override CORS origin (comma separated for multiple values) - default: (`http://localhost:5173,https://fireblocks.github.io`)\n- Fireblocks\n  - PEMs - Please replace newlines with \"\\n\" when providing PEMs.\n    - `FIREBLOCKS_WEBHOOK_PUBLIC_KEY` - Fireblocks webhook public key PEM (note: sandbox and production have different keys, [docs](https://developers.fireblocks.com/docs/webhooks-notifications#validation))\n    - `FIREBLOCKS_API_SECRET` - Private key PEM used for API Users (in production it's recommended to use different keys)\n  - API\n    - `FIREBLOCKS_API_KEY_NCW_SIGNER` - uuid key for API User: NCW Signer Role\n    - `FIREBLOCKS_API_KEY_NCW_ADMIN` - uuid key for API User: NCW Admin Role\n    - `FIREBLOCKS_API_BASE_URL` - Depending on your workspace environment: `https://sandbox-api.fireblocks.io/` or `https://api.fireblocks.io/`\n- Authentication - JWT verification middleware ([NPM express-oauth2-jwt-bearer](https://www.npmjs.com/package/express-oauth2-jwt-bearer))\n  - `ISSUER_BASE_URL`=`https://YOUR_ISSUER_DOMAIN`\n  - `AUDIENCE`=`https://my-api.com`\n  - `JWKS_URI` - optional\n  - `ISSUER` - optional\n- Database (mysql)\n  - `DB_HOST` - Database host\n  - `DB_PORT` - Database port\n  - `DB_USERNAME` - Database username\n  - `DB_PASSWORD` - Database password\n  - `DB_NAME` - Database name\n- CoinMarketCap\n  - `CMC_PRO_API_KEY` - CoinMarketCap API Key (optional for asset quotes)\n\n### Install\n\n```bash\n$ yarn\n```\n\n### Test\n\n```bash\n$ yarn test\n```\n\n### Build\n\n```bash\n$ yarn build\n```\n\n### Start\n\n```bash\n$ yarn start\n```\n\n### Migration\n\nCreate\n\n```bash\nyarn typeorm migration:create -n NameOfMigration\n```\n\nOR auto generate\n\n```bash\nyarn typeorm migration:generate src/migrations/NameOfMigration\n```\n\nRun\n\n```bash\nyarn migrate\n```\n\n### Model\n\n\u003cimg src=\"assets/images/model.png\"/\u003e\n\nauto-generated via `yarn db:diagram`\n\n## Links\n\nTBD\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffireblocks%2Fncw-backend-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffireblocks%2Fncw-backend-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffireblocks%2Fncw-backend-demo/lists"}