@astariaxyz/sdk

Astaria SDK ✨

Note: This package is in alpha. The API is subject to change without notice.

Internal Development Notes (to be removed):

• Open Pull Requests against develop branch until stable v1.0.0 release.
• When adding ABI files, run yarn typechain:compile and commit generated typescript bindings.
• Follow conventional commit specification for commit messages.

This library aims to handle functions that are core to the Astaria architecture and facilitate interaction with our smart contracts.

• Installation
• API
• Contributing
• Development
  • Prerequisites
  • Setup
  • Watch Build
  • Running Tests
  • Versioning
• License

Installation

To install and set up the library, run:

$ yarn add @astariaxyz/sdk@alpha

Or if you prefer using npm:

$ npm install --save @astariaxyz/sdk@alpha

API

Coming soon™

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

1. Fork it!
2. Create your feature branch: git checkout -b feat/my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am 'feat: Add some feature'
5. Push to the branch: git push origin feat/my-new-feature
6. Submit a pull request 😎

Prerequisites

This project requires Node version 18.x or later. We recommend using yarn v1 as your package manager, but npm should work without issue. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v && yarn -v

8.5.0
v18.18.0
1.22.15

Setup

BEFORE YOU INSTALL: please read the prerequisites above.

Start with cloning this repo on your local machine:

$ git clone https://github.com/astariaxyz/astaria-sdk.git
$ cd astaria-sdk

Then install dependencies:

$ yarn
$ cd astaria-sdk

Watch Build

This will automatically watch for changes and rebuild the app.

$ yarn start

Running Tests

$ yarn test

Watch tests:

$ yarn test:watch

Versioning

We use semantic versioning for versioning. For the versions available, see the tags and releases on this repository.

License

MIT License © Astaria