Class LedgerSigner

Ledger integrates with the Sui blockchain to provide signing capabilities using Ledger devices.

Hierarchy

Signer
- LedgerSigner

Index

Constructors

Methods

getKeyScheme getPublicKey sign signAndExecuteTransaction signPersonalMessage signTransaction signWithIntent toSuiAddress fromDerivationPath

Constructors

constructor

new LedgerSigner(__namedParameters: LedgerSignerOptions): LedgerSigner
Creates an instance of LedgerSigner. It's expected to call the static fromDerivationPath method to create an instance.
Parameters
- __namedParameters: LedgerSignerOptions
Returns LedgerSigner
Example
```
const signer = await LedgerSigner.fromDerivationPath(derivationPath, options);
```
Overrides Signer.constructor
- Defined in signers/src/ledger/index.ts:44

Methods

getKeyScheme

getKeyScheme(): "ED25519"
Retrieves the key scheme used by this signer.

Returns "ED25519"
Overrides Signer.getKeyScheme
- Defined in signers/src/ledger/index.ts:55

getPublicKey

getPublicKey(): Ed25519PublicKey
Retrieves the public key associated with this signer.

Returns Ed25519PublicKey
The Ed25519PublicKey instance.
Overrides Signer.getPublicKey
- Defined in signers/src/ledger/index.ts:63

sign

sign(): never
Generic signing is not supported by Ledger.

Returns never
Throws
Always throws an error indicating generic signing is unsupported.
Overrides Signer.sign
- Defined in signers/src/ledger/index.ts:148

signAndExecuteTransaction

signAndExecuteTransaction(
__namedParameters: SignAndExecuteOptions,
): Promise<Omit<TransactionResponse, "balanceChanges">>
Parameters
- __namedParameters: SignAndExecuteOptions
Returns Promise<Omit<TransactionResponse, "balanceChanges">>
Inherited from Signer.signAndExecuteTransaction
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:44

signPersonalMessage

signPersonalMessage(bytes: Uint8Array): Promise<SignatureWithBytes>
Signs the provided personal message.
Parameters
- bytes: Uint8Array
Returns Promise<SignatureWithBytes>
The signed message bytes and signature.
Overrides Signer.signPersonalMessage
- Defined in signers/src/ledger/index.ts:101

signTransaction

signTransaction(bytes: Uint8Array): Promise<SignatureWithBytes>
Signs the provided transaction bytes.
Parameters
- bytes: Uint8Array
Returns Promise<SignatureWithBytes>
The signed transaction bytes and signature.
Overrides Signer.signTransaction
- Defined in signers/src/ledger/index.ts:71

signWithIntent

signWithIntent(): never
Generic signing is not supported by Ledger.

Returns never
Throws
Always throws an error indicating generic signing is unsupported.
Overrides Signer.signWithIntent
- Defined in signers/src/ledger/index.ts:156

toSuiAddress

toSuiAddress(): string
Returns string
Inherited from Signer.toSuiAddress
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:45

`Static`fromDerivationPath

fromDerivationPath(
    derivationPath: string,
    ledgerClient: Sui,
    suiClient: SuiJsonRpcClient,
): Promise<LedgerSigner>
Prepares the signer by fetching and setting the public key from a Ledger device. It is recommended to initialize an LedgerSigner instance using this function.
Parameters
- derivationPath: string
- ledgerClient: Sui
- suiClient: SuiJsonRpcClient
Returns Promise<LedgerSigner>
A promise that resolves once a LedgerSigner instance is prepared (public key is set).
- Defined in signers/src/ledger/index.ts:126