Class SignerMultisigOmniLockPrivateKey

A signing-capable signer for Omnilock cells using CKB multisig auth (0x06).

Extends SignerMultisigOmniLockReadonly with the ability to sign transactions using a single private key. For M-of-N multisig, each guard creates an instance with their own private key. Partial signatures are aggregated via aggregateTransactions().

Hierarchy (View Summary)

SignerMultisigOmniLockReadonly
- SignerMultisigOmniLockPrivateKey

Constructors

constructor

new SignerMultisigOmniLockPrivateKey(
    client: Client,
    privateKey: BytesLike,
    multisigInfoLike: MultisigCkbWitnessLike,
    options?: null | OmniLockMultisigOptions,
): SignerMultisigOmniLockPrivateKey
Creates an instance of SignerMultisigOmniLockPrivateKey.
Parameters
- client: Client
  The client instance.
- privateKey: BytesLike
  The secp256k1 private key for this guard.
- multisigInfoLike: MultisigCkbWitnessLike
  The multisig configuration (all public keys, threshold, mustMatch).
- Optionaloptions: null | OmniLockMultisigOptions
  Omnilock-specific options (flags, ACP minimums, script override).
Returns SignerMultisigOmniLockPrivateKey
Overrides SignerMultisigOmniLockReadonly.constructor
- Defined in signer/ckb/signerMultisigOmniLockPrivateKey.ts:37

Properties

`Static`EmptySignature

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

`Readonly`multisigInfo

multisigInfo: MultisigCkbWitness

`Readonly`scriptInfos

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

`Readonly`omniLockFlags

omniLockFlags: number

`Readonly`acpMinCkb

acpMinCkb: number

`Readonly`acpMinUdt

acpMinUdt: number

`Protected`client_

client_: Client

Accessors

type

get type(): SignerType
Returns SignerType
Inherited from SignerMultisigOmniLockReadonly.type
- Defined in signer/ckb/signerMultisigCkbBase.ts:35

signType

get signType(): SignerSignType
Returns SignerSignType
Inherited from SignerMultisigOmniLockReadonly.signType
- Defined in signer/ckb/signerMultisigCkbBase.ts:39

client

get client(): Client
Returns Client
Inherited from SignerMultisigOmniLockReadonly.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.
Inherited from SignerMultisigOmniLockReadonly.getMemberCount
- Defined in signer/ckb/signerMultisigCkbBase.ts:80

getMemberThreshold

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

Returns Promise<number>
The threshold.
Inherited from SignerMultisigOmniLockReadonly.getMemberThreshold
- Defined in signer/ckb/signerMultisigCkbBase.ts:84

connect

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

Returns Promise<void>
A promise that resolves when the connection is complete.
Inherited from SignerMultisigOmniLockReadonly.connect
- Defined in signer/ckb/signerMultisigCkbBase.ts:88

isConnected

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

Returns Promise<boolean>
A promise that resolves the connection status.
Inherited from SignerMultisigOmniLockReadonly.isConnected
- Defined in signer/ckb/signerMultisigCkbBase.ts:90

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.
Inherited from SignerMultisigOmniLockReadonly.getInternalAddress
- Defined in signer/ckb/signerMultisigCkbBase.ts:94

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.
Inherited from SignerMultisigOmniLockReadonly.getAddressObjs
- Defined in signer/ckb/signerMultisigCkbBase.ts:98

decodeWitnessArgsAt

decodeWitnessArgsAt(
txLike: TransactionLike,
index: number,
): undefined | MultisigCkbWitness
Decode the witness args at a specific index.
Parameters
- txLike: TransactionLike
- index: number
Returns undefined | MultisigCkbWitness
Inherited from SignerMultisigOmniLockReadonly.decodeWitnessArgsAt
- Defined in signer/ckb/signerMultisigCkbBase.ts:107

decodeWitnessArgs

decodeWitnessArgs(
witnessLike?: null | WitnessArgsLike,
): undefined | MultisigCkbWitness
Decode the witness args.
Parameters
- OptionalwitnessLike: null | WitnessArgsLike
Returns undefined | MultisigCkbWitness
Inherited from SignerMultisigOmniLockReadonly.decodeWitnessArgs
- Defined in signer/ckb/signerMultisigCkbBase.ts:118

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
- index: number
- Optionaltransformer:
      | null
      | (
          (
              witness: MultisigCkbWitness,
              witnessArgs: WitnessArgs,
          ) =>
              | undefined
              | null
              | void
              | MultisigCkbWitnessLike
              | Promise<(void | MultisigCkbWitnessLike | null | undefined)>
      )
Returns Promise<Transaction>
Inherited from SignerMultisigOmniLockReadonly.prepareWitnessArgsAt
- Defined in signer/ckb/signerMultisigCkbBase.ts:143

prepareTransactionOneScript

