Change examples, docs and tests to use braga instead of kaolin#56
Merged
Conversation
krzysiekfonal
approved these changes
May 6, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the SDK’s examples and documentation to use the braga chain (Arkiv testnet) instead of kaolin, aligning smoke tests, sample scripts, and README snippets with the newer default network reference.
Changes:
- Switched smoke-test scripts (TS/ESM/CJS) from
kaolintobraga. - Updated public/wallet client and action JSDoc examples to reference
braga. - Updated README and sample
read_example.ts/write_example.tsto usebraga(including faucet URL).
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| test/src/smoke-tests/index.ts | Use braga chain in TS smoke test. |
| test/src/smoke-tests/index.mjs | Use braga chain in ESM smoke test. |
| test/src/smoke-tests/index.js | Use braga chain in JS smoke test. |
| test/src/smoke-tests/index.cjs | Use braga chain in CJS smoke test. |
| src/clients/decorators/arkivWallet.ts | Update wallet action docs examples to braga (noted one example still uses a public client). |
| src/clients/decorators/arkivPublic.ts | Update public action docs examples to braga. |
| src/clients/createWalletClient.ts | Update top-level wallet client docs to braga (noted doc text/example inconsistencies). |
| src/clients/createPublicClient.ts | Update top-level public client docs to braga (noted RPC URL inconsistency). |
| sample/write_example.ts | Update write sample to use braga. |
| sample/read_example.ts | Update read sample to use braga. |
| README.md | Update README examples and faucet reference to braga. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * - Docs: https://docs.arkiv.network/ts-sdk/clients/public | ||
| * | ||
| * A Public Client is an interface to "public" [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/), [Arkiv JSON-RPC API](https://docs.arkiv.network/json-rpc/), and [Kaolin JSON-RPC API](https://kaolin.holesky.arkiv.network/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction). | ||
| * A Public Client is an interface to "public" [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/), [Arkiv JSON-RPC API](https://docs.arkiv.network/json-rpc/), and [Braga JSON-RPC API](https://braga.holesky.arkiv.network/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction). |
Comment on lines
25
to
+30
| /** | ||
| * Creates a Public Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains). | ||
| * | ||
| * - Docs: https://docs.arkiv.network/ts-sdk/clients/public | ||
| * | ||
| * A Public Client is an interface to "public" [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/), [Arkiv JSON-RPC API](https://docs.arkiv.network/json-rpc/), and [Kaolin JSON-RPC API](https://kaolin.holesky.arkiv.network/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction). | ||
| * A Public Client is an interface to "public" [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/), [Arkiv JSON-RPC API](https://docs.arkiv.network/json-rpc/), and [Braga JSON-RPC API](https://braga.holesky.arkiv.network/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction). |
Comment on lines
35
to
+40
| * @example | ||
| * import { createPublicClient, http } from 'arkiv' | ||
| * import { kaolin } from 'arkiv/chains' | ||
| * import { braga } from 'arkiv/chains' | ||
| * | ||
| * const client = createPublicClient({ | ||
| * chain: kaolin, | ||
| * chain: braga, |
Comment on lines
59
to
+64
| * @example | ||
| * import { createPublicClient, http } from 'arkiv' | ||
| * import { kaolin } from 'arkiv/chains' | ||
| * import { braga } from 'arkiv/chains' | ||
| * | ||
| * const client = createPublicClient({ | ||
| * chain: kaolin, | ||
| * chain: braga, |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.