https://github.com/bnb-chain/javascript-sdk
Javascript SDK to communicate with BNB Beacon Chain.
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 29 committers (3.4%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.5%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Javascript SDK to communicate with BNB Beacon Chain.
Basic Info
Statistics
- Stars: 384
- Watchers: 31
- Forks: 239
- Open Issues: 4
- Releases: 0
Topics
Metadata Files
README.md
The BNB Beacon Chain JavaScript SDK allows browsers and Node.js clients to interact with BNB Beacon Chain. It includes the following core components.
- crypto - core cryptographic functions.
- amino - amino (protobuf-like) encoding and decoding of transactions.
- client - implementations of BNB Beacon Chain transaction types, such as for transfers and trading.
- accounts - management of "accounts" and wallets, including seed and encrypted mnemonic generation.
- ledger - Ledger Nano S/X support via HID, U2F and Web BLE (Bluetooth).
- rpc - Node RPC client.
- transaction - Transaction Class, build and sign.
You can find more detailed documentation and examples in our Documentation pages.
Installation
If you do not need Ledger support with Node.js:
```bash $ npm i @bnb-chain/javascript-sdk --no-optional
Or:
$ yarn add @bnb-chain/javascript-sdk --no-optional ```
If you need Ledger support with Node.js:
```bash $ npm i @bnb-chain/javascript-sdk
Or:
$ yarn add @bnb-chain/javascript-sdk ```
Prerequisites
Windows users: Please install windows-build-tools first.
Mac users: Make sure XCode Command Line Tools are installed:
xcode-select --install.Linux users: Note that Ubuntu Xenial and newer distributions are recommended, especially when using Travis or other CI systems. You may need some dev packages to be installed on your system for USB support. On Debian-based distributions (like Ubuntu) you should install them with this command:
bash
$ sudo apt-get install libudev-dev libusb-dev usbutils
Use with Webpack
We often see Webpack builds failing with the SDK due to the usb dependency,
but adding this to your Webpack config should fix that:
js
module.exports = {
plugins: [new webpack.IgnorePlugin(/^usb$/)],
}
Testing
All new code changes should be covered with unit tests. You can run the tests with the following command:
bash
$ yarn test
Tests for the Ledger hardware wallet integration have their own suite that runs in both node and in the browser:
bash
$ yarn test:ledger
$ yarn test:ledger:browser
Contributing
Contributions to the BNB Beacon Chain JavaScript SDK are welcome. Please ensure that you have tested the changes with a local client and have added unit test coverage for your code.
Owner
- Name: bnb-chain
- Login: bnb-chain
- Kind: organization
- Website: https://www.bnbchain.org
- Twitter: BNBChain
- Repositories: 99
- Profile: https://github.com/bnb-chain
For BNB Chain: BNB Smart Chain, BNB Beacon Chain
GitHub Events
Total
- Release event: 2
- Watch event: 12
- Delete event: 1
- Member event: 1
- Issue comment event: 4
- Push event: 2
- Pull request event: 2
- Fork event: 5
- Create event: 3
Last Year
- Release event: 2
- Watch event: 12
- Delete event: 1
- Member event: 1
- Issue comment event: 4
- Push event: 2
- Pull request event: 2
- Fork event: 5
- Create event: 3
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Luke Plaster | me@l****g | 156 |
| zj | z****e@d****m | 88 |
| zj | x****l@l****m | 61 |
| robot-ux | r****x@p****m | 19 |
| dependabot[bot] | 4****] | 12 |
| HaoyangLiu | l****8@1****m | 11 |
| Rubén Illodo Brea | me@r****m | 10 |
| Kai Ansaari | k****i@g****m | 6 |
| zj | 6****4@q****m | 6 |
| fiowind | f****o@f****l | 4 |
| fiowind | f****x@g****m | 4 |
| Ferenc Kiraly | f****i@f****m | 2 |
| veado | 6****o | 1 |
| randyahx | 6****x | 1 |
| jpopxfile | r****m@g****m | 1 |
| artem | a****4@g****m | 1 |
| Stuart | 1****k | 1 |
| STEVEN ADAMS | 1****e | 1 |
| Ahmad ElSokkary | a****y@g****m | 1 |
| Anderson Juhasc | a****c@g****m | 1 |
| Anton Lopan | a****n@g****m | 1 |
| Ivan Zhelyazkov | k****n@g****m | 1 |
| Jens Krause | e****l@j****o | 1 |
| Joenel de Asis | j****s@g****m | 1 |
| Kirill Fedoseev | k****v@i****y | 1 |
| Lucas Cullen | b****e | 1 |
| Nil Puig | h****o@n****o | 1 |
| Roman Vanesyan | r****n@g****m | 1 |
| RumeelHussainbnb | 9****b | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 85
- Total pull requests: 114
- Average time to close issues: almost 2 years
- Average time to close pull requests: 3 months
- Total issue authors: 55
- Total pull request authors: 17
- Average comments per issue: 1.15
- Average comments per pull request: 0.51
- Merged pull requests: 85
- Bot issues: 0
- Bot pull requests: 20
Past Year
- Issues: 3
- Pull requests: 4
- Average time to close issues: 6 months
- Average time to close pull requests: 4 minutes
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 1.67
- Average comments per pull request: 1.25
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- notatestuser (16)
- Bibianoo (6)
- Johnsavadkuhi (3)
- fiowind (3)
- Mahsa-Bastankhah (3)
- EnoRage (2)
- fangfan525 (2)
- tawhidnazari57 (2)
- pitersky (2)
- Totenfluch (1)
- pablokurskii (1)
- pw96pw96pw96 (1)
- sschiessl-bcp (1)
- CatScan-crypt (1)
- junha-ahn (1)
Pull Request Authors
- xzjcool (42)
- dependabot[bot] (23)
- notatestuser (21)
- robot-ux (17)
- ModernPortable (3)
- fiowind (3)
- Johnsavadkuhi (2)
- hugehope (2)
- feri42 (2)
- randyahx (1)
- Sokkary (1)
- ghost (1)
- Eren0180 (1)
- RumeelHussainbnb (1)
- Mohammed-Alanazisa (1)