Class InMemoryKeyAgent

Hierarchy

KeyAgentBase
- InMemoryKeyAgent

Implements

KeyAgent

Index

Constructors

constructor

new InMemoryKeyAgent(__namedParameters: InMemoryKeyAgentProps, dependencies: KeyAgentDependencies): InMemoryKeyAgent
Parameters
- __namedParameters: InMemoryKeyAgentProps
- dependencies: KeyAgentDependencies
Returns InMemoryKeyAgent
Overrides KeyAgentBase.constructor
- Defined in packages/key-management/src/InMemoryKeyAgent.ts:57

Properties

`Private` `Readonly` #account

#account: Bip32Account

`Private` `Readonly` #bip32Ed25519

#bip32Ed25519: Bip32Ed25519

`Private` `Readonly` #getPassphrase

#getPassphrase: GetPassphrase

`Private` `Readonly` #serializableData

#serializableData: SerializableKeyAgentData

Accessors

accountIndex

get accountIndex(): number
Returns number
Implementation of KeyAgent.accountIndex

Inherited from KeyAgentBase.accountIndex
- Defined in packages/key-management/src/KeyAgentBase.ts:34

bip32Ed25519

get bip32Ed25519(): Bip32Ed25519
Returns Bip32Ed25519
Implementation of KeyAgent.bip32Ed25519

Inherited from KeyAgentBase.bip32Ed25519
- Defined in packages/key-management/src/KeyAgentBase.ts:37

chainId

get chainId(): ChainId
Returns ChainId
Implementation of KeyAgent.chainId

Inherited from KeyAgentBase.chainId
- Defined in packages/key-management/src/KeyAgentBase.ts:31

extendedAccountPublicKey

get extendedAccountPublicKey(): Bip32PublicKeyHex
Returns Bip32PublicKeyHex
Implementation of KeyAgent.extendedAccountPublicKey

Inherited from KeyAgentBase.extendedAccountPublicKey
- Defined in packages/key-management/src/KeyAgentBase.ts:28

purpose

get purpose(): KeyPurpose
Returns KeyPurpose
Implementation of KeyAgent.purpose

Inherited from KeyAgentBase.purpose
- Defined in packages/key-management/src/KeyAgentBase.ts:41

serializableData

get serializableData(): SerializableKeyAgentData
Returns SerializableKeyAgentData
Implementation of KeyAgent.serializableData

Inherited from KeyAgentBase.serializableData
- Defined in packages/key-management/src/KeyAgentBase.ts:25

Methods

`Private` #decryptRootPrivateKey

#decryptRootPrivateKey(noCache?: true): Promise<Bip32PrivateKeyHex>
Parameters
- Optional noCache: true
Returns Promise<Bip32PrivateKeyHex>
- Defined in packages/key-management/src/InMemoryKeyAgent.ts:174

deriveAddress

deriveAddress(paymentKeyDerivationPath: AccountAddressDerivationPath, stakeKeyDerivationIndex: number): Promise<GroupedAddress>
See https://github.com/cardano-foundation/CIPs/tree/master/CIP-1852#specification
Parameters
- paymentKeyDerivationPath: AccountAddressDerivationPath
- stakeKeyDerivationIndex: number
Returns Promise<GroupedAddress>
Implementation of KeyAgent.deriveAddress

Inherited from KeyAgentBase.deriveAddress
- Defined in packages/key-management/src/KeyAgentBase.ts:61

derivePublicKey

derivePublicKey(derivationPath: AccountKeyDerivationPath): Promise<Ed25519PublicKeyHex>
Throws
AuthenticationError
Parameters
- derivationPath: AccountKeyDerivationPath
Returns Promise<Ed25519PublicKeyHex>
Implementation of KeyAgent.derivePublicKey

Inherited from KeyAgentBase.derivePublicKey
- Defined in packages/key-management/src/KeyAgentBase.ts:68

exportExtendedKeyPair

exportExtendedKeyPair(derivationPath: number[]): Promise<KeyPair>
Based on root private key
Parameters
- derivationPath: number[]
Returns Promise<KeyPair>
- Defined in packages/key-management/src/InMemoryKeyAgent.ts:163

exportRootPrivateKey

exportRootPrivateKey(): Promise<Bip32PrivateKeyHex>
Throws
AuthenticationError

