Skip to content

Document how to point the SDK at a custom contract and network #21

Description

@Abioladory123

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

  • The README carries a worked example configuring the SDK against a
    self-deployed contract on testnet.
  • It covers both the network configuration and the contract id together.
  • The example has been run before the pull request is opened.

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions