-
Notifications
You must be signed in to change notification settings - Fork 274
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(sdk-coin-bnb): create new bnb module
Ticket: EA-709
- Loading branch information
Showing
44 changed files
with
822 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| node_modules | ||
| .idea | ||
| public | ||
| dist | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| node_modules/ | ||
| .idea/ | ||
| dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| require: 'ts-node/register' | ||
| timeout: '60000' | ||
| reporter: 'min' | ||
| reporter-option: | ||
| - 'cdn=true' | ||
| - 'json=false' | ||
| exit: true | ||
| spec: ['test/unit/**/*.ts'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| !dist/ | ||
| dist/test/ | ||
| dist/tsconfig.tsbuildinfo | ||
| .idea/ | ||
| .prettierrc.yml | ||
| tsconfig.json | ||
| src/ | ||
| test/ | ||
| scripts/ | ||
| .nyc_output | ||
| CODEOWNERS | ||
| node_modules/ | ||
| .prettierignore | ||
| .mocharc.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| .nyc_output/ | ||
| dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| printWidth: 120 | ||
| singleQuote: true | ||
| trailingComma: 'es5' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # BitGo sdk-coin-bnb | ||
|
|
||
| SDK coins provide a modular approach to a monolithic architecture. This and all BitGoJS SDK coins allow developers to use only the coins needed for a given project. | ||
|
|
||
| ## Installation | ||
|
|
||
| All coins are loaded traditionally through the `bitgo` package. If you are using coins individually, you will be accessing the coin via the `@bitgo/sdk-api` package. | ||
|
|
||
| In your project install both `@bitgo/sdk-api` and `@bitgo/sdk-coin-bnb`. | ||
|
|
||
| ```shell | ||
| npm i @bitgo/sdk-api @bitgo/sdk-coin-bnb | ||
| ``` | ||
|
|
||
| Next, you will be able to initialize an instance of "bitgo" through `@bitgo/sdk-api` instead of `bitgo`. | ||
|
|
||
| ```javascript | ||
| import { BitGoAPI } from '@bitgo/sdk-api'; | ||
| import { Bnb } from '@bitgo/sdk-coin-bnb'; | ||
|
|
||
| const sdk = new BitGoAPI(); | ||
|
|
||
| sdk.register('bnb', Bnb.createInstance); | ||
| ``` | ||
|
|
||
| ## Development | ||
|
|
||
| Most of the coin implementations are derived from `@bitgo/sdk-core`, `@bitgo/statics`, and coin specific packages. These implementations are used to interact with the BitGo API and BitGo platform services. | ||
|
|
||
| You will notice that the basic version of common class extensions have been provided to you and must be resolved before the package build will succeed. Upon initiation of a given SDK coin, you will need to verify that your coin has been included in the root `tsconfig.packages.json` and that the linting, formatting, and testing succeeds when run both within the coin and from the root of BitGoJS. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| { | ||
| "name": "@bitgo/sdk-coin-bnb", | ||
| "version": "1.0.0", | ||
| "description": "BitGo SDK coin library for Bnb smart chain", | ||
| "main": "./dist/src/index.js", | ||
| "types": "./dist/src/index.d.ts", | ||
| "scripts": { | ||
| "build": "yarn tsc --build --incremental --verbose .", | ||
| "fmt": "prettier --write .", | ||
| "check-fmt": "prettier --check .", | ||
| "clean": "rm -r ./dist", | ||
| "lint": "eslint --quiet .", | ||
| "prepare": "npm run build", | ||
| "test": "npm run coverage", | ||
| "coverage": "nyc -- npm run unit-test", | ||
| "unit-test": "mocha" | ||
| }, | ||
| "author": "BitGo SDK Team <[email protected]>", | ||
| "license": "MIT", | ||
| "engines": { | ||
| "node": ">=14 <17" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/BitGo/BitGoJS.git", | ||
| "directory": "modules/sdk-coin-bnb" | ||
| }, | ||
| "lint-staged": { | ||
| "*.{js,ts}": [ | ||
| "yarn prettier --write", | ||
| "yarn eslint --fix" | ||
| ] | ||
| }, | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "nyc": { | ||
| "extension": [ | ||
| ".ts" | ||
| ] | ||
| }, | ||
| "dependencies": { | ||
| "@bitgo/abstract-eth": "^1.2.27", | ||
| "@bitgo/sdk-coin-eth": "^4.5.4", | ||
| "@bitgo/sdk-core": "^8.10.0", | ||
| "@bitgo/statics": "^17.0.1", | ||
| "@ethereumjs/common": "^2.4.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@bitgo/sdk-api": "^1.11.2", | ||
| "@bitgo/sdk-test": "^1.2.27" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import { BaseCoin, BitGoBase, MPCAlgorithm } from '@bitgo/sdk-core'; | ||
| import { BaseCoin as StaticsBaseCoin, coins } from '@bitgo/statics'; | ||
| import { AbstractEthLikeCoin } from '@bitgo/abstract-eth'; | ||
| import { TransactionBuilder as EthTransactionBuilder } from '@bitgo/sdk-coin-eth'; | ||
| import { TransactionBuilder } from './lib'; | ||
|
|
||
| export class Bnb extends AbstractEthLikeCoin { | ||
| protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) { | ||
| super(bitgo, staticsCoin); | ||
| } | ||
|
|
||
| static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin { | ||
| return new Bnb(bitgo, staticsCoin); | ||
| } | ||
|
|
||
| protected getTransactionBuilder(): EthTransactionBuilder { | ||
| return new TransactionBuilder(coins.get(this.getBaseChain())); | ||
| } | ||
|
|
||
| /** @inheritDoc */ | ||
| supportsTss(): boolean { | ||
| return true; | ||
| } | ||
|
|
||
| /** @inheritDoc */ | ||
| getMPCAlgorithm(): MPCAlgorithm { | ||
| return 'ecdsa'; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /** | ||
| * @prettier | ||
| */ | ||
|
|
||
| import { EthLikeTokenConfig } from '@bitgo/statics'; | ||
| import { BitGoBase, CoinConstructor, MPCAlgorithm, NamedCoinConstructor } from '@bitgo/sdk-core'; | ||
| import { CoinNames, EthLikeToken } from '@bitgo/abstract-eth'; | ||
|
|
||
| export { EthLikeTokenConfig }; | ||
|
|
||
| export class BnbToken extends EthLikeToken { | ||
| public readonly tokenConfig: EthLikeTokenConfig; | ||
| static coinNames: CoinNames = { | ||
| Mainnet: 'bnb', | ||
| Testnet: 'tbnb', | ||
| }; | ||
| constructor(bitgo: BitGoBase, tokenConfig: EthLikeTokenConfig) { | ||
| super(bitgo, tokenConfig, BnbToken.coinNames); | ||
| } | ||
| static createTokenConstructor(config: EthLikeTokenConfig): CoinConstructor { | ||
| return super.createTokenConstructor(config, BnbToken.coinNames); | ||
| } | ||
|
|
||
| static createTokenConstructors(): NamedCoinConstructor[] { | ||
| return super.createTokenConstructors(BnbToken.coinNames); | ||
| } | ||
|
|
||
| getFullName(): string { | ||
| return 'Bnb Token'; | ||
| } | ||
|
|
||
| supportsTss(): boolean { | ||
| return true; | ||
| } | ||
|
|
||
| getMPCAlgorithm(): MPCAlgorithm { | ||
| return 'ecdsa'; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| export * from './lib'; | ||
| export * from './bnb'; | ||
| export * from './tbnb'; | ||
| export * from './bnbToken'; | ||
| export * from './register'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| import * as Utils from './utils'; | ||
|
|
||
| export { TransactionBuilder } from './transactionBuilder'; | ||
| export { TransferBuilder } from './transferBuilder'; | ||
| export { Transaction, KeyPair } from '@bitgo/sdk-coin-eth'; | ||
| export { Utils }; |
Oops, something went wrong.