{"id":13746616,"url":"https://github.com/bnb-chain/javascript-sdk","last_synced_at":"2025-05-15T10:05:42.743Z","repository":{"id":38196142,"uuid":"146728276","full_name":"bnb-chain/javascript-sdk","owner":"bnb-chain","description":"Javascript SDK to communicate with BNB Beacon Chain.","archived":false,"fork":false,"pushed_at":"2025-04-03T07:52:29.000Z","size":3110,"stargazers_count":383,"open_issues_count":4,"forks_count":238,"subscribers_count":31,"default_branch":"master","last_synced_at":"2025-04-14T19:56:44.261Z","etag":null,"topics":["blockchain","bnb","frontend","sdk"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bnb-chain.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-08-30T09:38:20.000Z","updated_at":"2025-04-03T07:51:30.000Z","dependencies_parsed_at":"2023-11-29T10:29:41.052Z","dependency_job_id":"95f85912-674f-41f7-879f-2813025c5246","html_url":"https://github.com/bnb-chain/javascript-sdk","commit_stats":null,"previous_names":["binance-chain/javascript-sdk"],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bnb-chain%2Fjavascript-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bnb-chain%2Fjavascript-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bnb-chain%2Fjavascript-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bnb-chain%2Fjavascript-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bnb-chain","download_url":"https://codeload.github.com/bnb-chain/javascript-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254319718,"owners_count":22051072,"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":["blockchain","bnb","frontend","sdk"],"created_at":"2024-08-03T06:00:57.070Z","updated_at":"2025-05-15T10:05:37.713Z","avatar_url":"https://github.com/bnb-chain.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","Exchange-based Tokens"],"sub_categories":[],"readme":"The BNB Beacon Chain JavaScript SDK allows browsers and Node.js clients to interact\nwith BNB Beacon Chain. It includes the following core components.\n\n- **crypto** - core cryptographic functions.\n- **amino** -\n  [amino](https://github.com/binance-chain/docs-site/blob/master/docs/encoding.md)\n  (protobuf-like) encoding and decoding of transactions.\n- **client** - implementations of BNB Beacon Chain transaction types, such as for\n  transfers and trading.\n- **accounts** - management of \"accounts\" and wallets, including seed and\n  encrypted mnemonic generation.\n- **ledger** - Ledger Nano S/X support via HID, U2F and Web BLE (Bluetooth).\n- **rpc** - Node RPC client.\n- **transaction** - Transaction Class, build and sign.\n\nYou can find more detailed documentation and examples in our\n[Documentation](https://github.com/binance-chain/javascript-sdk/blob/master/docs/README.md)\npages.\n\n## Installation\n\nIf you **do not** need Ledger support with Node.js:\n\n```bash\n$ npm i @bnb-chain/javascript-sdk --no-optional\n# Or:\n$ yarn add @bnb-chain/javascript-sdk --no-optional\n```\n\nIf you **need** Ledger support with Node.js:\n\n```bash\n$ npm i @bnb-chain/javascript-sdk\n# Or:\n$ yarn add @bnb-chain/javascript-sdk\n```\n\n### Prerequisites\n\n- **Windows users:** Please install\n  [windows-build-tools](https://www.npmjs.com/package/windows-build-tools)\n  first.\n\n- **Mac users:** Make sure XCode Command Line Tools are installed:\n  `xcode-select --install`.\n\n- **Linux users:** Note that Ubuntu Xenial and newer distributions are\n  recommended, especially when using Travis or other CI systems. You may need\n  some dev packages to be installed on your system for USB support. On\n  Debian-based distributions (like Ubuntu) you should install them with this\n  command:\n\n  ```bash\n  $ sudo apt-get install libudev-dev libusb-dev usbutils\n  ```\n\n### Use with Webpack\n\nWe often see Webpack builds failing with the SDK due to the `usb` dependency,\nbut adding this to your Webpack config should fix that:\n\n```js\nmodule.exports = {\n  plugins: [new webpack.IgnorePlugin(/^usb$/)],\n}\n```\n\n## Testing\n\nAll new code changes should be covered with unit tests. You can run the tests\nwith the following command:\n\n```bash\n$ yarn test\n```\n\nTests for the Ledger hardware wallet integration have their own suite that runs\nin both node and in the browser:\n\n```bash\n$ yarn test:ledger\n$ yarn test:ledger:browser\n```\n\n\n## Contributing\n\nContributions to the BNB Beacon Chain JavaScript SDK are welcome. Please ensure\nthat you have tested the changes with a local client and have added unit test\ncoverage for your code.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbnb-chain%2Fjavascript-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbnb-chain%2Fjavascript-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbnb-chain%2Fjavascript-sdk/lists"}