Class SignerCkbScriptReadonly

A read-only signer for a CKB script. It can be used to get addresses, but not to sign transactions. This is useful when you want to watch an address without having the private key.

Hierarchy (view full)

ccc.Signer
- SignerCkbScriptReadonly

Constructors

constructor

new SignerCkbScriptReadonly(client, ...scripts): SignerCkbScriptReadonly
Creates an instance of SignerCkbScriptReadonly.
Parameters
- client: Client
  The client instance used for communication.
- Rest...scripts: (ScriptLike | ScriptLike[])[]
  The scripts associated with the signer. Can be a single script, an array of scripts, or multiple script arguments.
Returns SignerCkbScriptReadonly
Overrides Signer.constructor
- Defined in signer/ckb/signerCkbScriptReadonly.ts:40

Properties

`Readonly`scripts

scripts: Script[]

The scripts associated with the signer.

`Protected`client_

client_: Client

Accessors

type

get type(): SignerType
The type of the signer.

Returns SignerType
Overrides Signer.type
- Defined in signer/ckb/signerCkbScriptReadonly.ts:17

signType

get signType(): SignerSignType
The sign type of the signer. As this is a read-only signer, the sign type is SignerSignType.Unknown.

Returns SignerSignType
Overrides Signer.signType
- Defined in signer/ckb/signerCkbScriptReadonly.ts:25

client

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

Methods

connect

connect(): Promise<void>
Connects to the client. This implementation does nothing as the class is read-only.

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

isConnected

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

Returns Promise<boolean>
A promise that resolves the connection status.
Overrides Signer.isConnected
- Defined in signer/ckb/signerCkbScriptReadonly.ts:61

getInternalAddress

getInternalAddress(): Promise<string>
Gets the internal address for the script.

Returns Promise<string>
A promise that resolves to a string representing the internal address.
Example
```
const internalAddress = await signer.getInternalAddress(); // Outputs the internal address
```
Overrides Signer.getInternalAddress
- Defined in signer/ckb/signerCkbScriptReadonly.ts:75

getAddressObjs

getAddressObjs(): Promise<ccc.Address[]>
Gets an array of Address objects representing the script address.

Returns Promise<ccc.Address[]>
A promise that resolves to an array of Address objects.
Example
```
const addressObjs = await signer.getAddressObjs(); // Outputs the array of Address objects
```
Overrides Signer.getAddressObjs
- Defined in signer/ckb/signerCkbScriptReadonly.ts:89

matchNetworkPreference

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

`Static`verifyMessage

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

onReplaced

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

disconnect

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

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

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 Signer.getIdentity
- Defined in signer/signer/index.ts:201

getRecommendedAddressObj

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

getRecommendedAddress

getRecommendedAddress(preference?): 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 Signer.getRecommendedAddress
- Defined in signer/signer/index.ts:228

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 Signer.getAddresses
- Defined in signer/signer/index.ts:237

findCellsOnChain

findCellsOnChain(filter, withData?, order?, limit?): AsyncGenerator<Cell, any, any>
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, any, any>
A async generator that yields all matching cells
Inherited from Signer.findCellsOnChain
- Defined in signer/signer/index.ts:252

findCells

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

findTransactions

findTransactions(filter, groupByTransaction?, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
}, any, any>
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;
}, any, any>
A async generator that yields all matches transactions
Inherited from Signer.findTransactions
- Defined in signer/signer/index.ts:310
findTransactions(filter, groupByTransaction, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, any>
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;
    }[];
}, any, any>
A async generator that yields all matches transactions
Inherited from Signer.findTransactions
- Defined in signer/signer/index.ts:321
findTransactions(filter, groupByTransaction?, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
} | {
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, any>
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;
    }[];
}, any, any>
A async generator that yields all matches transactions
Inherited from Signer.findTransactions
- Defined in signer/signer/index.ts:332

getBalance

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

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

signMessage

signMessage(message): 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 Signer.signMessage
- Defined in signer/signer/index.ts:391

signMessageRaw

signMessageRaw(_): 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 Signer.signMessageRaw
- Defined in signer/signer/index.ts:406

verifyMessage

verifyMessage(message, 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 Signer.verifyMessage
- Defined in signer/signer/index.ts:418

sendTransaction

sendTransaction(tx): Promise<`0x${string}`>
Sends a transaction after signing it.
Parameters
- tx: TransactionLike
  The transaction to send, represented as a TransactionLike object.
Returns Promise<`0x${string}`>
A promise that resolves to the transaction hash as a Hex string.
Inherited from Signer.sendTransaction
- Defined in signer/signer/index.ts:446

signTransaction

signTransaction(tx): 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 Signer.signTransaction
- Defined in signer/signer/index.ts:456

prepareTransaction

prepareTransaction(_): Promise<Transaction>
prepare a transaction before signing. This method is not implemented and should be overridden by subclasses.
Parameters
- _: TransactionLike
  The transaction to prepare, represented as a TransactionLike object.
Returns Promise<Transaction>
A promise that resolves to the prepared Transaction object.

Throws
Will throw an error if not implemented.
Inherited from Signer.prepareTransaction
- Defined in signer/signer/index.ts:468

signOnlyTransaction

signOnlyTransaction(_): 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 Signer.signOnlyTransaction
- Defined in signer/signer/index.ts:479

Class SignerCkbScriptReadonly

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SignerCkbScriptReadonly

Properties

Readonlyscripts

Protectedclient_

Accessors

type

Returns SignerType

signType

Returns SignerSignType

client

Returns Client

Methods

connect

Returns Promise<void>

isConnected

Returns Promise<boolean>

getInternalAddress

Returns Promise<string>

Example

getAddressObjs

Returns Promise<ccc.Address[]>

Example

matchNetworkPreference

Parameters

Returns undefined | NetworkPreference

StaticverifyMessage

Parameters

Returns Promise<boolean>

onReplaced

Parameters

Returns void

Returns (() => void)

Returns void

disconnect

Returns Promise<void>

getIdentity

Returns Promise<string>

getRecommendedAddressObj

Parameters

Returns Promise<ccc.Address>

getRecommendedAddress

Parameters

Returns Promise<string>

getAddresses

Returns Promise<string[]>

findCellsOnChain

Parameters

Returns AsyncGenerator<Cell, any, any>

findCells

Parameters

Returns AsyncGenerator<Cell, any, any>

findTransactions

Parameters

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

Parameters

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

Parameters

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

getBalance

Returns Promise<bigint>

signMessage

Parameters

Returns Promise<Signature>

Throws

signMessageRaw

Parameters

Returns Promise<string>

Throws

verifyMessage

Parameters

`Readonly`scripts

`Protected`client_

`Static`verifyMessage

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

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

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