Summary
networkFromEnv exists for supplying a custom RPC URL, passphrase and token
address, and the README's environment variable section lists the values. What is
missing is the short worked path a contributor actually needs: deploy your own
contract, point the SDK at it, and read a jar back.
That is the first thing anyone developing against this package locally has to
do, and it is currently assembled from three separate sections.
Acceptance criteria
Getting started
Fork this repository, clone your fork, and add this repo as upstream:
git clone https://github.com/<your-username>/novatip-sdk.git
cd novatip-sdk
git remote add upstream https://github.com/Novatip/novatip-sdk.git
npm install
Create a branch for this issue:
git checkout -b docs/custom-network-guide
Suggested commit message:
docs: document custom contract and network setup
Run npm run lint, npm run typecheck, and npm run build before pushing, then open a pull request from your fork against main and link this issue. See the contributing guide for the full workflow.
Summary
networkFromEnvexists for supplying a custom RPC URL, passphrase and tokenaddress, and the README's environment variable section lists the values. What is
missing is the short worked path a contributor actually needs: deploy your own
contract, point the SDK at it, and read a jar back.
That is the first thing anyone developing against this package locally has to
do, and it is currently assembled from three separate sections.
Acceptance criteria
self-deployed contract on testnet.
Getting started
Fork this repository, clone your fork, and add this repo as
upstream:Create a branch for this issue:
Suggested commit message:
Run
npm run lint,npm run typecheck, andnpm run buildbefore pushing, then open a pull request from your fork againstmainand link this issue. See the contributing guide for the full workflow.