https://github.com/inverternetwork/abis

https://github.com/inverternetwork/abis

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/inverternetwork/abis
• Owner: InverterNetwork
• License: lgpl-3.0
• Created: 2023-12-12T14:39:19.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-30T00:19:36.000Z (2 months ago)
• Last Synced: 2024-10-30T02:49:52.106Z (2 months ago)
• Language: TypeScript
• Size: 1.41 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


[![license](https://img.shields.io/badge/License-LGPL%20v3-blue)](/LICENSE.md)

[![npm latest package](https://img.shields.io/npm/v/@inverter-network/abis/latest.svg)](https://www.npmjs.com/package/@inverter-network/abis)

[![npm downloads](https://img.shields.io/npm/dm/@inverter-network/abis.svg)](https://www.npmjs.com/package/@inverter-network/abis)

[![Follow on Twitter](https://img.shields.io/twitter/follow/inverternetwork.svg?label=follow+INVERTER)](https://twitter.com/inverternetwork)



## Inverter / ABIs

Bun + Npm + ABI Bundler = Type Safe ABIs

## Summary

This package contains ABI Bundling scipts and the typescript ABIs themselves for [INVERTER](https://github.com/InverterNetwork).

Learn more about INVERTER on (https://inverter.network).

Check out the [Changelog](./CHANGELOG.md) to see what changed in the last releases.

## Install dependencies

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

```bash

# Supported on macOS, Linux, and WSL

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

# Upgrade Bun every once in a while

bun upgrage

```

Install dependencies:

```bash

bun add @inverter-network/abis

```

or

```bash

npm install @inverter-network/abis

```

## Developing

### Requirements

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

### Install Dependencies

```bash

bun install

```

### Watching TS Problems

```bash

bun watch

```

### Updating the ABIs

1. Update the deployments submodules in the `deployments` directory.

```bash

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](https://github.com/InverterNetwork).