@acala-network/bodhi.js

Some tools and SDKs related to Acala EVM.

Packages:

Getting Started

initialize submodules (only need to do once after git clone)

git submodule update --init --recursive

install all dependencies

rush update

build

rush build // build all
rush build -t @acala-network/eth-rpc-adapter //  build all the things that @acala-network/eth-rpc-adapter depends on, and also @acala-network/eth-rpc-adapter itself

run build when the file changes

rush build:watch // watch all packages
rush build:watch -t @acala-network/eth-rpc-adapter //  watch all the things that @acala-network/eth-rpc-adapter depends on, and also @acala-network/eth-rpc-adapter 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

run tests with docker

clean up

# super-quickly clean up docker containers and volumes (make sure you know what you are doing)
docker compose down ; docker rm -f $(docker ps -a -q) ; docker volume rm $(docker volume ls -q)

# or more safe way to clean up only related services
docker rm -vf $(docker ps -a | grep bodhijs_subquery-node | awk '{print $1}')
docker rm -vf $(docker ps -a | grep bodhijs_graphql-engine | awk '{print $1}')
docker rm -vf $(docker ps -a | grep bodhijs_postgres | awk '{print $1}')
docker rm -vf $(docker ps -a | grep bodhijs_mandala-node | awk '{print $1}')
docker rm -vf $(docker ps -a | grep bodhijs_eth-rpc-adapter-server | awk '{print $1}')
docker rm -vf $(docker ps -a | grep bodhijs_loop | awk '{print $1}')
docker rm -vf $(docker ps -a | grep bodhijs_feed-tx | awk '{print $1}')

run tests

### build the bodhi-base image
docker build . -t bodhi-base -f docker/bodhi-base.Dockerfile

### run any test
docker-compose up --abort-on-container-exit --exit-code-from=xxx --build -- xxx

where xxx ∈ {
  eth-providers-test,
  eth-rpc-adapter-test,
  waffle-examples-test,
  waffle-tutorials-test,
  hardhat-tutorials-test,
  truffle-tutorials-test,
}

### run all tests (not recommended since log will be too messy)
docker-compose up

we can grep container logs by

docker-compose logs --tail=0 --follow   # all logs
docker logs -f <container_id>           # logs for specific container

Documentation

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

Release Workflow

manual

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

CI

Each commit to master will trigger a CI publish. However, if the version in package.json didn't change, publish won't actually go to npm ,which is fine, so we don't want a new version for each commit. So if we want an actual publish, simply change to version in package.json, then push to master.

## first bump versions and commit
node scripts/bump-version.ts
git commit -m "bump version v2.x.x"

## tag the commit and push
git tag v2.x.x
git push origin v2.x.x

stwiname / bodhi.js