Skip to content

PaintSwap/sonic-airdrop-definitions

Repository files navigation

Sonic Airdrop Types & Constants (sonic-airdrop-definitions)

Sonic Airdrop types and constants available for Javascript,

TypeScript, and AssemblyScript / WebAssembly.

The items in this library will allow you to interact with Sonic Airdrop via:

  • Vanilla JS applications
  • React, Angular, and other frontend frameworks
  • NodeJS / Typescript back end services
  • AssemblyScript / WebAssembly for use with The Graph Protocol's web3 indexing

NPMJS Package

Usage

If using a private repo, you may need to login first:

npm login

To use Sonic Airdrop types and constants in your project, first import the dev dependency:

npm install -D @paintswap/sonic-airdrop-definitions
yarn add -D @paintswap/sonic-airdrop-definitions

Once installed, the SonicAirdropConstants, SonicAirdropTypes, and NONE type will be exposed. You can then access the individual types from their parent.

import { SonicAirdropConstants, SonicAirdropTypes, NONE } from '@paintswap/sonic-airdrop-definitions'
const { Order, PriceLevel } = SonicAirdropTypes

It is also possible to import specific items directly.

import { Order, PriceLevel } from '@paintswap/sonic-airdrop-definitions/types'

Development

Build

npm run build
yarn build

Use Locally

NPM

From library root:

npm link

From project root:

npm link @paintswap/sonic-airdrop-definitions

Yarn

From library root:

yarn link

From project root:

yarn link @paintswap/sonic-airdrop-definitions

Yalc

Install yalc

npm install -g yalc@latest
yarn add -g yalc@latest

From library root:

yalc publish

From project root:

yalc add @paintswap/sonic-airdrop-definitions

Use newly published updates to local yalc repository.

yalc update

Revert to NPM Repository

yalc remove @paintswap/sonic-airdrop-definitions
yarn add @paintswap/sonic-airdrop-definitions

Manual Publish to NPM (--access=public needed the first time)

npm publish
yarn publish

Via github CI

  1. Push any changes to github
  2. Create a new release version with yarn version
  3. It will tag and push to Github which will trigger the CI to publish to NPM

About

Definition library for the Sonic Airdrop Marketplace

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors