Class SignerMultisigCkbReadonly

A class extending Signer that provides access to a CKB multisig script. This class does not support signing operations.

Hierarchy (View Summary)

SignerMultisig
- SignerMultisigCkbReadonly
  - SignerMultisigCkbPrivateKey

Constructors

constructor

new SignerMultisigCkbReadonly(
    client: Client,
    multisigInfoLike: MultisigCkbWitnessLike,
    options?:
        | {
            since?: SinceLike
            | null;
            scriptInfos?: (ScriptInfoLike | KnownScript)[] | null;
        }
        | null,
): SignerMultisigCkbReadonly
Creates an instance of SignerMultisigCkbReadonly.
Parameters
- client: Client
  The client instance.
- multisigInfoLike: MultisigCkbWitnessLike
  The multisig information.
- Optionaloptions:
      | {
          since?: SinceLike
          | null;
          scriptInfos?: (ScriptInfoLike | KnownScript)[] | null;
      }
      | null
  The options.
Returns SignerMultisigCkbReadonly
Overrides SignerMultisig.constructor
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:331

Properties

`Static`EmptySignature

EmptySignature: `0x${string}` = ...

`Readonly`multisigInfo

multisigInfo: MultisigCkbWitness

`Optional` `Readonly`since

since?: Since

`Readonly`scriptInfos

scriptInfos: Promise<{ script: Script; cellDeps: CellDepInfo[] }[]>

`Protected`client_

client_: Client

Accessors

type

get type(): SignerType
Returns SignerType
Overrides SignerMultisig.type
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:306

signType

get signType(): SignerSignType
Returns SignerSignType
Overrides SignerMultisig.signType
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:310

client

get client(): Client
Returns Client
Inherited from SignerMultisig.client
- Defined in signer/signer/index.ts:87

Methods

getMemberCount

getMemberCount(): Promise<number>
Get the number of members in the multisig script.

Returns Promise<number>
The number of members.
Overrides SignerMultisig.getMemberCount
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:378

getMemberThreshold

getMemberThreshold(): Promise<number>
Get the threshold of the multisig script.

Returns Promise<number>
The threshold.
Overrides SignerMultisig.getMemberThreshold
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:387

getMemberRequiredCount

getMemberRequiredCount(): Promise<number>
Get the count of required member of the multisig script.

Returns Promise<number>
The must match count.
Overrides SignerMultisig.getMemberRequiredCount
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:396

connect

connect(): Promise<void>
Connects to the signer.

Returns Promise<void>
A promise that resolves when the connection is complete.
Overrides SignerMultisig.connect
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:400

isConnected

isConnected(): Promise<boolean>
Check if the signer is connected.

Returns Promise<boolean>
A promise that resolves the connection status.
Overrides SignerMultisig.isConnected
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:402

getInternalAddress

getInternalAddress(): Promise<string>
Gets the internal address associated with the signer.

Returns Promise<string>
A promise that resolves to a string representing the internal address.
Overrides SignerMultisig.getInternalAddress
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:406

getAddressObjs

getAddressObjs(): Promise<Address[]>
Gets an array of Address objects associated with the signer.

Returns Promise<Address[]>
A promise that resolves to an array of Address objects.
Overrides SignerMultisig.getAddressObjs
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:410

decodeWitnessArgsAt

decodeWitnessArgsAt(
txLike: TransactionLike,
index: number,
): MultisigCkbWitness | undefined
Decode the witness args at a specific index.
Parameters
- txLike: TransactionLike
  The transaction.
- index: number
  The index of the witness args.
Returns MultisigCkbWitness | undefined
The decoded MultisigCkbWitness.
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:423

decodeWitnessArgs

decodeWitnessArgs(
witnessLike?: WitnessArgsLike | null,
): MultisigCkbWitness | undefined
Decode the witness args.
Parameters
- OptionalwitnessLike: WitnessArgsLike | null
  The witness args like object.
Returns MultisigCkbWitness | undefined
The decoded MultisigCkbWitness.
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:438

prepareWitnessArgsAt

prepareWitnessArgsAt(
    txLike: TransactionLike,
    index: number,
    transformer?:
        | (
            (
                witness: MultisigCkbWitness,
                witnessArgs: WitnessArgs,
            ) =>
                | void
                | MultisigCkbWitnessLike
                | Promise<(void | MultisigCkbWitnessLike | null | undefined)>
                | null
                | undefined
        )
        | null,
): Promise<Transaction>
Prepare the witness args at a specific index.
Parameters
- txLike: TransactionLike
  The transaction.
