@sendgft/contracts

gft.xyz Smart contracts.

How to use

Install the package:

npm install @sendgft/contracts

The package exposes the following properties:

• contracts - the key contracts JSON artifact contents
• addresses - contents of deployedAddresses.json
• events - ABIs for events to listen for

Example

const ethers = require('ethers')
const { contracts, addresses } = require('@sendgft/contracts')

const contract = new ethers.Contract(
  addresses.Gifter.chains[4].address, // rinkeby
  contracts.GifterV1.abi
)

Development

Requirements:

• Node.js 14.18.0+
• Yarn 1.22.10+ (use npm i -g yarn once Node.js is installed)

Copy .env.sample to .env and fill in the values (available in our password vault).

Install dependencies:

yarn

Initialize git submodules (for maker-otc trading engine):

git submodule init
git submodule update

First, run the dev network in a separate terminal:

yarn devnet

Compile the contracts:

yarn compile

Setup the deployment config (only need to run this once):

yarn setup-deploy-config:local

Now deploy the contracts to it:

yarn deploy:local

Now you can run the tests:

yarn test

To run a single test:

yarn test ./test/testName.js --network test

Deployments

We use the same wallet on every network to deploy from. Deployment always happens at the same wallet nonce so that our contract addresses are the same on every network.

The deployment script will check to ensure that the wallet nonce is at the expected number prior to deploying. Once the contracts are deployed on a given network, subsequent deployments will simply result in an upgrade call.

Set up the env vars:

export MNEMONIC="..."
export INFURA_KEY="..."
export PINATA_API_KEY="..."
export PINATA_SECRET="..."

To deploy Rinkeby contracts:

yarn setup-deploy-config:rinkeby
yarn deploy:rinkeby

Publishing

Ensure you deploy the contracts first (see above) so that deployedAddresses.json is updated.

Commit the code and push the changes.

Then run:

yarn release

License

MIT (see LICENSE.md)