@inverter-network/abis
v0.2.6
Published
INVERTER typescript ABIs
Downloads
1,248
Maintainers
Readme
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
- 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.
- PR with changes
- Merge PR into main
- Checkout main
git pull
bun release: '' | alpha | beta
optionally add-- --release-as minor | major
- Make sure everything looks good (e.g. in CHANGELOG.md)
- Lastly follow the instructions given by release log
- Done
Summary
This package contains ABI Bundling scipts and the typescript ABIs themselves for INVERTER projects.