Interface Identity

interface Identity {
    compressedPublicKey(): Promise<Uint8Array<ArrayBufferLike>>;
    sign(tx: Transaction, inputIndexes?: number[]): Promise<Transaction>;
    signerSession(): SignerSession;
    signMessage(
        message: Uint8Array,
        signatureType: "schnorr" | "ecdsa",
    ): Promise<Uint8Array<ArrayBufferLike>>;
    xOnlyPublicKey(): Promise<Uint8Array<ArrayBufferLike>>;
}

Hierarchy (View Summary)

ReadonlyIdentity
- Identity
  - BatchSignableIdentity

Implemented by

Index

Methods

compressedPublicKey sign signerSession signMessage xOnlyPublicKey

Methods

compressedPublicKey

compressedPublicKey(): Promise<Uint8Array<ArrayBufferLike>>
Returns the compressed public key for this identity.

Returns Promise<Uint8Array<ArrayBufferLike>>
Inherited from ReadonlyIdentity.compressedPublicKey
- Defined in identity/index.ts:28

sign

sign(tx: Transaction, inputIndexes?: number[]): Promise<Transaction>
Sign the provided transaction inputs.
Parameters
- tx: Transaction
  Transaction to sign
- OptionalinputIndexes: number[]
  Optional input indexes to sign. When omitted, the implementation should sign every signable input.
Returns Promise<Transaction>
- Defined in identity/index.ts:20

signerSession

signerSession(): SignerSession
Returns a signer session used for musig2 tree signing flows.

Returns SignerSession
- Defined in identity/index.ts:6

signMessage

signMessage(
message: Uint8Array,
signatureType: "schnorr" | "ecdsa",
): Promise<Uint8Array<ArrayBufferLike>>
Sign an arbitrary message using the requested signature type.
Parameters
- message: Uint8Array
- signatureType: "schnorr" | "ecdsa"
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in identity/index.ts:9

xOnlyPublicKey

xOnlyPublicKey(): Promise<Uint8Array<ArrayBufferLike>>
Returns the x-only public key used by Taproot scripts.

Returns Promise<Uint8Array<ArrayBufferLike>>
Inherited from ReadonlyIdentity.xOnlyPublicKey
- Defined in identity/index.ts:25

Interface Identity

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

compressedPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

sign

Parameters

Returns Promise<Transaction>

signerSession

Returns SignerSession

signMessage

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

xOnlyPublicKey

Returns Promise<Uint8Array<ArrayBufferLike>>

Settings

On This Page