MultiSigPublicKey

@iota/iota-sdk

---

@iota/iota-sdk / multisig / MultiSigPublicKey

Class: MultiSigPublicKey

Defined in: sdk/typescript/src/multisig/publickey.ts:61

A MultiSig public key

Extends

• PublicKey

Constructors

Constructor

new MultiSigPublicKey(value): MultiSigPublicKey

Defined in: sdk/typescript/src/multisig/publickey.ts:71

Create a new MultiSigPublicKey object

Parameters

value

string | Uint8Array<ArrayBufferLike> | MultiSigPublicKeyStruct

MultiSig public key as buffer or base-64 encoded string

Returns

MultiSigPublicKey

Overrides

PublicKey.constructor

Methods

combinePartialSignatures()

combinePartialSignatures(signatures): string

Defined in: sdk/typescript/src/multisig/publickey.ts:248

Combines multiple partial signatures into a single multisig, ensuring that each public key signs only once and that all the public keys involved are known and valid, and then serializes multisig into the standard format

Parameters

signatures

string[]

Returns

string

---

equals()

equals(publicKey): boolean

Defined in: sdk/typescript/src/multisig/publickey.ts:158

Checks if two MultiSig public keys are equal

Parameters

publicKey

MultiSigPublicKey

Returns

boolean

Overrides

PublicKey.equals

---

flag()

flag(): number

Defined in: sdk/typescript/src/multisig/publickey.ts:205

Return the IOTA address associated with this MultiSig public key

Returns

number

Overrides

PublicKey.flag

---

getPublicKeys()

getPublicKeys(): object[]

Defined in: sdk/typescript/src/multisig/publickey.ts:169

Returns

object[]

---

getSigner()

getSigner(...signers): MultiSigSigner

Defined in: sdk/typescript/src/multisig/publickey.ts:177

Parameters

signers

...[Signer]

Returns

MultiSigSigner

---

getThreshold()

getThreshold(): number

Defined in: sdk/typescript/src/multisig/publickey.ts:173

Returns

number

---

toBase64()

toBase64(): string

Defined in: sdk/typescript/src/cryptography/publickey.ts:49

Return the base-64 representation of the public key

Returns

string

Inherited from

PublicKey.toBase64

---

toIotaAddress()

toIotaAddress(): string

Defined in: sdk/typescript/src/multisig/publickey.ts:184

Return the IOTA address associated with this MultiSig public key

Returns

string

Overrides

PublicKey.toIotaAddress

---

toIotaBytes()

toIotaBytes(): Uint8Array

Defined in: sdk/typescript/src/cryptography/publickey.ts:109

Returns the bytes representation of the public key prefixed with the signature scheme flag

Returns

Uint8Array

Inherited from

PublicKey.toIotaBytes

---

toIotaBytesForAddress()

toIotaBytesForAddress(): Uint8Array

Defined in: sdk/typescript/src/cryptography/publickey.ts:123

Returns the bytes representation of the public key prefixed with the signature scheme flag. If the signature scheme is ED25519, no prefix is set.

Returns

Uint8Array

Inherited from

PublicKey.toIotaBytesForAddress

---

toIotaPublicKey()

toIotaPublicKey(): string

Defined in: sdk/typescript/src/cryptography/publickey.ts:64

Return the IOTA representation of the public key encoded in base-64. An IOTA public key is formed by the concatenation of the scheme flag with the raw bytes of the public key

Returns

string

Inherited from

PublicKey.toIotaPublicKey

---

toRawBytes()

toRawBytes(): Uint8Array

Defined in: sdk/typescript/src/multisig/publickey.ts:165

Return the byte array representation of the MultiSig public key

Returns

Uint8Array

Overrides

PublicKey.toRawBytes

---

toString()

toString(): never

Defined in: sdk/typescript/src/cryptography/publickey.ts:53

Returns

never

Inherited from

PublicKey.toString

---

verify()

verify(message, multisigSignature): Promise<boolean>

Defined in: sdk/typescript/src/multisig/publickey.ts:212

Verifies that the signature is valid for the provided message

Parameters

message

Uint8Array

multisigSignature

string

Returns

Promise<boolean>

Overrides

PublicKey.verify

---

verifyAddress()

verifyAddress(address): boolean

Defined in: sdk/typescript/src/cryptography/publickey.ts:101

Verifies that the public key is associated with the provided address

Parameters

address

string

Returns

boolean

Inherited from

PublicKey.verifyAddress

---

verifyPersonalMessage()

verifyPersonalMessage(message, signature): Promise<boolean>

Defined in: sdk/typescript/src/cryptography/publickey.ts:83

Verifies that the signature is valid for the provided PersonalMessage

Parameters

message

Uint8Array

signature

string | Uint8Array<ArrayBufferLike>

Returns

Promise<boolean>

Inherited from

PublicKey.verifyPersonalMessage

---

verifyTransaction()

verifyTransaction(transaction, signature): Promise<boolean>

Defined in: sdk/typescript/src/cryptography/publickey.ts:94

Verifies that the signature is valid for the provided Transaction

Parameters

transaction

Uint8Array

signature

string | Uint8Array<ArrayBufferLike>

Returns

Promise<boolean>

Inherited from

PublicKey.verifyTransaction

---

verifyWithIntent()

verifyWithIntent(bytes, signature, intent): Promise<boolean>

Defined in: sdk/typescript/src/cryptography/publickey.ts:69

Parameters

bytes

Uint8Array

signature

string | Uint8Array<ArrayBufferLike>

intent

IntentScope

Returns

Promise<boolean>

Inherited from

PublicKey.verifyWithIntent

---

fromPublicKeys()

static fromPublicKeys(__namedParameters): MultiSigPublicKey

Defined in: sdk/typescript/src/multisig/publickey.ts:135

A static method to create a new MultiSig publickey instance from a set of public keys and their associated weights pairs and threshold.

Parameters

__namedParameters

publicKeys

object[]

threshold

number

Returns

MultiSigPublicKey