README.md

Inverter / ABIs

Bun + Npm + ABI Bundler = Type Safe ABIs

Summary

This package contains ABI Bundling scipts and the typescript ABIs themselves for INVERTER. Learn more about INVERTER on (https://inverter.network).

Check out the Changelog to see what changed in the last releases.

Install dependencies

Install Bun ( bun is used for testing for primitives no bun is needed ):

# Supported on macOS, Linux, and WSL

curl -fsSL https://bun.sh/install | bash

# Upgrade Bun every once in a while

bun upgrage

Install dependencies:

bun add @inverter-network/abis

or

npm install @inverter-network/abis

Developing

Requirements

The following packages need to be installed globally for the husky hooks to work: prettier

Install Dependencies

bun install

Watching TS Problems

bun watch

Updating the ABIs

1. Update the deployments submodules in the deployments directory.

bun compile

How to make a release

For the Maintainer: Add NPM_TOKEN to the GitHub Secrets.

1. PR with changes
2. Merge PR into main
3. Checkout main
4. git pull
5. bun release: '' | alpha | beta optionally add -- --release-as minor | major
6. Make sure everything looks good (e.g. in CHANGELOG.md)
7. Lastly follow the instructions given by release log
8. Done

Summary

This package contains ABI Bundling scipts and the typescript ABIs themselves for INVERTER projects.