History

Richard Moore 97efeba8dc docs: fixed typo in contracts readme (#1128 ).		2020-11-18 17:20:24 -05:00
..
lib	Updated dist build.	2020-11-16 23:07:24 -05:00
lib.esm	Updated dist build.	2020-11-16 23:07:24 -05:00
src.ts	Updated dist build.	2020-11-16 23:07:24 -05:00
.npmignore	Refactoring dist build process.	2020-11-14 17:42:36 -05:00
LICENSE.md	Initial v5 branch commit.	2019-05-14 18:25:46 -04:00
package.json	Updated dist build.	2020-11-16 23:07:24 -05:00
README.md	docs: fixed typo in contracts readme (#1128 ).	2020-11-18 17:20:24 -05:00
tsconfig.json	Updated dist files.	2020-09-22 23:18:45 -04:00

README.md

Ethereum Contract Meta-Class

This sub-module is part of the ethers project.

It is creating (at run-time) an object which interacts with an on-chain contract as a native JavaScript object.

If you are familiar with ORM for Databases, this is similar, but for smart contracts.

For more information, see the documentation.

Importing

Most users will prefer to use the umbrella package, but for those with more specific needs, individual components can be imported.

const {

    Contract,
    ContractFactory,

    RunningEvent,

    // Types

    ContractInterface,

    Overrides,
    PayableOverrides,
    CallOverrides,

    PopulatedTransaction,

    EventFilter,

    ContractFunction,

    Event,
    ContractReceipt,
    ContractTransaction

} = require("@ethersproject/contracts");

License

MIT License