UNPKG

1 kBMarkdownView Raw
1Ethereum Contract Meta-Class
2============================
3
4This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).
5
6It is creating (at run-time) an object which interacts with an on-chain
7contract as a native JavaScript object.
8
9If you are familiar with ORM for Databases, this is similar, but for smart contracts.
10
11For more information, see the [documentation](https://docs.ethers.io/v5/api/contract/).
12
13Importing
14---------
15
16Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
17but for those with more specific needs, individual components can be imported.
18
19```javascript
20const {
21
22 Contract,
23 ContractFactory,
24
25 RunningEvent,
26
27 // Types
28
29 ContractInterface,
30
31 Overrides,
32 PayableOverrides,
33 CallOverrides,
34
35 PopulatedTransaction,
36
37 EventFilter,
38
39 ContractFunction,
40
41 Event,
42 ContractReceipt,
43 ContractTransaction
44
45} = require("@ethersproject/contracts");
46```
47
48
49License
50-------
51
52MIT License