prepareTransactionOneScript(
    txLike: TransactionLike,
    script: ScriptLike,
    cellDeps: CellDepInfoLike[],
): Promise<Transaction>
Prepare multisig witness for a single script variant.
Parameters
- txLike: TransactionLike
- script: ScriptLike
- cellDeps: CellDepInfoLike[]
Returns Promise<Transaction>
Inherited from SignerMultisigOmniLockReadonly.prepareTransactionOneScript
- Defined in signer/ckb/signerMultisigCkbBase.ts:190

prepareTransaction

prepareTransaction(txLike: TransactionLike): Promise<Transaction>
Prepare transaction for multisig witness and adding related cell deps.
Parameters
- txLike: TransactionLike
Returns Promise<Transaction>
Inherited from SignerMultisigOmniLockReadonly.prepareTransaction
- Defined in signer/ckb/signerMultisigCkbBase.ts:208

getSignaturesCount

getSignaturesCount(txLike: TransactionLike): Promise<undefined | number>
Get the number of signatures in the transaction.
Parameters
- txLike: TransactionLike
Returns Promise<undefined | number>
Inherited from SignerMultisigOmniLockReadonly.getSignaturesCount
- Defined in signer/ckb/signerMultisigCkbBase.ts:220

needMoreSignatures

needMoreSignatures(txLike: TransactionLike): Promise<boolean>
Check if the transaction needs more signatures.
Parameters
- txLike: TransactionLike
Returns Promise<boolean>
Inherited from SignerMultisigOmniLockReadonly.needMoreSignatures
- Defined in signer/ckb/signerMultisigCkbBase.ts:254

getSignInfo

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

aggregateTransactions

aggregateTransactions(txs: TransactionLike[]): Promise<Transaction>
Aggregate transactions.
Parameters
- txs: TransactionLike[]
Returns Promise<Transaction>
Inherited from SignerMultisigOmniLockReadonly.aggregateTransactions
- Defined in signer/ckb/signerMultisigCkbBase.ts:298

signOnlyTransaction

signOnlyTransaction(txLike: TransactionLike): Promise<Transaction>
Sign a transaction with this guard's private key.

Finds the first empty signature slot in the multisig witness and fills it. If this key has already signed, the transaction is returned unchanged.
Parameters
- txLike: TransactionLike
Returns Promise<Transaction>
Overrides SignerMultisigOmniLockReadonly.signOnlyTransaction
- Defined in signer/ckb/signerMultisigOmniLockPrivateKey.ts:55

`Protected`encodeWitnessLock

encodeWitnessLock(witness: MultisigCkbWitness): `0x${string}`
Encode a MultisigCkbWitness into the bytes stored in WitnessArgs.lock. CKB multisig: raw multisig hex. OmniLock: wrapped in OmniLockWitnessLock.
Parameters
- witness: MultisigCkbWitness
Returns `0x${string}`
Inherited from SignerMultisigOmniLockReadonly.encodeWitnessLock
- Defined in signer/ckb/signerMultisigOmniLockReadonly.ts:147

`Protected`decodeWitnessLock

decodeWitnessLock(lock: `0x${string}`): undefined | MultisigCkbWitness
Decode WitnessArgs.lock bytes back into a MultisigCkbWitness. Returns undefined if the data does not match this signer's format.
Parameters
- lock: `0x${string}`
Returns undefined | MultisigCkbWitness
Inherited from SignerMultisigOmniLockReadonly.decodeWitnessLock
- Defined in signer/ckb/signerMultisigOmniLockReadonly.ts:151

matchNetworkPreference

matchNetworkPreference(
preferences: NetworkPreference[],
currentNetwork: undefined | string,
): undefined | NetworkPreference
Parameters
- preferences: NetworkPreference[]
- currentNetwork: undefined | string
Returns undefined | NetworkPreference
Inherited from SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.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 SignerMultisigOmniLockReadonly.signTransaction
- Defined in signer/signer/index.ts:457

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 SignerMultisigOmniLockReadonly.sendTransaction
- Defined in signer/signer/index.ts:538

Class SignerMultisigOmniLockPrivateKey

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SignerMultisigOmniLockPrivateKey

Properties

StaticEmptySignature

ReadonlymultisigInfo

ReadonlyscriptInfos

ReadonlyomniLockFlags

ReadonlyacpMinCkb

ReadonlyacpMinUdt

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>

signOnlyTransaction

Parameters

Returns Promise<Transaction>

ProtectedencodeWitnessLock

Parameters

Returns `0x${string}`

ProtecteddecodeWitnessLock

Parameters

Returns undefined | MultisigCkbWitness

matchNetworkPreference

Parameters

Returns undefined | NetworkPreference

StaticverifyMessage

Parameters

`Static`EmptySignature

`Readonly`multisigInfo

`Readonly`scriptInfos

`Readonly`omniLockFlags

`Readonly`acpMinCkb

`Readonly`acpMinUdt

`Protected`client_

`Protected`encodeWitnessLock

`Protected`decodeWitnessLock

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