Class Wallet

Hierarchy

Wallet

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Wallet(mnemonics?: string, language?: string, mnemonicPassword?: string): Wallet

- Defined in core/wallet.ts:132
Creates an instance of wallet.

Parameters
- Optional mnemonics: string
- Optional language: string
- Optional mnemonicPassword: string
Returns Wallet

Properties

accounts

accounts: Map<Blockchain, GenericAccount[]> = new Map()

currentNetwork

currentNetwork: any

Private mapper

mapper: DynamicClassMapper

mnemonics

mnemonics: string

mnemonicslang

mnemonicslang: string

nodes

nodes: Map<Blockchain, Map<number, GenericNode>> = new Map()

seed

seed: Buffer

Methods

createAccount

createAccount(blockchain: Blockchain, networkId?: number): GenericAccount

- Defined in core/wallet.ts:306
Creates an account on specified blockchain and network

Parameters
- blockchain: Blockchain
- Optional networkId: number
Returns GenericAccount

account

getAccounts

getAccounts(blockchain: Blockchain, reference?: boolean, filter?: boolean, networkId?: number): GenericAccount[]

- Defined in core/wallet.ts:180
Gets accounts

Parameters
- blockchain: Blockchain
- Default value reference: boolean = true
- Default value filter: boolean = false
- Optional networkId: number
Returns GenericAccount[]

accounts

getAccountsMap

getAccountsMap(): Map<Blockchain, GenericAccount[]>

- Defined in core/wallet.ts:215
Gets accounts map

Returns Map<Blockchain, GenericAccount[]>

accounts map

getBlockchain

getBlockchain(blockchain: Blockchain): object

- Defined in core/wallet.ts:224
Gets blockchain

Parameters
- blockchain: Blockchain
Returns object

an object containing all methods required to use this implementation
- createAccount: function
  - createAccount(): GenericAccount<GenericTransaction<ITransactionOptions>, ITransactionOptions>
  - - Defined in core/wallet.ts:229
    Returns GenericAccount<GenericTransaction<ITransactionOptions>, ITransactionOptions>
- getAccounts: function
  - getAccounts(): GenericAccount<GenericTransaction<ITransactionOptions>, ITransactionOptions>[]
  - - Defined in core/wallet.ts:227
    Returns GenericAccount<GenericTransaction<ITransactionOptions>, ITransactionOptions>[]
- getAllAccounts: function
  - getAllAccounts(): GenericAccount<GenericTransaction<ITransactionOptions>, ITransactionOptions>[]
  - - Defined in core/wallet.ts:228
    Returns GenericAccount<GenericTransaction<ITransactionOptions>, ITransactionOptions>[]
- getCurrentNetwork: function
  - getCurrentNetwork(): number
  - - Defined in core/wallet.ts:232
    Returns number
- getInitializedNodes: function
  - getInitializedNodes(): Map<number, GenericNode>
  - - Defined in core/wallet.ts:234
    Returns Map<number, GenericNode>
- getNetworks: function
  - getNetworks(): Network[]
  - - Defined in core/wallet.ts:231
    Returns Network[]
- getNode: function
  - getNode(): GenericNode
  - - Defined in core/wallet.ts:226
    Returns GenericNode
- importAccount: function
  - importAccount(account: GenericAccount): GenericAccount<GenericTransaction<ITransactionOptions>, ITransactionOptions>
  - - Defined in core/wallet.ts:230
    Parameters
    - account: GenericAccount
    Returns GenericAccount<GenericTransaction<ITransactionOptions>, ITransactionOptions>
- switchNetwork: function
  - switchNetwork(networkId: any): GenericNode
  - - Defined in core/wallet.ts:233
    Parameters
    - networkId: any
    Returns GenericNode

getClassMapper

getClassMapper(): DynamicClassMapper

- Defined in core/wallet.ts:159
Gets class mapper

Returns DynamicClassMapper

class mapper

getCurrentNetwork

getCurrentNetwork(blockchain: Blockchain): number

- Defined in core/wallet.ts:252
Gets current network for specified blockchain

Parameters
- blockchain: Blockchain
Returns number

current network

getNetworks

getNetworks(blockchain: Blockchain): Network[]

- Defined in core/wallet.ts:243
Gets networks

Parameters
- blockchain: Blockchain
Returns Network[]

networks

getNode

getNode(blockchain: Blockchain, networkId?: number): GenericNode

- Defined in core/wallet.ts:275
Gets existing node or initialises a new one for specified blockchain

Parameters
- blockchain: Blockchain
- Optional networkId: number
Returns GenericNode

node

importAccount

importAccount(account: GenericAccount): GenericAccount

- Defined in core/wallet.ts:346
Imports account

Parameters
- account: GenericAccount
Returns GenericAccount

account

loadBlockchain

loadBlockchain(blockchainImplementation: IBlockchainImplementation): void

- Defined in core/wallet.ts:167
Loads blockchain implementation

Parameters
- blockchainImplementation: IBlockchainImplementation
Returns void

requireImplementation

requireImplementation(blockchain: Blockchain, method: string): boolean

- Defined in core/wallet.ts:334
Requires implementation

Parameters
- blockchain: Blockchain
- method: string
Returns boolean

true if implementation is found, otherwise false

switchNetwork

switchNetwork(blockchain: Blockchain, networkId: number): GenericNode

- Defined in core/wallet.ts:264
Switches network for specified blockchain

Parameters
- blockchain: Blockchain
- networkId: number
Returns GenericNode

toJSON

toJSON(): string

- Defined in core/wallet.ts:365
Serialises wallet and returns a json string

Returns string

json

Static fromJson

fromJson(json: string, blockchains?: IBlockchainImplementation[]): Wallet

- Defined in core/wallet.ts:27
Instantiate wallet using a serialised data

Parameters
- json: string
- Optional blockchains: IBlockchainImplementation[]
Returns Wallet

Generated using TypeDoc