Class LedgerKeyAgent

Hierarchy

KeyAgentBase
- LedgerKeyAgent

Constructors

constructor

new LedgerKeyAgent(__namedParameters: LedgerKeyAgentProps, dependencies: KeyAgentDependencies): LedgerKeyAgent
Parameters
- __namedParameters: LedgerKeyAgentProps
- dependencies: KeyAgentDependencies
Returns LedgerKeyAgent
Overrides KeyAgentBase.constructor
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:44

Properties

`Private` #private

#private: any

`Private` #private

#private: any

`Optional` `Readonly` deviceConnection

deviceConnection?: Ada

`Static` `Private` attachDisconnectionCleanupHandler

attachDisconnectionCleanupHandler: any

`Static` deviceConnections

deviceConnections: DeviceConnectionsWithTheirInitialParams[]

`Static` `Private` findConnectionByCommunicationTypeAndDevicePath

findConnectionByCommunicationTypeAndDevicePath: any

`Static` `Private` getHidDeviceList

getHidDeviceList: any

`Static` `Private` openTransportForDevice

openTransportForDevice: any

`Static` `Private` rememberConnection

rememberConnection: any

`Static` `Private` testConnection

testConnection: any

Accessors

accountIndex

get accountIndex(): number
Returns number
Inherited from KeyAgentBase.accountIndex
- Defined in packages/key-management/dist/cjs/KeyAgentBase.d.ts:10

bip32Ed25519

get bip32Ed25519(): Bip32Ed25519
Returns Bip32Ed25519
Inherited from KeyAgentBase.bip32Ed25519
- Defined in packages/key-management/dist/cjs/KeyAgentBase.d.ts:11

chainId

get chainId(): ChainId
Returns ChainId
Inherited from KeyAgentBase.chainId
- Defined in packages/key-management/dist/cjs/KeyAgentBase.d.ts:9

extendedAccountPublicKey

get extendedAccountPublicKey(): Bip32PublicKeyHex
Returns Bip32PublicKeyHex
Inherited from KeyAgentBase.extendedAccountPublicKey
- Defined in packages/key-management/dist/cjs/KeyAgentBase.d.ts:8

serializableData

get serializableData(): SerializableKeyAgentData
Returns SerializableKeyAgentData
Inherited from KeyAgentBase.serializableData
- Defined in packages/key-management/dist/cjs/KeyAgentBase.d.ts:7

Methods

deriveAddress

deriveAddress(paymentKeyDerivationPath: AccountAddressDerivationPath, stakeKeyDerivationIndex: number): Promise<GroupedAddress>
Parameters
- paymentKeyDerivationPath: AccountAddressDerivationPath
- stakeKeyDerivationIndex: number
Returns Promise<GroupedAddress>
Inherited from KeyAgentBase.deriveAddress
- Defined in packages/key-management/dist/cjs/KeyAgentBase.d.ts:16

derivePublicKey

derivePublicKey(derivationPath: AccountKeyDerivationPath): Promise<Ed25519PublicKeyHex>
Parameters
- derivationPath: AccountKeyDerivationPath
Returns Promise<Ed25519PublicKeyHex>
Inherited from KeyAgentBase.derivePublicKey
- Defined in packages/key-management/dist/cjs/KeyAgentBase.d.ts:17

exportRootPrivateKey

exportRootPrivateKey(): Promise<Bip32PrivateKeyHex>
Returns Promise<Bip32PrivateKeyHex>
Overrides KeyAgentBase.exportRootPrivateKey
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:64

signBlob

signBlob(): Promise<SignBlobResult>
Returns Promise<SignBlobResult>
Overrides KeyAgentBase.signBlob
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:63

signTransaction

signTransaction(__namedParameters: TxBodyWithHash, __namedParameters: SignTransactionContext): Promise<Signatures>
Parameters
- __namedParameters: TxBodyWithHash
- __namedParameters: SignTransactionContext
Returns Promise<Signatures>
Overrides KeyAgentBase.signTransaction
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:62

`Static` checkDeviceConnection

checkDeviceConnection(communicationType: CommunicationType, deviceConnection?: Ada): Promise<Ada>
Parameters
- communicationType: CommunicationType
- Optional deviceConnection: Ada
Returns Promise<Ada>
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:57

`Static` createDeviceConnection

createDeviceConnection(activeTransport: default): Promise<Ada>
Parameters
- activeTransport: default
Returns Promise<Ada>
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:51

`Static` createTransport

createTransport(__namedParameters: CreateLedgerTransportProps): Promise<LedgerTransportType>
Parameters
- __namedParameters: CreateLedgerTransportProps
Returns Promise<LedgerTransportType>
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:49

`Static` createWithDevice

