ethers.js/docs.wrm/api/contract/example.wrm

_section: Example: ERC-20 Contract

_subsection: Connecting to a Contract

_code: token.txt


_heading: ERC20Contract @INHERIT<[[contract]]>

_property: new ethers.Contract(address, abi, providerOrSigner)
See the above code example for creating an Instance which will
(in addition to the Contact methods and properties) automatically
add the additional properties defined in //abi// to a **Contract**
connected to //address// using the //providerOrSigner//.


_subsection: Properties ^^//(inheritted from [[contract]])//^^

_property: erc20.address => string<[[address]]>
This is the address (or ENS name) the contract was constructed with.

_property: erc20.addressPromise => string<[[address]]>
This is a promise that will resolve to the address the **Contract**
object is attached to. If an [[address]] was provided to the constructor,
it will be equal to this; if an ENS name was provided, this will be the
resolved address.

_property: erc20.deployTransaction => [[provider-transactionresponse]]
If the **Contract** object is the result of a ContractFactory deployment,
this is the transaction which was used to deploy the contract.

_property: erc20.interface => [[abi-interface]]
This is the ABI as an [[abi-interface]].

_property: erc20.provider => [[provider]]
If a provider was provided to the constructor, this is that provider. If
a signer was provided that had a [[provider]], this is that provider.

_property: erc20.signer => [[signer]]
If a signer was provided to the constructor, this is that signer.


_subsection: Methods ^^//(inheritted from [[contract]])//^^

_property: erc20.attach(addressOrName) => [[contract]]
Returns a new instance of the **Contract** attached to a new
address. This is useful if there are multiple similar or identical
copies of a Contract on the network and you wish to interact with
each of them.

_property: erc20.connect(providerOrSigner) => [[contract]]
Returns a new instance of the Contract, but connected to
//providerOrSigner//.

By passing in a [[provider]], this will return a downgraded
**Contract** which only has read-only access (i.e. constant calls).

By passing in a [[signer]]. the will return a **Contract** which
will act on behalf of that signer.

_property: erc20.deployed() => Promise<Contract>

_property: Contract.isIndexed(value) => boolean


_subsection: Events ^^//(inheritted from Contract)//^^ @<erc20-events>

_property: erc20.queryFilter(event [ , fromBlockOrBlockHash [ , toBlock ]) => Promise<Array<Event>> @<erc20-queryfilter>
Return Events that match the //event//.

_property: erc20.listenerCount([ event ]) => number
Return the number of listeners that are subscribed to //event//. If
no event is provided, returns the total count of all events.

_property: erc20.listeners(event) => Array<Listener>
Return a list of listeners that are subscribed to //event//.

_property: erc20.off(event, listener) => this
Unsubscribe //listener// to //event//.

_property: erc20.on(event, listener) => this
Subscribe to //event// calling //listener// when the event occurs.

_property: erc20.once(event, listener) => this
Subscribe once to //event// calling //listener// when the event
occurs.

_property: erc20.removeAllListeners([ event ]) => this
Unsubscribe all listeners for //event//. If no event is provided,
all events are unsubscribed.


_subsection: Meta-Class Methods ^^//(added at Runtime)//^^

Since the Contract is a Meta-Class, the methods available here depend
on the ABI which was passed into the **Contract**.

_property: erc20.decimals([ overrides ]) => Promise<number>
Returns the number of decimal places used by this ERC-20 token. This can be
used with [parseUnits](utils-parseunits) when taking input from the user or
[formatUnits](utils-formatunits] when displaying the token amounts in the UI.

_property: erc20.getBalance(owner [, overrides ]) => Promise<[[bignumber]]>
Returns the balance of //owner// for this ERC-20 token.

_property: erc20.symbol([ overrides ]) => Promise<string>
Returns the symbol of the token.

_property: erc20_rw.transfer(target, amount [, overrides ]) => Promise<[[provider-transactionresponse]]>
Transfers //amount// tokens to //target// from the current signer.
The return value (a boolean) is inaccessible during a write operation
using a transaction. Other techniques (such as events) are required
if this value is required. On-chain contracts calling the ``transfer``
function have access to this result, which is why it is possible.

_property: erc20.callStatic.transfer(target, amount [, overrides ]) => Promise<boolean>
Performs a dry-run of transferring //amount// tokens to //target// from
the current signer, without actually signing or sending a transaction.

This can be used to preflight check that a transaction will be successful.

_property: erc20.estimate.transfer(target, amount [, overrides ]) => Promise<[[bignumber]]>
Returns an estimate for how many units of gas would be required
to transfer //amount// tokens to //target//.

_property: erc20.populateTransaction.transfer(target, amount [, overrides ]) => Promise<[UnsignedTx](types-unsignedtransaction)>
Returns an [[types-unsignedtransaction]] which could be signed and submitted
to the network to transaction //amount// tokens to //target//.


_note: Note on Estimating and Static Calling

When you perform a static call, the current state is taken into account as
best as Ethereum can determine. There are many cases where this can provide
false positives and false negatives. The eventually consistent model of the
blockchain also means there are certain consistency modes that cannot be
known until an actual transaction is attempted.


_subsection: Meta-Class Filters ^^//(added at Runtime)//^^

Since the Contract is a Meta-Class, the methods available here depend
on the ABI which was passed into the **Contract**.

_property: erc20.filters.Transafer([ fromAddress [ , toAddress ] ]) => Filter
Returns a new Filter which can be used to [query](erc20-queryfilter) or
to [subscribe/unsubscribe to events](erc20-events).

If //fromAddress// is null or not provided, then any from address matches.
If //toAddress// is null or not provided, then any to address matches.