- index: number
  The index of the witness args.
- Optionaltransformer:
      | (
          (
              witness: MultisigCkbWitness,
              witnessArgs: WitnessArgs,
          ) =>
              | void
              | MultisigCkbWitnessLike
              | Promise<(void | MultisigCkbWitnessLike | null | undefined)>
              | null
              | undefined
      )
      | null
  The transformer function.
Returns Promise<Transaction>
The prepared transaction.
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:468

prepareTransactionOneScript

prepareTransactionOneScript(
    txLike: TransactionLike,
    script: ScriptLike,
    cellDeps: CellDepInfoLike[],
): Promise<Transaction>
Prepare multisig witness, if the existence of multisig witness is detected, nothing happens
Parameters
- txLike: TransactionLike
  The transaction to prepare.
- script: ScriptLike
- cellDeps: CellDepInfoLike[]
Returns Promise<Transaction>
A promise that resolves to the prepared transaction
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:517

prepareTransaction

prepareTransaction(txLike: TransactionLike): Promise<Transaction>
Prepare transaction for multisig witness and adding related cell deps
Parameters
- txLike: TransactionLike
  The transaction to prepare.
Returns Promise<Transaction>
A promise that resolves to the prepared transaction
Overrides SignerMultisig.prepareTransaction
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:538

getSignaturesCount

getSignaturesCount(txLike: TransactionLike): Promise<number | undefined>
Get the number of valid signatures for matching multisig inputs in the transaction.
Parameters
- txLike: TransactionLike
  The transaction.
Returns Promise<number | undefined>
The matched multisig signature count, or undefined when the transaction is unrelated to any multisig address supported by this signer.

Remarks
Returns undefined when the transaction has no inputs locked by any multisig address supported by this signer. This method only counts signatures for matching multisig inputs and does not imply that the transaction should be signed by this multisig.
Overrides SignerMultisig.getSignaturesCount
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:558

needMoreSignatures

needMoreSignatures(txLike: TransactionLike): Promise<boolean>
Check if related multisig inputs in the transaction need more signatures.
Parameters
- txLike: TransactionLike
  The transaction to check.
Returns Promise<boolean>
A promise that resolves to true when related multisig inputs still need signatures, and false otherwise.

Remarks
Returns false when the transaction has no inputs locked by any multisig address supported by this signer. A false result therefore means either the related multisig inputs are already fulfilled, or the transaction is unrelated to all multisig addresses supported by this signer.
Overrides SignerMultisig.needMoreSignatures
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:601

getSignInfo

getSignInfo(
txLike: TransactionLike,
script: ScriptLike,
): Promise<{ message: `0x${string}`; position: number } | undefined>
Get the sign info for a script.
Parameters
- txLike: TransactionLike
  The transaction.
- script: ScriptLike
  The script.
Returns Promise<{ message: `0x${string}`; position: number } | undefined>
The sign info.
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:616

aggregateTransactions

aggregateTransactions(txs: TransactionLike[]): Promise<Transaction>
Aggregate transactions.
Parameters
- txs: TransactionLike[]
  The transactions to aggregate.
Returns Promise<Transaction>
The aggregated transaction.
Overrides SignerMultisig.aggregateTransactions
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:650

matchNetworkPreference

matchNetworkPreference(
preferences: NetworkPreference[],
currentNetwork: string | undefined,
): NetworkPreference | undefined
Parameters
- preferences: NetworkPreference[]
- currentNetwork: string | undefined
Returns NetworkPreference | undefined
Inherited from SignerMultisig.matchNetworkPreference
- Defined in signer/signer/index.ts:93

`Static`verifyMessage

verifyMessage(message: BytesLike, signature: Signature): Promise<boolean>
Parameters
- message: BytesLike
- signature: Signature
Returns Promise<boolean>
Inherited from SignerMultisig.verifyMessage
- Defined in signer/signer/index.ts:114

onReplaced

onReplaced(_: () => void): () => void
Register a listener to be called when this signer is replaced.
Parameters
- _: () => void
Returns () => void
A function for unregister
Inherited from SignerMultisig.onReplaced
- Defined in signer/signer/index.ts:172

