Class WebCryptoSigner

Hierarchy

Signer
- WebCryptoSigner

Index

Constructors

Properties

Methods

export getKeyScheme getPublicKey sign signAndExecuteTransaction signPersonalMessage signTransaction signWithIntent toSuiAddress generate import

Constructors

constructor

new WebCryptoSigner(
privateKey: CryptoKey,
publicKey: Uint8Array,
): WebCryptoSigner
Parameters
- privateKey: CryptoKey
- publicKey: Uint8Array
Returns WebCryptoSigner
Overrides Signer.constructor
- Defined in signers/src/webcrypto/index.ts:63

Properties

privateKey

privateKey: CryptoKey

Methods

export

export(): ExportedWebCryptoKeypair
Exports the keypair so that it can be stored in IndexedDB.

Returns ExportedWebCryptoKeypair
- Defined in signers/src/webcrypto/index.ts:72

getKeyScheme

getKeyScheme(): SignatureScheme
Get the key scheme of the keypair: Secp256k1 or ED25519

Returns SignatureScheme
Overrides Signer.getKeyScheme
- Defined in signers/src/webcrypto/index.ts:59

getPublicKey

getPublicKey(): Secp256r1PublicKey
The public key for this keypair

Returns Secp256r1PublicKey
Overrides Signer.getPublicKey
- Defined in signers/src/webcrypto/index.ts:90

sign

sign(bytes: Uint8Array): Promise<Uint8Array<ArrayBuffer>>
Parameters
- bytes: Uint8Array
Returns Promise<Uint8Array<ArrayBuffer>>
Overrides Signer.sign
- Defined in signers/src/webcrypto/index.ts:94

signAndExecuteTransaction

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

signPersonalMessage

signPersonalMessage(
bytes: Uint8Array,
): Promise<{ bytes: string; signature: string }>
Signs provided personal message by calling signWithIntent() with a PersonalMessage provided as intent scope
Parameters
- bytes: Uint8Array
Returns Promise<{ bytes: string; signature: string }>
Inherited from Signer.signPersonalMessage
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:40

signTransaction

signTransaction(bytes: Uint8Array): Promise<SignatureWithBytes>
Signs provided transaction by calling signWithIntent() with a TransactionData provided as intent scope
Parameters
- bytes: Uint8Array
Returns Promise<SignatureWithBytes>
Inherited from Signer.signTransaction
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:36

signWithIntent

signWithIntent(
bytes: Uint8Array,
intent: IntentScope,
): Promise<SignatureWithBytes>
Sign messages with a specific intent. By combining the message bytes with the intent before hashing and signing, it ensures that a signed message is tied to a specific purpose and domain separator is provided
Parameters
- bytes: Uint8Array
- intent: IntentScope
Returns Promise<SignatureWithBytes>
Inherited from Signer.signWithIntent
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:32

toSuiAddress

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

`Static`generate

generate(
__namedParameters?: { extractable?: boolean },
): Promise<WebCryptoSigner>
Parameters
- __namedParameters: { extractable?: boolean } = {}
Returns Promise<WebCryptoSigner>
- Defined in signers/src/webcrypto/index.ts:34

`Static`import

import(data: ExportedWebCryptoKeypair): WebCryptoSigner
Imports a keypair using the value returned by export().
Parameters
- data: ExportedWebCryptoKeypair
Returns WebCryptoSigner
- Defined in signers/src/webcrypto/index.ts:55

Class WebCryptoSigner

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebCryptoSigner

Properties

privateKey

Methods

export

Returns ExportedWebCryptoKeypair

getKeyScheme

Returns SignatureScheme

getPublicKey

Returns Secp256r1PublicKey

sign

Parameters

Returns Promise<Uint8Array<ArrayBuffer>>

signAndExecuteTransaction

Parameters

Returns Promise<TransactionResponse>

signPersonalMessage

Parameters

Returns Promise<{ bytes: string; signature: string }>

signTransaction

Parameters

Returns Promise<SignatureWithBytes>

signWithIntent

Parameters

Returns Promise<SignatureWithBytes>

toSuiAddress

Returns string

Staticgenerate

Parameters

Returns Promise<WebCryptoSigner>

Staticimport

Parameters

Returns WebCryptoSigner

Settings

On This Page

`Static`generate

`Static`import