Interface KeyAgent

Hierarchy

KeyAgent

Implemented by

Index

Accessors

accountIndex bip32Ed25519 chainId extendedAccountPublicKey serializableData

Methods

deriveAddress derivePublicKey exportRootPrivateKey signBlob signTransaction

Accessors

accountIndex

get accountIndex(): number
Returns number
- Defined in packages/key-management/src/types.ts:183

bip32Ed25519

get bip32Ed25519(): Bip32Ed25519
Returns Bip32Ed25519
- Defined in packages/key-management/src/types.ts:186

chainId

get chainId(): ChainId
Returns ChainId
- Defined in packages/key-management/src/types.ts:182

extendedAccountPublicKey

get extendedAccountPublicKey(): Bip32PublicKeyHex
Returns Bip32PublicKeyHex
- Defined in packages/key-management/src/types.ts:185

serializableData

get serializableData(): SerializableKeyAgentData
Returns SerializableKeyAgentData
- Defined in packages/key-management/src/types.ts:184

Methods

deriveAddress

deriveAddress(paymentKeyDerivationPath: AccountAddressDerivationPath, stakeKeyDerivationIndex: number): Promise<GroupedAddress>
Derives an address from the given payment key and stake key derivation path.
Parameters
- paymentKeyDerivationPath: AccountAddressDerivationPath
  
  The payment key derivation path.
- stakeKeyDerivationIndex: number
  
  The stake key index. This field is optional. If not provided it defaults to index 0.
Returns Promise<GroupedAddress>
- Defined in packages/key-management/src/types.ts:212

derivePublicKey

derivePublicKey(derivationPath: AccountKeyDerivationPath): Promise<Ed25519PublicKeyHex>
Throws
AuthenticationError
Parameters
- derivationPath: AccountKeyDerivationPath
Returns Promise<Ed25519PublicKeyHex>
- Defined in packages/key-management/src/types.ts:203

exportRootPrivateKey

exportRootPrivateKey(): Promise<Bip32PrivateKeyHex>
Throws
AuthenticationError

Returns Promise<Bip32PrivateKeyHex>
- Defined in packages/key-management/src/types.ts:219

signBlob

signBlob(derivationPath: AccountKeyDerivationPath, blob: HexBlob): Promise<SignBlobResult>
Throws
AuthenticationError
Parameters
- derivationPath: AccountKeyDerivationPath
- blob: HexBlob
Returns Promise<SignBlobResult>
- Defined in packages/key-management/src/types.ts:191

signTransaction

signTransaction(txInternals: TxBodyWithHash, context: SignTransactionContext, options?: SignTransactionOptions): Promise<Signatures>
Throws
AuthenticationError
Parameters
- txInternals: TxBodyWithHash
- context: SignTransactionContext
- Optional options: SignTransactionOptions
Returns Promise<Signatures>
- Defined in packages/key-management/src/types.ts:195

Generated using TypeDoc