Class PrivateKey

Class for wrapping SigningKey that is used for signature creation and public key derivation.

Hierarchy

PrivateKey

Index

Methods

sign signEcda signHashed signHashedEcda toAddress toBech32 toHex toPublicKey fromMnemonic fromPrivateKey generate

Methods

sign

sign(messageBytes: Uint8Array): Promise<Uint8Array>
Sign the given message using the wallet's _signingKey function.

Returns
a signature of this private key over the given message
Parameters
- messageBytes: Uint8Array
Returns Promise<Uint8Array>
- Defined in src/classes/PrivateKey.ts:99

signEcda

signEcda(messageBytes: Buffer): Promise<Uint8Array>
Sign the given message using the edcsa sign_deterministic function.

Returns
a signature of this private key over the given message
Parameters
- messageBytes: Buffer
Returns Promise<Uint8Array>
- Defined in src/classes/PrivateKey.ts:116

signHashed

signHashed(messageHashedBytes: Buffer): Promise<Uint8Array>
Sign the given message using the wallet's _signingKey function.

Returns
a signature of this private key over the given message
Parameters
- messageHashedBytes: Buffer
Returns Promise<Uint8Array>
- Defined in src/classes/PrivateKey.ts:136

signHashedEcda

signHashedEcda(messageHashedBytes: Buffer): Promise<Uint8Array>
Sign the given message using the edcsa sign_deterministic function.

Returns
a signature of this private key over the given message
Parameters
- messageHashedBytes: Buffer
Returns Promise<Uint8Array>
- Defined in src/classes/PrivateKey.ts:154

toAddress

toAddress(): Address
Return the Address associated with this private key.

Returns

Returns Address
- Defined in src/classes/PrivateKey.ts:82

toBech32

toBech32(): string
Return the Router address associated with this private key.

Returns

Returns string
- Defined in src/classes/PrivateKey.ts:90

toHex

toHex(): string
Return a hex representation of signing key.

Returns

Returns string
- Defined in src/classes/PrivateKey.ts:64

toPublicKey

toPublicKey(): PublicKey
Return the PublicKey associated with this private key.

Returns
a Public key that can be used to verify the signatures made with this PrivateKey

Returns PublicKey
- Defined in src/classes/PrivateKey.ts:74

`Static` fromMnemonic

fromMnemonic(words: string, path?: undefined | string): PrivateKey
Create a PrivateKey instance from a given mnemonic phrase and a HD derivation path. If path is not given, default to Band's HD prefix 494 and all other indexes being zeroes.

Returns
Initialized PrivateKey object
Parameters
- words: string
  
  the mnemonic phrase
- path: undefined | string = DEFAULT_DERIVATION_PATH
  
  the HD path that follows the BIP32 standard (optional)
Returns PrivateKey
- Defined in src/classes/PrivateKey.ts:43

`Static` fromPrivateKey

fromPrivateKey(privateKey: string): PrivateKey
Create a PrivateKey instance from a given private key and a HD derivation path. If path is not given, default to Band's HD prefix 494 and all other indexes being zeroes.

Returns
Initialized PrivateKey object
Parameters
- privateKey: string
  
  the private key
Returns PrivateKey
- Defined in src/classes/PrivateKey.ts:56

`Static` generate

generate(): {
mnemonic: string;
privateKey: PrivateKey;
}
Generate new private key with random mnemonic phrase

Returns

Returns {
mnemonic: string;
privateKey: PrivateKey;
}
- mnemonic: string
- privateKey: PrivateKey
- Defined in src/classes/PrivateKey.ts:26

Class PrivateKey

Hierarchy

Index

Methods

Methods

sign

Returns

Parameters

messageBytes: Uint8Array

Returns Promise<Uint8Array>

signEcda

Returns

Parameters

messageBytes: Buffer

Returns Promise<Uint8Array>

signHashed

Returns

Parameters

messageHashedBytes: Buffer

Returns Promise<Uint8Array>

signHashedEcda

Returns

Parameters

messageHashedBytes: Buffer

Returns Promise<Uint8Array>

toAddress

Returns

Returns Address

toBech32

Returns

Returns string

toHex

Returns

Returns string

toPublicKey

Returns

Returns PublicKey

Static fromMnemonic

Returns

Parameters

words: string

path: undefined | string = DEFAULT_DERIVATION_PATH

Returns PrivateKey

Static fromPrivateKey

Returns

Parameters

privateKey: string

Returns PrivateKey

Static generate

Returns

Returns { mnemonic: string; privateKey: PrivateKey; }

mnemonic: string

privateKey: PrivateKey

Settings

Member Visibility

Theme

`Static` fromMnemonic

`Static` fromPrivateKey

`Static` generate

Returns {
mnemonic: string;
privateKey: PrivateKey;
}