JsonRpcSigner - Quai Network Docs

A signer that uses JSON-RPC to sign transactions and messages.

Extends

AbstractSigner<JsonRpcApiProvider>

Constructors

new JsonRpcSigner()

new JsonRpcSigner(provider, address): JsonRpcSigner

Creates a new JsonRpcSigner instance.

Parameters

Parameter	Type	Description
`provider`	`JsonRpcApiProvider`<`any`>	The JSON-RPC provider.
`address`	`string`	The address of the signer.

Properties

Property	Modifier	Type	Description	Inherited from
`provider`	`readonly`	`JsonRpcApiProvider`<`FetchRequest`>	The provider this signer is connected to.	`AbstractSigner`.`provider`

Methods

connect()

connect(provider): Signer

Connects the signer to a provider.

Parameters

Parameter	Type	Description
`provider`	`null` \| `Provider`	The provider to connect to.

Returns

Signer The connected signer.

Overrides

AbstractSigner.connect

Throws

If the signer cannot be reconnected.

Source

providers/provider-jsonrpc.ts:342

getAddress()

getAddress(): Promise<string>

Gets the address of the signer.

Returns

Promise<string> The address of the signer.

Overrides

AbstractSigner.getAddress

Source

providers/provider-jsonrpc.ts:353

sendTransaction()

sendTransaction(tx): Promise<TransactionResponse>

Sends a transaction.

Parameters

Parameter	Type	Description
`tx`	`TransactionRequest`	The transaction request.

Returns

Promise<TransactionResponse> The transaction response.

Overrides

AbstractSigner.sendTransaction

Throws

If the transaction cannot be sent.

Source

providers/provider-jsonrpc.ts:438

signMessage()

signMessage(_message): Promise<string>

Signs a message.

Parameters

Parameter	Type	Description
`_message`	`string` \| `Uint8Array`	The message to sign.

Returns

Promise<string> The signed message.

Overrides

AbstractSigner.signMessage

Source

providers/provider-jsonrpc.ts:551

signTransaction()

signTransaction(_tx): Promise<string>

Signs a transaction.

Parameters

Parameter	Type	Description
`_tx`	`TransactionRequest`	The transaction request.

Returns

Promise<string> The signed transaction.

Overrides

AbstractSigner.signTransaction

Throws

If the transaction cannot be signed.

Source

providers/provider-jsonrpc.ts:521

signTypedData()

signTypedData(
   domain, 
   types, 
_value): Promise<string>

Signs typed data.

Parameters

Parameter	Type	Description
`domain`	`TypedDataDomain`	The domain of the typed data.
`types`	`Record`<`string`, `TypedDataField`[]>	The types of the typed data.
`_value`	`Record`<`string`, `any`>	The value of the typed data.

Returns

Promise<string> The signed typed data.

Overrides

AbstractSigner.signTypedData

Source

providers/provider-jsonrpc.ts:564

unlock()

unlock(password): Promise<boolean>

Unlocks the account.

Parameters

Parameter	Type	Description
`password`	`string`	The password to unlock the account.

Returns

Promise<boolean> True if the account is unlocked, false otherwise.

Source

providers/provider-jsonrpc.ts:583

​Extends

​Constructors

​new JsonRpcSigner()

​Parameters

​Returns

​Overrides

​Source

​Properties

​Methods

​connect()

​Parameters

​Returns

​Overrides

​Throws

​Source

​getAddress()

​Returns

​Overrides

​Source

​sendTransaction()

​Parameters

​Returns

​Overrides

​Throws

​Source

​signMessage()

​Parameters

​Returns

​Overrides

​Source

​signTransaction()

​Parameters

​Returns

​Overrides

​Throws

​Source

​signTypedData()

​Parameters

​Returns

​Overrides

​Source

​unlock()

​Parameters

​Returns

​Source

Extends

Constructors

new JsonRpcSigner()

Parameters

Returns

Overrides

Source

Properties

Methods

connect()

Parameters

Returns

Overrides

Throws

Source

getAddress()

Returns

Overrides

Source

sendTransaction()

Parameters

Returns

Overrides

Throws

Source

signMessage()

Parameters

Returns

Overrides

Source

signTransaction()

Parameters

Returns

Overrides

Throws

Source

signTypedData()

Parameters

Returns

Overrides

Source

unlock()

Parameters

Returns

Source