https://github.com/xgodmode/contract-library
Smart contracts and solc Solidity compiler for XGM godmode
https://github.com/xgodmode/contract-library
godmode smart-contracts solc solidity xgm
Last synced: 10 months ago
JSON representation
Smart contracts and solc Solidity compiler for XGM godmode
- Host: GitHub
- URL: https://github.com/xgodmode/contract-library
- Owner: xGodMode
- Created: 2021-01-03T04:45:17.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-28T07:12:46.000Z (almost 5 years ago)
- Last Synced: 2025-03-10T01:13:44.870Z (about 1 year ago)
- Topics: godmode, smart-contracts, solc, solidity, xgm
- Language: Solidity
- Homepage: https://godmode.cloud
- Size: 513 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Godmode Contract Library holds plug-and-play Godmode versions of smart contracts
deployed on Ethereum mainnet.
You can use this package to easily import GM contracts from individual (or all) protocols we support into your test suite.
## Usage
In your project that uses Godmode for testing, define the protocols that you
want to pull in via your `package.json` file
```json
"godmode": {
"protocols": [
"Maker"
]
}
```
Then run the following command to install the protocol's contracts into your project at `./build/protocols`
> Make sure you run the npx command from the same directory where your `package.json` lives.
```sh
npx install godmode
```
## Development
Start by installing dependencies:
```
npm install
```
Then to add a new protocol:
1. Create a directory called `` under the appropriate EVM version ("byzantium"|"constantinople"|"istanbul")
1. Add the required Solidity files to the directory
1. **IMPORTANT!!** Prefix the GM-ified contracts with `GM` (e.g. GMDai)
1. Run the compile command
```
npm run compile
```
5. Check that the `.json` file includes the ABI and bytecode of the GM contracts
6. Check that the `protocols.txt` file includes the name of the protocol you added