UNPKG

@kodex-data/evm-contracts

Version:

This is a package that provides utilities and modules for Ethereum Virtual Machine (EVM) contracts.

github.com/KodexData/kodex-data-suite

KodexData/kodex-data-suite

125 lines (107 loc) • 3.13 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# @kodex-data/evm-contracts This is a package that provides utilities and modules for Ethereum Virtual Machine (EVM) contracts using open zeppelin library ```bash ____ __. .___ ________ __ | |/ _|____ __| _/____ ___ ___ \______ \ _____ _/ |______ | < / _ \ / __ |/ __ \\ \/ / | | \\__ \\ __\__ \ | | ( <_> ) /_/ \ ___/ > < | ` \/ __ \| | / __ \_ |____|__ \____/\____ |\___ >__/\_ \ /_______ (____ /__| (____ / \/ \/ \/ \/ \/ \/ \/ kodexdata.systems ``` ## Installation To install `@kodex-data/evm-contracts`, you can use `npm` or `yarn`: ```shell npm install @kodex-data/evm-contracts # or yarn add @kodex-data/evm-contracts ``` ## Example To use this module, you would need to import the objects and types you need from the module. For example, if you wanted to use the ERC20 contract, you would import the ERC20 type and the ERC20__factory object from the module: ```typescript import { ERC20, ERC20__factory } from '@kodex-data/evm-contracts'; const erc20 = ERC20__factory.connect(contractAddress, provider); // Use erc20 object to interact with the ERC20 contract. ``` Similarly, if you wanted to create a new instance of the ERC20 contract, you would use the factory object: ```typescript const erc20Factory = new ERC20__factory(signer); const erc20 = await erc20Factory.deploy(name, symbol, decimals); // Use erc20 object to interact with the new instance of the ERC20 contract. ``` ## Type Aliases * AccessControl * ByteStore * DoubleEndedQueue * ERC165 * ERC20 * ERC20Permit * ERC20PermitToken * ERC721 * ERC721Burnable * ERC721Enumerable * ERC721URIStorage * ERC721Votes * EvmAuth * EvmTicket * ForAgainstQuorum * ForAgainstWeightedQuorum * Governor * GovernorCountingSimple * HashStore * IAccessControl * IERC1155Receiver * IERC165 * IERC20 * IERC20Metadata * IERC20Permit * IERC721 * IERC721Enumerable * IERC721Metadata * IERC721Receiver * IGovernor * IVotes * Moderatable * Multicall2 * Ownable * PhxCollectible * Treasury * Votes ## Objects * factories: An object containing the factories for each of the EVM contracts listed above. * AccessControl\_\_factory * ByteStore\_\_factory * DoubleEndedQueue\_\_factory * ERC165\_\_factory * ERC20\_\_factory * ERC20Permit\_\_factory * ERC20PermitToken\_\_factory * ERC721\_\_factory * ERC721Burnable\_\_factory * ERC721Enumerable\_\_factory * ERC721URIStorage\_\_factory * ERC721Votes\_\_factory * EvmAuth\_\_factory * EvmTicket\_\_factory * ForAgainstQuorum\_\_factory * ForAgainstWeightedQuorum\_\_factory * Governor\_\_factory * GovernorCountingSimple\_\_factory * HashStore\_\_factory * IAccessControl\_\_factory * IERC1155Receiver\_\_factory * IERC165\_\_factory * IERC20\_\_factory * IERC20Metadata\_\_factory * IERC20Permit\_\_factory * IERC721\_\_factory * IERC721Enumerable\_\_factory * IERC721Metadata\_\_factory * IERC721Receiver\_\_factory * IGovernor\_\_factory * IVotes\_\_factory * Moderatable\_\_factory * Multicall2\_\_factory * Ownable\_\_factory * PhxCollectible\_\_factory * Treasury\_\_factory