JsonRpcProvider

new ethers . providers . JsonRpcProvider( [ url [ , aNetworkish ] ] )

Connect to a JSON-RPC API located at url using the aNetworkish network. If url is not specified, the default (i.e. http://localhost:8545) is used and if no network is specified, it will be determined automatically by querying the node.

Note: Connecting to a Local Node

Each node implementation is slightly different and may require specific command-line flags, configuration or settings in their UI to enable JSON-RPC, unlock accounts or expose specific APIs. Please consult their documentation.

jsonRpcProvider . getSigner( [ addressOrIndex ] ) => JsonRpcSigner

Returns a JsonRpcSigner which is managed by this Ethereum node, at addressOrIndex. If no addressOrIndex is provided, the first account (account #0) is used.

jsonRpcProvider . getUncheckedSigner( [ addressOrIndex ] ) => JsonRpcUncheckedSigner

jsonRpcProvider . listAccounts( ) => Array< string >

Returns a list of all account addresses managed by this provider.

jsonRpcProvider . send( method , params ) => Promise< any >

Allows sending raw messages to the provider.

This can be used for backend-specific calls, such as for debugging or specific account management.

JsonRpcSigner

signer . provider => JsonRpcProvider

The provider this signer was established from.

signer . connectUnchecked( ) => JsonRpcUncheckedSigner

Returns a new Signer object which does not perform additional checks when sending a transaction. See getUncheckedSigner for more details.

signer . sendUncheckedTransaction( transaction ) => Promise< string< DataHexString< 32 > > >

Sends the transaction and returns a Promise which resolves to the opaque transaction hash.

signer . unlock( password ) => Promise< boolean >

Request the node unlock the account (if locked) using password.

2.5 KiB Raw Blame History