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

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:218

signType

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

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:280

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:289

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:293

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:295

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:299

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:303

decodeWitnessArgsAt

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

decodeWitnessArgs

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

prepareWitnessArgsAt

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

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:410

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:431

getSignaturesCount

getSignaturesCount(txLike: TransactionLike): Promise<undefined | number>
Get the number of signatures in the transaction.
Parameters
- txLike: TransactionLike
  The transaction.
Returns Promise<undefined | number>
The number of signatures.
Overrides SignerMultisig.getSignaturesCount
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:446

needMoreSignatures

needMoreSignatures(txLike: TransactionLike): Promise<boolean>
Check if the transaction needs more signatures
Parameters
- txLike: TransactionLike
  The transaction to check.
Returns Promise<boolean>
A promise that resolves to true if the multisig witness is fulfilled, false otherwise.
Overrides SignerMultisig.needMoreSignatures
- Defined in signer/ckb/signerMultisigCkbReadonly.ts:483

getSignInfo

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

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:532

matchNetworkPreference

matchNetworkPreference(
preferences: NetworkPreference[],
currentNetwork: undefined | string,
): undefined | NetworkPreference
Parameters
- preferences: NetworkPreference[]
- currentNetwork: undefined | string
Returns undefined | NetworkPreference
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?: null | boolean,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<Cell>
Find cells of this signer
Parameters
- filter: ClientIndexerSearchKeyFilterLike
  The filter for the search key.
- OptionalwithData: null | boolean
  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?: null | boolean,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<Cell>
Find cells of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalwithData: null | boolean
- 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?: null | false,
    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: null | false
- 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?: null | boolean,
    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: null | boolean
- 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.
Inherited from SignerMultisig.sendTransaction
- Defined in signer/signer/index.ts:538

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>

connect

Returns Promise<void>

isConnected

Returns Promise<boolean>

getInternalAddress

Returns Promise<string>

getAddressObjs

Returns Promise<Address[]>

decodeWitnessArgsAt

Parameters

Returns undefined | MultisigCkbWitness

decodeWitnessArgs

Parameters

Returns undefined | MultisigCkbWitness

prepareWitnessArgsAt

Parameters

Returns Promise<Transaction>

prepareTransactionOneScript

Parameters

Returns Promise<Transaction>

prepareTransaction

Parameters

Returns Promise<Transaction>

getSignaturesCount

Parameters

Returns Promise<undefined | number>

needMoreSignatures

Parameters

Returns Promise<boolean>

getSignInfo

Parameters

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

aggregateTransactions

Parameters

Returns Promise<Transaction>

matchNetworkPreference

Parameters

Returns undefined | NetworkPreference

StaticverifyMessage

Parameters

Returns Promise<boolean>

onReplaced

Parameters

Returns () => void

disconnect

Returns Promise<void>

getIdentity

Returns Promise<string>

getRecommendedAddressObj

Parameters

Returns Promise<Address>

`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 }[];
},
>