Class MultisigCkbWitness

A class representing multisig information, holding information ingredients and containing utilities.

Hierarchy

Impl<MultisigCkbWitnessLike, MultisigCkbWitness, this>
- MultisigCkbWitness

Index

Constructors

constructor

new MultisigCkbWitness(
    publicKeyHashes: `0x${string}`[],
    threshold: number,
    mustMatch: number,
    signatures: `0x${string}`[],
): MultisigCkbWitness
Parameters
- publicKeyHashes: `0x${string}`[]
  The public key hashes.
- threshold: number
  The threshold.
- mustMatch: number
  The number of signatures that must match.
- signatures: `0x${string}`[]
  The signatures.
Returns MultisigCkbWitness
Overrides Entity.Base< MultisigCkbWitnessLike, MultisigCkbWitness >().constructor
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:134

Properties

`Static` `Optional`byteLength

byteLength?: number

The bytes length of the entity, if it is fixed, otherwise undefined

Static

publicKeyHashes

publicKeyHashes: `0x${string}`[]

The public key hashes.

threshold

threshold: number

The threshold.

mustMatch

mustMatch: number

The number of signatures that must match.

signatures

signatures: `0x${string}`[]

The signatures.

Accessors

flexibleThreshold

get flexibleThreshold(): number
Get the threshold of flexible signatures.

Returns number
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:184

Methods

`Static`encode

encode(_: MultisigCkbWitnessLike): Bytes
Encode the entity into bytes
Parameters
- _: MultisigCkbWitnessLike
  The entity to encode
Returns Bytes
The encoded bytes

Static
Throws
Will throw an error if the entity is not serializable
Inherited from Entity.Base< MultisigCkbWitnessLike, MultisigCkbWitness >().encode
- Defined in codec/entity.ts:32

`Static`decode

decode(_: BytesLike): MultisigCkbWitness
Decode the entity from bytes
Parameters
- _: BytesLike
  The bytes to decode
Returns MultisigCkbWitness
The decoded entity

Static
Throws
Will throw an error if the entity is not serializable
Inherited from Entity.Base< MultisigCkbWitnessLike, MultisigCkbWitness >().decode
- Defined in codec/entity.ts:45

`Static`fromBytes

fromBytes(_bytes: BytesLike): MultisigCkbWitness
Create an entity from bytes
Parameters
- _bytes: BytesLike
Returns MultisigCkbWitness
The created entity

Static
Throws
Will throw an error if the entity is not serializable
Inherited from Entity.Base< MultisigCkbWitnessLike, MultisigCkbWitness >().fromBytes
- Defined in codec/entity.ts:59

toBytes

toBytes(): Bytes
Convert the entity to bytes

Returns Bytes
The bytes representation of the entity
Inherited from Entity.Base< MultisigCkbWitnessLike, MultisigCkbWitness >().toBytes
- Defined in codec/entity.ts:82

clone

clone(): MultisigCkbWitness
Create a clone of the entity

Returns MultisigCkbWitness
A clone of the entity
Inherited from Entity.Base< MultisigCkbWitnessLike, MultisigCkbWitness >().clone
- Defined in codec/entity.ts:93

eq

eq(other: MultisigCkbWitnessLike): boolean
Check if the entity is equal to another entity
Parameters
- other: MultisigCkbWitnessLike
  The other entity to compare with
Returns boolean
True if the entities are equal, false otherwise
Inherited from Entity.Base< MultisigCkbWitnessLike, MultisigCkbWitness >().eq
- Defined in codec/entity.ts:105

hash

hash(): `0x${string}`
Calculate the hash of the entity

Returns `0x${string}`
The hash of the entity
Inherited from Entity.Base< MultisigCkbWitnessLike, MultisigCkbWitness >().hash
- Defined in codec/entity.ts:125

toHex

toHex(): `0x${string}`
Convert the entity to a full-byte untrimmed Hex representation

Returns `0x${string}`
The entity full-byte untrimmed hexadecimal representation
Inherited from Entity.Base< MultisigCkbWitnessLike, MultisigCkbWitness >().toHex
- Defined in codec/entity.ts:134

`Static`from

from(witness: MultisigCkbWitnessLike): MultisigCkbWitness
Create a MultisigCkbWitness from a MultisigCkbWitnessLike.
Parameters
- witness: MultisigCkbWitnessLike
  The witness like object.
Returns MultisigCkbWitness
The MultisigCkbWitness.
Overrides Entity.Base< MultisigCkbWitnessLike, MultisigCkbWitness >().from
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:165

scriptArgs

scriptArgs(since?: null | SinceLike): Bytes
Get the script args of the multisig script.
Parameters
- Optionalsince: null | SinceLike
  The since value.
Returns Bytes
The script args.
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:194

eqInfo

eqInfo(otherLike: MultisigCkbWitnessLike): boolean
Check if the multisig info is equal to another.
Parameters
- otherLike: MultisigCkbWitnessLike
  The other multisig info.
Returns boolean
True if the multisig info is equal, false otherwise.
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:210

generatePublicKeyHashesFromSignatures

generatePublicKeyHashesFromSignatures(
    message: BytesLike,
): Generator<
    {
        pubkeyHash: `0x${string}`;
        signature: `0x${string}`;
        isRequired: boolean;
    },
>
Generate valid public key hashes and their signatures from the witness. This method filters out invalid signatures, duplicate signatures, and signatures not in the multisig script.
Parameters
- message: BytesLike
  The message signed.
Returns Generator<
    {
        pubkeyHash: `0x${string}`;
        signature: `0x${string}`;
        isRequired: boolean;
    },
>
A generator of public key hashes, signatures, and whether the signature is required.
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:227

calcMatchedSignaturesCount

calcMatchedSignaturesCount(
message: BytesLike,
): { required: number; flexible: number }
Calculate the number of matched signatures in the witness.
Parameters
- message: BytesLike
  The message signed.
Returns { required: number; flexible: number }
The number of required and flexible signatures.
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:275

Class MultisigCkbWitness

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MultisigCkbWitness

Properties

Static OptionalbyteLength

Static

publicKeyHashes

threshold

mustMatch

signatures

Accessors

flexibleThreshold

Returns number

Methods

Staticencode

Parameters

Returns Bytes

Static

Throws

Staticdecode

Parameters

Returns MultisigCkbWitness

Static

Throws

StaticfromBytes

Parameters

Returns MultisigCkbWitness

Static

Throws

toBytes

Returns Bytes

clone

Returns MultisigCkbWitness

eq

Parameters

Returns boolean

hash

Returns `0x${string}`

toHex

Returns `0x${string}`

Staticfrom

Parameters

Returns MultisigCkbWitness

scriptArgs

Parameters

Returns Bytes

eqInfo

Parameters

Returns boolean

generatePublicKeyHashesFromSignatures

Parameters

Returns Generator< { pubkeyHash: `0x${string}`; signature: `0x${string}`; isRequired: boolean; },>

calcMatchedSignaturesCount

Parameters

Returns { required: number; flexible: number }

Settings

On This Page

`Static` `Optional`byteLength

`Static`encode

`Static`decode

`Static`fromBytes

`Static`from

Returns Generator<
{
pubkeyHash: `0x${string}`;
signature: `0x${string}`;
isRequired: boolean;
},
>