Class Key

Hierarchy

Key

Index

Constructors

constructor

Properties

classes

Methods

Object literals

classes

Constructors

constructor

new Key(options: object): Key

- Defined in key/index.ts:23
Parameters
- options: object
  - networkId: NetworkId
Returns Key

Properties

classes

classes: object = Key.classes

Type declaration

AssetTransferAddress: AssetTransferAddress
LocalKeyStore: LocalKeyStore
PlatformAddress: PlatformAddress
RemoteKeyStore: RemoteKeyStore

Methods

createLocalKeyStore

createLocalKeyStore(): Promise<KeyStore>

- Defined in key/index.ts:40
Creates persistent key store which stores data in the filesystem.

Returns Promise<KeyStore>

createP2PKH

createP2PKH(params: object): P2PKH

- Defined in key/index.ts:67
Creates P2PKH script generator.

Parameters
- params: object
  - keyStore: KeyStore
Returns P2PKH

new instance of P2PKH

createP2PKHBurn

createP2PKHBurn(params: object): P2PKHBurn

- Defined in key/index.ts:82
Creates P2PKHBurn script generator.

Parameters
- params: object
  - keyStore: KeyStore
Returns P2PKHBurn

new instance of P2PKHBurn

createPlatformAddress

createPlatformAddress(params: object): Promise<PlatformAddress>

- Defined in key/index.ts:48
Creates a new platform address

Parameters
- params: object
  - keyStore: KeyStore
Returns Promise<PlatformAddress>

A new platform address

createRemoteKeyStore

createRemoteKeyStore(keystoreURL: string): Promise<KeyStore>

- Defined in key/index.ts:33
Creates persistent key store

Parameters
- keystoreURL: string
  
  key store url (ex http://localhost:7007)
Returns Promise<KeyStore>

signParcel

signParcel(parcel: Parcel, params: object): Promise<SignedParcel>

- Defined in key/index.ts:103
Signs a Parcel with the given account.

throws

When nonce or fee in the Parcel is null

throws

When account or its passphrase is invalid

Parameters
- parcel: Parcel
  
  A Parcel
- params: object
  - account: PlatformAddress | string
    
    An account.
  - fee: U256 | string | number
  - keyStore: KeyStore
    
    A key store.
  - nonce: U256 | string | number
  - Optional passphrase?: undefined | string
    
    The passphrase for the given account
Returns Promise<SignedParcel>

A SignedParcel

Object literals

Static classes

classes: object

AssetTransferAddress

AssetTransferAddress: AssetTransferAddress

LocalKeyStore

LocalKeyStore: LocalKeyStore

PlatformAddress

PlatformAddress: PlatformAddress

RemoteKeyStore

RemoteKeyStore: RemoteKeyStore

Generated using TypeDoc