Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.84 KB
Raw

Contributing to Bgl Shootout

This is a quick guide to help you contribute to Bgl Shootout.

Getting started

The root folder has a private package.json containing a few scripts and JavaScript dependencies that help generate IDLs; clients and start a local validator. First, ensure you have pnpm installed and run the following command to install the dependencies.

pnpm install

You will then have access to the following commands.

  • pnpm generate:idls - Generate IDLs for all programs, as configured in the configs/shank.cjs file.
  • pnpm generate:clients - Generate clients using Kinobi, as configured in the configs/kinobi.cjs file.
  • pnpm generate - Shortcut for pnpm generate:idls && pnpm generate:clients.
  • pnpm validator - Start a local validator using Amman, as configured in the configs/validator.cjs file.
  • pnpm validator:localnet - Same as pnpm validator.
  • pnpm validator:devnet - Start a local validator using the configs/validator.devnet.cjs file.
  • pnpm validator:mainnet - Start a local validator using the configs/validator.mainnet.cjs file.
  • pnpm validator:stop - Stop the local validator.
  • pnpm validator:logs - Show the logs of the local validator.

Managing clients

Each client has its own README with instructions on how to get started. You can find them in the clients folder.

Setting up CI/CD using GitHub actions

Most of the CI/CD should already be set up for you and the .github/.env file can be used to tweak the variables of the workflows.

However, the "Deploy JS Client" workflow — configured in .github/workflows/deploy-js.yml — requires a few more steps to work. See the CONTRIBUTING.md file of the JavaScript client for more information.