Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

@koed_jang/apyx-sdk

A compact viem-based TypeScript SDK and CLI for the Apyx protocol — apxUSD (yield-bearing stablecoin) and apyUSD (ERC-4626 vault) on Ethereum and Base.

This book is the user manual. It covers everything you need to read on-chain state, send transactions, run the CLI, and integrate the SDK into a frontend or a backend script.

What you’ll find here

  • Getting Started — install the package and read your first value.
  • SDK Reference — every public export from @koed_jang/apyx-sdk.
  • CLI Reference — apyx command, configuration, REPL, and per-command pages for all 21 contract methods.
  • Recipes — copy-pasteable end-to-end walkthroughs.
  • Playground — the in-browser test harness in example/.
  • Development — repo layout, testing, and release workflow.

Status

Prototype. The package is published on npm under the prototype dist-tag:

pnpm add @koed_jang/apyx-sdk@prototype viem

Public API surface and contract addresses may change before the first stable release. See the Releasing chapter for the versioning policy.

Hosting

This site lives at https://dead-pool-aka-wilson.github.io/apyx-sdk-docs/ and is published from a separate public repo (apyx-sdk-docs) because the SDK source repo is private and GitHub Pages does not serve from private repos on the free tier.

Source

The book is generated from Markdown in book/src/ in the private SDK repo. Every page has an “Edit this page” link that opens the source on GitHub.