Getting Started

The Union Client is TypeScript-first and framework agnostic. At app.union.build we use Svelte, but you can use any framework or no frameworks at all.

If you’re a React developer, checkout this demo on Stackblitz.

Note

If you need testnet tokens for testing, visit https://app.union.build/faucet and do some shopping.

Installation

pnpm

pnpm add @unionlabs/sdk@^2.0.0-beta.0

yarn

yarn add @unionlabs/sdk@^2.0.0-beta.0

npm

npm install @unionlabs/sdk@^2.0.0-beta.0

Peer Dependencies

Ensure peer dependencies are satisfied by your package manager. pnpm is recommended for its firt-party support for enforcing strict peer dependencies and protection against phantom dependencies and NPM dopplegangers.

Required

• effect: for execution of SDK defined programs

Optional

• viem: for EVM usage
• @cosmjs/stargate: for Cosmos usage
• @mysten/sui: for Sui usage

Examples

See examples in the sidebar.

API Documentation

See the @unionlabs/sdk API documentation, which is autogenerated and organized by module.