https://github.com/inverternetwork/sdk

https://github.com/inverternetwork/sdk

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/inverternetwork/sdk
• Owner: InverterNetwork
• License: lgpl-3.0
• Created: 2024-02-12T16:26:31.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-08-18T18:33:32.000Z (10 months ago)
• Last Synced: 2025-08-18T20:37:12.279Z (10 months ago)
• Language: TypeScript
• Size: 2.21 MB
• Stars: 6
• Watchers: 2
• Forks: 1
• 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/sdk/latest.svg)](https://www.npmjs.com/package/@inverter-network/sdk)

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

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



## Inverter / TS SDK

Bun + Npm + Type Safe Formatted Functions

## Summary

This package contains abstracted functions for the inverter contract functions compiled for typescript [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/sdk

```

or

```bash

npm install @inverter-network/sdk

```

## 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 abstracted functions for the inverter contract functions compiled for typescript [INVERTER projects](https://github.com/InverterNetwork).