createWithDevice(__namedParameters: CreateLedgerKeyAgentProps, dependencies: KeyAgentDependencies): Promise<LedgerKeyAgent>
Parameters
- __namedParameters: CreateLedgerKeyAgentProps
- dependencies: KeyAgentDependencies
Returns Promise<LedgerKeyAgent>
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:60

`Static` establishDeviceConnection

establishDeviceConnection(communicationType: CommunicationType): Promise<Ada>
Parameters
- communicationType: CommunicationType
Returns Promise<Ada>
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:53
establishDeviceConnection(communicationType: CommunicationType, nodeHidDevicePath: string): Promise<Ada>
Parameters
- communicationType: CommunicationType
- nodeHidDevicePath: string
Returns Promise<Ada>
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:54
establishDeviceConnection(communicationType: Node, device: HID): Promise<Ada>
Parameters
- communicationType: Node
- device: HID
Returns Promise<Ada>
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:55
establishDeviceConnection(communicationType: Web, device: USBDevice): Promise<Ada>
Parameters
- communicationType: Web
- device: USBDevice
Returns Promise<Ada>
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:56

`Static` getAppVersion

getAppVersion(communicationType: CommunicationType, deviceConnection?: Ada): Promise<GetVersionResponse>
Parameters
- communicationType: CommunicationType
- Optional deviceConnection: Ada
Returns Promise<GetVersionResponse>
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:59

`Static` getSigningMode

getSigningMode(tx: Transaction): TransactionSigningMode
Parameters
- tx: Transaction
Returns TransactionSigningMode
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:61

`Static` getXpub

getXpub(__namedParameters: GetLedgerXpubProps): Promise<Bip32PublicKeyHex>
Parameters
- __namedParameters: GetLedgerXpubProps
Returns Promise<Bip32PublicKeyHex>
- Defined in packages/hardware-ledger/dist/cjs/LedgerKeyAgent.d.ts:58

Class LedgerKeyAgent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: LedgerKeyAgentProps

dependencies: KeyAgentDependencies

Returns LedgerKeyAgent

Properties

Private #private

Private #private

Optional Readonly deviceConnection

Static Private attachDisconnectionCleanupHandler

Static deviceConnections

Static Private findConnectionByCommunicationTypeAndDevicePath

Static Private getHidDeviceList

Static Private openTransportForDevice

Static Private rememberConnection

Static Private testConnection

Accessors

accountIndex

Returns number

bip32Ed25519

Returns Bip32Ed25519

chainId

Returns ChainId

extendedAccountPublicKey

Returns Bip32PublicKeyHex

serializableData

Returns SerializableKeyAgentData

Methods

deriveAddress

Parameters

paymentKeyDerivationPath: AccountAddressDerivationPath

stakeKeyDerivationIndex: number

Returns Promise<GroupedAddress>

derivePublicKey

Parameters

derivationPath: AccountKeyDerivationPath

Returns Promise<Ed25519PublicKeyHex>

exportRootPrivateKey

Returns Promise<Bip32PrivateKeyHex>

signBlob

Returns Promise<SignBlobResult>

signTransaction

Parameters

__namedParameters: TxBodyWithHash

__namedParameters: SignTransactionContext

Returns Promise<Signatures>

Static checkDeviceConnection

Parameters

communicationType: CommunicationType

Optional deviceConnection: Ada

Returns Promise<Ada>

Static createDeviceConnection

Parameters

activeTransport: default

Returns Promise<Ada>

Static createTransport

Parameters

__namedParameters: CreateLedgerTransportProps

Returns Promise<LedgerTransportType>

Static createWithDevice

Parameters

__namedParameters: CreateLedgerKeyAgentProps

dependencies: KeyAgentDependencies

Returns Promise<LedgerKeyAgent>

Static establishDeviceConnection

Parameters

communicationType: CommunicationType

Returns Promise<Ada>

Parameters

communicationType: CommunicationType

nodeHidDevicePath: string

Returns Promise<Ada>

`Private` #private

`Private` #private

`Optional` `Readonly` deviceConnection

`Static` `Private` attachDisconnectionCleanupHandler

`Static` deviceConnections

`Static` `Private` findConnectionByCommunicationTypeAndDevicePath

`Static` `Private` getHidDeviceList

`Static` `Private` openTransportForDevice

`Static` `Private` rememberConnection

`Static` `Private` testConnection

`Static` checkDeviceConnection

`Optional` deviceConnection: Ada

`Static` createDeviceConnection

`Static` createTransport

`Static` createWithDevice

`Static` establishDeviceConnection

`Static` getAppVersion

`Optional` deviceConnection: Ada

`Static` getSigningMode

`Static` getXpub