Class SignerJsonRpc

An abstract class representing a generic signer. This class provides methods to connect, get addresses, and sign transactions.

Hierarchy (View Summary)

Signer
- SignerJsonRpc

Properties

`Readonly`requestor

requestor: RequestorJsonRpc

getScripts

getScripts: () => Promise<Script[]> = ...

getInternalAddress

getInternalAddress: () => Promise<string> = ...

Gets the internal address associated with the signer.

Type Declaration

- (): Promise<string>
- Returns Promise<string>
  A promise that resolves to a string representing the internal address.

getIdentity

getIdentity: () => Promise<string> = ...

Gets the identity for verifying signature, usually it's address

Type Declaration

- (): Promise<string>
- Returns Promise<string>
  A promise that resolves to a string representing the identity

signMessageRaw

signMessageRaw: (_: BytesLike) => Promise<string> = ...

Signs a message and returns signature only. This method is not implemented and should be overridden by subclasses.

Type Declaration

- (_: BytesLike): Promise<string>
- 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.

prepareTransaction

prepareTransaction: (tx: TransactionLike) => Promise<Transaction> = ...

Prepares a transaction before signing. This method can be overridden by subclasses to perform any necessary steps, such as adding cell dependencies or witnesses, before the transaction is signed. The default implementation converts the TransactionLike object to a Transaction object without modification.

Type Declaration

- (tx: TransactionLike): Promise<Transaction>
- Parameters
  - tx: TransactionLike
    The transaction to prepare.
  Returns Promise<Transaction>
  A promise that resolves to the prepared Transaction object.

Remarks

Note that this default implementation does not add any cell dependencies or dummy witnesses. This may lead to an underestimation of transaction size and fees if used with methods like Transaction.completeFee. Subclasses for signers that are intended to sign transactions should override this method to perform necessary preparations.

signOnlyTransaction

signOnlyTransaction: (_: TransactionLike) => Promise<Transaction> = ...

Signs a transaction without preparing information for it. This method is not implemented and should be overridden by subclasses.

Type Declaration

- (_: TransactionLike): Promise<Transaction>
- 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.

`Protected`client_

client_: Client

Accessors

type

get type(): SignerType
Returns SignerType
Overrides Signer.type
- Defined in signer/jsonRpc/signer.ts:52

signType

get signType(): SignerSignType
Returns SignerSignType
Overrides Signer.signType
- Defined in signer/jsonRpc/signer.ts:56

url

get url(): string
Returns string
- Defined in signer/jsonRpc/signer.ts:60

name

get name(): string | undefined
Returns string | undefined
- Defined in signer/jsonRpc/signer.ts:64

icon

get icon(): string | undefined
Returns string | undefined
- Defined in signer/jsonRpc/signer.ts:68

client

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

Methods

`Static`new

new(client: Client, config: SignerJsonRpcConfig): Promise<SignerJsonRpc>
Creates a Signer that borrows an existing Transport.
Parameters
- client: Client
- config: SignerJsonRpcConfig
Returns Promise<SignerJsonRpc>
- Defined in signer/jsonRpc/signer.ts:39

connect

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

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

disconnect

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

Returns Promise<void>
A promise that resolves when the signer is disconnected.
Overrides Signer.disconnect
- Defined in signer/jsonRpc/signer.ts:92

onReplaced

onReplaced(listener: () => void): () => boolean
Register a listener to be called when this signer is replaced.
Parameters
- listener: () => void
Returns () => boolean
A function for unregister
Overrides Signer.onReplaced
- Defined in signer/jsonRpc/signer.ts:110

replace

replace(): void
Returns void
- Defined in signer/jsonRpc/signer.ts:115

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/jsonRpc/signer.ts:122

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 Signer.getAddressObjs
- Defined in signer/jsonRpc/signer.ts:135

buildSender

buildSender(
    rpcMethod: string,
    inTransformers?: (((_: any) => unknown) | undefined)[],
    outTransformer?: (_: any) => unknown,
): (...request: unknown[]) => Promise<unknown>
Parameters
- rpcMethod: string
- OptionalinTransformers: (((_: any) => unknown) | undefined)[]
- OptionaloutTransformer: (_: any) => unknown
Returns (...request: unknown[]) => Promise<unknown>
- Defined in signer/jsonRpc/signer.ts:164

matchNetworkPreference

matchNetworkPreference(
preferences: NetworkPreference[],
currentNetwork: string | undefined,
): NetworkPreference | undefined
Parameters
- preferences: NetworkPreference[]
- currentNetwork: string | undefined
Returns NetworkPreference | undefined

Deprecated
Wallet integrations now use fixed-network signers.
Inherited from Signer.matchNetworkPreference
- Defined in signer/signer/index.ts:85

`Static`verifyMessage

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

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

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

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

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

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

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 Signer.findTransactions
- Defined in signer/signer/index.ts:303
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 Signer.findTransactions
- Defined in signer/signer/index.ts:314
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 Signer.findTransactions
- Defined in signer/signer/index.ts:325

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

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

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

sendTransaction

sendTransaction(tx: TransactionLike): 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:439

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

Class SignerJsonRpc

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Readonlyrequestor

getScripts

getInternalAddress

Type Declaration

Returns Promise<string>

getIdentity

Type Declaration

Returns Promise<string>

signMessageRaw

Type Declaration

Parameters

Returns Promise<string>

Throws

prepareTransaction

Type Declaration

Parameters

Returns Promise<Transaction>

Remarks

signOnlyTransaction

Type Declaration

Parameters

Returns Promise<Transaction>

Throws

Protectedclient_

Accessors

type

Returns SignerType

signType

Returns SignerSignType

url

Returns string

name

Returns string | undefined

icon

Returns string | undefined

client

Returns Client

Methods

Staticnew

Parameters

Returns Promise<SignerJsonRpc>

connect

Returns Promise<void>

disconnect

Returns Promise<void>

onReplaced

Parameters

Returns () => boolean

replace

Returns void

isConnected

Returns Promise<boolean>

getAddressObjs

Returns Promise<Address[]>

buildSender

Parameters

Returns (...request: unknown[]) => Promise<unknown>

matchNetworkPreference

Parameters

Returns NetworkPreference | undefined

Deprecated

StaticverifyMessage

Parameters

Returns Promise<boolean>

getRecommendedAddressObj

Parameters

Returns Promise<Address>

getRecommendedAddress

Parameters

Returns Promise<string>

getAddresses

Returns Promise<string[]>

findCellsOnChain

`Readonly`requestor

`Protected`client_

`Static`new

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