Documentation

Documentation »API »Providers »Subclassing Signer

Subclassing Signer

Generally the Wallet and JsonRpcSigner and their sub-classes are sufficent for most developers, but this is provided to fascilitate more complex Signers.

abstract class AbstractSigner

inherits from Signer, Addressable, ContractRunner, NameResolver

An AbstractSigner includes most of teh functionality required to get a Signer working as expected, but requires a few Signer-specific methods be overridden.

PROPERTIES

<src>abstractSigner.provider⇒ Pread-only

The provider this signer is connected to.

CREATING INSTANCES

<src>new AbstractSigner(provider?: P)

Creates a new Signer connected to provider.

METHODS

<src>abstractSigner.connect(provider: null | Provider)⇒ Signerabstract

Returns the signer connected to provider.

This may throw, for example, a Signer connected over a Socket or to a specific instance of a node may not be transferrable.

<src>abstractSigner.getAddress()⇒ Promise< string >abstract

Resolves to the Signer address.

class VoidSigner

inherits from AbstractSigner, Signer

A VoidSigner is a class deisgned to allow an address to be used in any API which accepts a Signer, but for which there are no credentials available to perform any actual signing.

This for example allow impersonating an account for the purpose of static calls or estimating gas, but does not allow sending transactions.

PROPERTIES

<src>voidSigner.address⇒ stringread-only

The signer address.

CREATING INSTANCES

<src>new VoidSigner(address: string, provider?: null | Provider)

Creates a new VoidSigner with address attached to provider.