disconnect

disconnect(): Promise<void>
Disconnects to the signer.

Returns Promise<void>
A promise that resolves when the signer is disconnected.
Inherited from SignerMultisig.disconnect
- Defined in signer/signer/index.ts:181

getIdentity

getIdentity(): Promise<string>
Gets the identity for verifying signature, usually it's address

Returns Promise<string>
A promise that resolves to a string representing the identity
Inherited from SignerMultisig.getIdentity
- Defined in signer/signer/index.ts:202

getRecommendedAddressObj

getRecommendedAddressObj(_preference?: unknown): Promise<Address>
Gets the recommended Address object for the signer.
Parameters
- Optional_preference: unknown
  Optional preference parameter.
Returns Promise<Address>
A promise that resolves to the recommended Address object.
Inherited from SignerMultisig.getRecommendedAddressObj
- Defined in signer/signer/index.ts:219

getRecommendedAddress

getRecommendedAddress(preference?: unknown): Promise<string>
Gets the recommended address for the signer as a string.
Parameters
- Optionalpreference: unknown
  Optional preference parameter.
Returns Promise<string>
A promise that resolves to the recommended address as a string.
Inherited from SignerMultisig.getRecommendedAddress
- Defined in signer/signer/index.ts:229

getAddresses

getAddresses(): Promise<string[]>
Gets an array of addresses associated with the signer as strings.

Returns Promise<string[]>
A promise that resolves to an array of addresses as strings.
Inherited from SignerMultisig.getAddresses
- Defined in signer/signer/index.ts:238

findCellsOnChain

