senaiapys / core Goto Github PK

The Coingrig Core library handling the wallet interactions

Import the library in your project with yarn add @coingrig/core

Run yarn. (Installs dependencies and links packages in the workspace.)

Create an .env file to configure the platform: TESTNET=true|false.
The default value is TESTNET=false.

Jest tests are set up to run with TESTNET=true yarn test.

BitcoinGenerator ⇐ GenericGenerator

BscGenerator ⇐ EthereumGenerator

EthereumGenerator ⇐ GenericGenerator

PolygonGenerator ⇐ EthereumGenerator

GenericGenerator

WalletFactory

WalletGenerator

GenericWallet

Don't use the generic wallet, for a new coin write an implementation

Kind: global class
Extends: GenericGenerator

Kind: global class
Extends: EthereumGenerator

Kind: global class
Extends: GenericGenerator

Kind: global class
Extends: EthereumGenerator

Kind: global class

• GenericGenerator
  • .generateWalletXpub(mnemonic, config) ⇒ string
  • .generatePrivateKeyFromMnemonic(mnemonic, derivation, config) ⇒ string
  • .generateAddressFromXPub(xpub, derivation, config) ⇒ string

Generate the wallet's XPUB

Kind: static method of GenericGenerator
Returns: string -

The XPUB value

Generate the wallet's Private Key

Kind: static method of GenericGenerator
Returns: string -

The Private Key

Generate teh wallet's Public Address

Kind: static method of GenericGenerator
Returns: string -

The Public Key

Kind: global class

Implements the Factory pattern to help generate easily wallets for the supported blockchains.

Kind: global class

• WalletGenerator
  • .generateMnemonic([size]) ⇒ string
  • .getDriver(chain) ⇒ GenericGenerator
  • .generateWalletXpub(chain, mnemonic, [config]) ⇒ string
  • .generatePrivateKeyFromMnemonic(chain, mnemonic, derivation, [config]) ⇒ string
  • .generateAddressFromXPub(chain, xpub, derivation, [config]) ⇒ string

Generates a string containing the 12 words used as a mnemonic to create the private and public wallet keys.

Kind: static method of WalletGenerator
Returns: string -

The mnemonic

Offers direct access to the drivers that offer the key generation.

Kind: static method of WalletGenerator

Generate the wallet's XPUB address. The source of all addresses to be generated for the public.

Kind: static method of WalletGenerator
Returns: string -

The wallet's XPUB address

Generate the wallet's private key.

Kind: static method of WalletGenerator
Returns: string -

The wallet's private key

Generate the public wallet address for the specified chain

Kind: static method of WalletGenerator
Returns: string -

The wallet's public address

Don't use the generic wallet, for a new coin write an implementation

Kind: global class

Enum for supported blockchains types

Kind: global enum
Read only: true
Properties

This library has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

The Coingrig Core Library is licensed under the MIT License.