/setters.js

The Setters.JS SDK of Setheum.JS is a web3 provider that lets existing Ethereum dApps interact with the Setheum-EVM (SEVM)

Primary LanguageTypeScriptApache License 2.0Apache-2.0

{setters.js}

The Setters.JS SDK of Setheum.JS is a web3 provider that lets existing Ethereum dApps interact with the SetheumEVM (SEVM).

Packages:

Getting Started

  • install all dependencies
rush update
  • build
rush build // build all
rush build --to @setheum.js/eth-rpc-adaptor //  build all the things that @setheum.js/eth-rpc-adaptor depends on, and also @setheum.js/eth-rpc-adaptor itself
  • run build when the file changes
rush build:watch // watch all packages
rush build:watch --to @setheum.js/eth-rpc-adaptor //  watch all the things that @setheum.js/eth-rpc-adaptor depends on, and also @setheum.js/eth-rpc-adaptor itself
  • run a script defined in project's package.json
cd <project>
rushx <script-name>
  • add pacakge
rush add -p <package> --all             # for all projects
cd <project> && rush add -p <package>   # for this project only

Documentation

  • This project is managed by Rushstack.
  • Most of the api of setters.js is compatible with ethers.js.

Release Workflow

manual

## first let rush determine what projects were changed
rush change --bulk --message "version x.x.x" --bump-type "patch"

## build
rush build

## publish
rush publish -p --set-access-level public -n <paste_npm_token_here>

CI (deprecated, rush has some different workflow)

In order to trigger a auto release, we need to tag the commit with 'v*', any other commit won't trigger the auto publish. Also, remember to update the version fields in package.json, otherwise publishing will fail.

For example

git commit -m "bump version to v2.0.8-beta"
git tag v2.0.8-beta

# push code, this won't trigger CI
# if this creates a pull request, make sure to merge it before push tag
git push

# push the tag, this will trigger CI auto release
# do this after the code is actually merged
git push origin v2.0.8-beta

This Version - Setters-v2.2.0

  • Setheum Node Release v1.0.0
  • setheum.js/* v3.3.1
  • setters.js v2.2.0
  • Setters v1.0.0
  • EthProviders v2.2.0
  • EthRpcAdapter v2.0.0
  • EthTransactions v2.1.4
  • EvmSubQL v0.0.1
  • examples/* v1.0.0