https://github.com/openzeppelin/openzeppelin-contract-loader
Load contract ABIs from built artifacts and return contract objects
https://github.com/openzeppelin/openzeppelin-contract-loader
Last synced: about 1 year ago
JSON representation
Load contract ABIs from built artifacts and return contract objects
- Host: GitHub
- URL: https://github.com/openzeppelin/openzeppelin-contract-loader
- Owner: OpenZeppelin
- License: mit
- Created: 2019-09-12T19:52:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-27T15:06:31.000Z (almost 3 years ago)
- Last Synced: 2025-03-19T17:11:11.567Z (about 1 year ago)
- Language: JavaScript
- Size: 1.18 MB
- Stars: 14
- Watchers: 16
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
> :warning: **This project is not being actively maintained.**
# OpenZeppelin Contract Loader
[](https://docs.openzeppelin.com/contract-loader)
[](https://www.npmjs.org/package/@openzeppelin/contract-loader)
[](https://circleci.com/gh/OpenZeppelin/openzeppelin-contract-loader)
**Load contract objects from built artifacts or ABIs.** Includes support for both `web3-eth-contract` and `@truffle/contract` objects.
```javascript
const { setupLoader } = require('@openzeppelin/contract-loader');
const loader = setupLoader({ provider: new Web3('http://localhost:8545') }).web3;
const address = '0xCfEB869F69431e42cdB54A4F4f105C19C080A601';
const erc20 = loader.fromArtifact('ERC20', address);
const totalSupply = await token.methods.totalSupply().call();
```
## Overview
### Installation
```bash
npm install @openzeppelin/contract-loader
```
You may also need to install [`web3-eth-contract`](https://www.npmjs.com/package/web3-eth-contract) or [`@truffle/contract`](https://www.npmjs.com/package/@truffle/contract), depending on which abstractions you want to be able to load.
>Contract Loader requires access to the filesystem to read contract ABIs. Because of this, it will not work in a browser-based Dapp.
### Usage
Create a loader object:
```javascript
const { setupLoader } = require('@openzeppelin/contract-loader');
const loader = setupLoader({
provider, // either a web3 provider or a web3 instance
defaultSender, // optional
defaultGas, // optional, defaults to 8 million
});
```
Load web3 contracts:
```javascript
const ERC20 = loader.web3.fromArtifact('ERC20');
// Deploy contract
const token = await ERC20.deploy().send();
// Send transactions and query state
const balance = await token.methods.balanceOf(sender).call();
await token.methods.transfer(receiver, balance).send({ from: sender });
```
Load Truffle contracts:
```javascript
const ERC20 = loader.truffle.fromArtifact('ERC20');
// Deploy contract
const token = await ERC20.new();
// Send transactions and query state
const balance = await token.balanceOf(sender);
await token.transfer(receiver, balance, { from: sender });
```
## Learn More
* For detailed usage information, take a look at the [API Reference](https://docs.openzeppelin.com/contract-loader/api).
## License
[MIT](LICENSE).