Skip to main content

WebCryptoSigner

@iota/signers

@iota/signers / webcrypto / WebCryptoSigner

Class: WebCryptoSigner

Defined in: signers/src/webcrypto/index.ts:30

Extends​

  • Signer

Constructors​

Constructor​

new WebCryptoSigner(privateKey, publicKey): WebCryptoSigner

Defined in: signers/src/webcrypto/index.ts:64

Parameters​

privateKey​

CryptoKey

publicKey​

Uint8Array

Returns​

WebCryptoSigner

Overrides​

Signer.constructor

Properties​

privateKey​

privateKey: CryptoKey

Defined in: signers/src/webcrypto/index.ts:31

Methods​

export()​

export(): ExportedWebCryptoKeypair

Defined in: signers/src/webcrypto/index.ts:73

Exports the keypair so that it can be stored in IndexedDB.

Returns​

ExportedWebCryptoKeypair

getKeyScheme()​

getKeyScheme(): SignatureScheme

Defined in: signers/src/webcrypto/index.ts:60

Get the key scheme of the keypair: Secp256k1 or ED25519

Returns​

SignatureScheme

Overrides​

Signer.getKeyScheme

getPublicKey()​

getPublicKey(): Secp256r1PublicKey

Defined in: signers/src/webcrypto/index.ts:91

The public key for this keypair

Returns​

Secp256r1PublicKey

Overrides​

Signer.getPublicKey

sign()​

sign(bytes): Promise<Uint8Array<ArrayBufferLike>>

Defined in: signers/src/webcrypto/index.ts:95

Parameters​

bytes​

Uint8Array

Returns​

Promise<Uint8Array<ArrayBufferLike>>

Overrides​

Signer.sign

signPersonalMessage()​

signPersonalMessage(bytes): Promise<{ bytes: string; signature: string; }>

Defined in: typescript/dist/cjs/cryptography/keypair.d.ts:37

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

signTransaction()​

signTransaction(bytes): Promise<SignatureWithBytes>

Defined in: typescript/dist/cjs/cryptography/keypair.d.ts:33

Signs provided transaction by calling signWithIntent() with a TransactionData provided as intent scope

Parameters​

bytes​

Uint8Array

Returns​

Promise<SignatureWithBytes>

Inherited from​

Signer.signTransaction

signWithIntent()​

signWithIntent(bytes, intent): Promise<SignatureWithBytes>

Defined in: typescript/dist/cjs/cryptography/keypair.d.ts:29

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

toIotaAddress()​

toIotaAddress(): string

Defined in: typescript/dist/cjs/cryptography/keypair.d.ts:41

Returns​

string

Inherited from​

Signer.toIotaAddress

generate()​

static generate(__namedParameters?): Promise<WebCryptoSigner>

Defined in: signers/src/webcrypto/index.ts:35

Parameters​

__namedParameters?​
extractable?​

boolean = false

Returns​

Promise<WebCryptoSigner>

import()​

static import(data): WebCryptoSigner

Defined in: signers/src/webcrypto/index.ts:56

Imports a keypair using the value returned by export().

Parameters​

data​

ExportedWebCryptoKeypair

Returns​

WebCryptoSigner

signingDigest()​

static signingDigest(bytes, intent): Uint8Array

Defined in: typescript/dist/cjs/cryptography/keypair.d.ts:24

Sign messages with a specific intent. By combining the message bytes with the intent before hashing. Returns the digest.

Parameters​

bytes​

Uint8Array

intent​

IntentScope

Returns​

Uint8Array

Inherited from​

Signer.signingDigest