Returns Promise<Bip32PrivateKeyHex>
Implementation of KeyAgent.exportRootPrivateKey

Overrides KeyAgentBase.exportRootPrivateKey
- Defined in packages/key-management/src/InMemoryKeyAgent.ts:88

signBlob

signBlob(__namedParameters: AccountKeyDerivationPath, blob: HexBlob): Promise<SignBlobResult>
Throws
AuthenticationError
Parameters
- __namedParameters: AccountKeyDerivationPath
- blob: HexBlob
Returns Promise<SignBlobResult>
Implementation of KeyAgent.signBlob

Overrides KeyAgentBase.signBlob
- Defined in packages/key-management/src/InMemoryKeyAgent.ts:62

signCip8Data

signCip8Data(context: cip8.Cip8SignDataContext): Promise<Cip30DataSignature>
Throws
AuthenticationError
Parameters
- context: cip8.Cip8SignDataContext
Returns Promise<Cip30DataSignature>
Implementation of KeyAgent.signCip8Data

Overrides KeyAgentBase.signCip8Data
- Defined in packages/key-management/src/InMemoryKeyAgent.ts:79

signTransaction

signTransaction(txBody: TransactionBody, __namedParameters: SignTransactionContext, __namedParameters?: SignTransactionOptions): Promise<Signatures>
Throws
AuthenticationError
Parameters
- txBody: TransactionBody
- __namedParameters: SignTransactionContext
- __namedParameters: SignTransactionOptions = {}
Returns Promise<Signatures>
Implementation of KeyAgent.signTransaction

Overrides KeyAgentBase.signTransaction
- Defined in packages/key-management/src/InMemoryKeyAgent.ts:135

`Static` fromBip39MnemonicWords

fromBip39MnemonicWords(__namedParameters: FromBip39MnemonicWordsProps, dependencies: KeyAgentDependencies): Promise<InMemoryKeyAgent>
Throws
AuthenticationError
Parameters
- __namedParameters: FromBip39MnemonicWordsProps
- dependencies: KeyAgentDependencies
Returns Promise<InMemoryKeyAgent>
- Defined in packages/key-management/src/InMemoryKeyAgent.ts:95

Class InMemoryKeyAgent

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: InMemoryKeyAgentProps

dependencies: KeyAgentDependencies

Returns InMemoryKeyAgent

Properties

Private Readonly #account

Private Readonly #bip32Ed25519

Private Readonly #getPassphrase

Private Readonly #serializableData

Accessors

accountIndex

Returns number

bip32Ed25519

Returns Bip32Ed25519

chainId

Returns ChainId

extendedAccountPublicKey

Returns Bip32PublicKeyHex

purpose

Returns KeyPurpose

serializableData

Returns SerializableKeyAgentData

Methods

Private #decryptRootPrivateKey

Parameters

Optional noCache: true

Returns Promise<Bip32PrivateKeyHex>

deriveAddress

Parameters

paymentKeyDerivationPath: AccountAddressDerivationPath

stakeKeyDerivationIndex: number

Returns Promise<GroupedAddress>

derivePublicKey

Throws

Parameters

derivationPath: AccountKeyDerivationPath

Returns Promise<Ed25519PublicKeyHex>

exportExtendedKeyPair

Parameters

derivationPath: number[]

Returns Promise<KeyPair>

exportRootPrivateKey

Throws

Returns Promise<Bip32PrivateKeyHex>

signBlob

Throws

Parameters

__namedParameters: AccountKeyDerivationPath

blob: HexBlob

Returns Promise<SignBlobResult>

signCip8Data

Throws

Parameters

context: cip8.Cip8SignDataContext

Returns Promise<Cip30DataSignature>

signTransaction

Throws

Parameters

txBody: TransactionBody

__namedParameters: SignTransactionContext

__namedParameters: SignTransactionOptions = {}

Returns Promise<Signatures>

Static fromBip39MnemonicWords

Throws

Parameters

__namedParameters: FromBip39MnemonicWordsProps

dependencies: KeyAgentDependencies

Returns Promise<InMemoryKeyAgent>

Settings

Member Visibility

`Private` `Readonly` #account

`Private` `Readonly` #bip32Ed25519

`Private` `Readonly` #getPassphrase

`Private` `Readonly` #serializableData

`Private` #decryptRootPrivateKey

`Optional` noCache: true

`Static` fromBip39MnemonicWords