findCellsOnChain(
    filter: ClientIndexerSearchKeyFilterLike,
    withData?: boolean | null,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<Cell>
Find cells of this signer
Parameters
- filter: ClientIndexerSearchKeyFilterLike
  The filter for the search key.
- OptionalwithData: boolean | null
  Whether to include cell data in the response.
- Optionalorder: "asc" | "desc"
  The order of the returned cells, can be "asc" or "desc".
- Optionallimit: number
  The maximum number of cells for every querying chunk.
Returns AsyncGenerator<Cell>
A async generator that yields all matching cells
Inherited from SignerMultisig.findCellsOnChain
- Defined in signer/signer/index.ts:253

findCells

findCells(
    filter: ClientCollectableSearchKeyFilterLike,
    withData?: boolean | null,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<Cell>
Find cells of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalwithData: boolean | null
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<Cell>
A async generator that yields all matches cells
Inherited from SignerMultisig.findCells
- Defined in signer/signer/index.ts:282

findTransactions

findTransactions(
    filter: ClientCollectableSearchKeyFilterLike,
    groupByTransaction?: false | null,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    },
>
Find transactions of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalgroupByTransaction: false | null
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    },
>
A async generator that yields all matches transactions
Inherited from SignerMultisig.findTransactions
- Defined in signer/signer/index.ts:311
findTransactions(
    filter: ClientCollectableSearchKeyFilterLike,
    groupByTransaction: true,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
Find transactions of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- groupByTransaction: true
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
A async generator that yields all matches transactions
Inherited from SignerMultisig.findTransactions
- Defined in signer/signer/index.ts:322
findTransactions(
    filter: ClientCollectableSearchKeyFilterLike,
    groupByTransaction?: boolean | null,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    }
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
Find transactions of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalgroupByTransaction: boolean | null
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    }
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
A async generator that yields all matches transactions
Inherited from SignerMultisig.findTransactions
- Defined in signer/signer/index.ts:333

getBalance

getBalance(): Promise<bigint>
Gets balance of all addresses

Returns Promise<bigint>
A promise that resolves to the balance
Inherited from SignerMultisig.getBalance
- Defined in signer/signer/index.ts:379

signMessage

signMessage(message: BytesLike): Promise<Signature>
Signs a message.
Parameters
- message: BytesLike
  The message to sign, as a string or BytesLike object.
Returns Promise<Signature>
A promise that resolves to the signature info.

Throws
Will throw an error if not implemented.
Inherited from SignerMultisig.signMessage
- Defined in signer/signer/index.ts:392

signMessageRaw

signMessageRaw(_: BytesLike): Promise<string>
Signs a message and returns signature only. This method is not implemented and should be overridden by subclasses.
Parameters
- _: BytesLike
  The message to sign, as a string or BytesLike object.
Returns Promise<string>
A promise that resolves to the signature as a string.

Throws
Will throw an error if not implemented.
Inherited from SignerMultisig.signMessageRaw
- Defined in signer/signer/index.ts:407

verifyMessage

verifyMessage(
message: BytesLike,
signature: string | Signature,
): Promise<boolean>
Verify a signature.
Parameters
- message: BytesLike
  The original message.
- signature: string | Signature
  The signature to verify.
Returns Promise<boolean>
A promise that resolves to the verification result.

Throws
Will throw an error if not implemented.
Inherited from SignerMultisig.verifyMessage
- Defined in signer/signer/index.ts:419

signTransaction

signTransaction(tx: TransactionLike): Promise<Transaction>
Signs a transaction.
Parameters
- tx: TransactionLike
  The transaction to sign, represented as a TransactionLike object.
Returns Promise<Transaction>
A promise that resolves to the signed Transaction object.
Inherited from SignerMultisig.signTransaction
- Defined in signer/signer/index.ts:457

signOnlyTransaction

signOnlyTransaction(_: TransactionLike): Promise<Transaction>
Signs a transaction without preparing information for it. This method is not implemented and should be overridden by subclasses.
Parameters
- _: TransactionLike
  The transaction to sign, represented as a TransactionLike object.
Returns Promise<Transaction>
A promise that resolves to the signed Transaction object.

Throws
Will throw an error if not implemented.
Inherited from SignerMultisig.signOnlyTransaction
- Defined in signer/signer/index.ts:489

sendTransaction

sendTransaction(tx: TransactionLike): Promise<`0x${string}`>
Send a transaction.
Parameters
- tx: TransactionLike
  The transaction to send.
Returns Promise<`0x${string}`>
The transaction hash.

Remarks
This method rejects the transaction only when related multisig inputs still need signatures. It does not verify that the transaction actually contains inputs locked by any multisig address supported by this signer, so transactions unrelated to those multisig addresses are not rejected by this check.
Inherited from SignerMultisig.sendTransaction
- Defined in signer/signer/index.ts:563

Class SignerMultisigCkbReadonly

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SignerMultisigCkbReadonly

Properties

StaticEmptySignature

ReadonlymultisigInfo

Optional Readonlysince

ReadonlyscriptInfos

Protectedclient_

Accessors

type

Returns SignerType

signType

Returns SignerSignType

client

Returns Client

Methods

getMemberCount

Returns Promise<number>

getMemberThreshold

Returns Promise<number>

getMemberRequiredCount

Returns Promise<number>

connect

Returns Promise<void>

isConnected

Returns Promise<boolean>

getInternalAddress

Returns Promise<string>

getAddressObjs

Returns Promise<Address[]>

decodeWitnessArgsAt

Parameters

Returns MultisigCkbWitness | undefined

decodeWitnessArgs

Parameters

Returns MultisigCkbWitness | undefined

prepareWitnessArgsAt

Parameters

Returns Promise<Transaction>

prepareTransactionOneScript

Parameters

Returns Promise<Transaction>

prepareTransaction

Parameters

Returns Promise<Transaction>

getSignaturesCount

Parameters

Returns Promise<number | undefined>

Remarks

needMoreSignatures

Parameters

Returns Promise<boolean>

Remarks

getSignInfo

Parameters

Returns Promise<{ message: `0x${string}`; position: number } | undefined>

aggregateTransactions

Parameters

Returns Promise<Transaction>

matchNetworkPreference

Parameters

Returns NetworkPreference | undefined

StaticverifyMessage

Parameters

Returns Promise<boolean>

onReplaced

Parameters

Returns () => void

disconnect

Returns Promise<void>

getIdentity

`Static`EmptySignature

`Readonly`multisigInfo

`Optional` `Readonly`since

`Readonly`scriptInfos

`Protected`client_

`Static`verifyMessage

Returns AsyncGenerator<
{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
},
>

Returns AsyncGenerator<
{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: { isInput: boolean; cellIndex: bigint }[];
},
>

Returns AsyncGenerator<
| {
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
}
| {
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: { isInput: boolean; cellIndex: bigint }[];
},
>