For Developers of the SDK

zk-circuits
frontend using React for UI display
on-chain contracts for storing final game statesd

Setup

Each component has its own README.md under each folder. Follow the setups there.

Build

npm run build

Testing NPX Commands Locally

Install the packge outside the zk-sdk directory

npm i -g ../<path to zk-sdk>

Build the package after every change

npm run build

[troubleshooting]

npm -g uninstall spin

Testing

Testing the SDK and SDK itself should be separate.

Tests located in tests/ folder.

Unit testing process

... TODO

Integration testing process

Use npx spin to install the package locally.
Copy over test specific files
Run spin end-to-end

cd tests/integration

Build image npm run build

Run local spin npm exec -- spin ...

Publishing

npm publish