The Fluton SDK is not published to npm yet. It will ship as
@fluton/sdk.
These pages describe the pool client as it exists today and the intent client as it is planned.- The pool client exists today. It covers notes and keys, tree rebuild and note discovery, proving, deposits, obligations and claims, private transfers, and the relayer and indexer clients of Fluton Pool. Keys, notes and scanning and Deposits, withdrawals and transfers walk through it, and the Pool client reference lists every export.
- The intent client is planned. A
FlutonClientwill create intents, request quotes, stream offers and execute the selected offer across chains, with React bindings on top. Intent client (planned) describes that interface ahead of its release.
@noble/ciphers, @noble/curves and @noble/hashes packages supply the pure crypto, and the confidential (eTOKEN) side uses @cofhe/sdk. circomlibjs provides the circomlib-generated Poseidon bytecode that runs on-chain.
Entry points
The pool client has two entry points, and the difference is what each may import:- @fluton/sdk (node)
- @fluton/sdk/browser
The full surface. It includes the snarkjs-backed proving flows (
proof, transact) and the node CoFHE client (cofheNode).@fluton/sdk/react for hooks and providers, and @fluton/sdk/viem and @fluton/sdk/ethers as optional adapter helpers.
Modules
One line per module of the pool client, withinputs (the one module the browser entry point exports directly) in its place. The last column says which entry points carry the module; the pages linked here document its functions, and the Pool client reference lists each export.
Where to go next
Keys, notes and scanning
Derive a spend key, hand out an address or a view key, and discover the notes a key owns.
Deposits, withdrawals and transfers
Build, prove, relay and read back every kind of transaction.
Pool client reference
Every export of the pool client, module by module, with its signature.
Intent client (planned)
The cross-chain intent interface the SDK will add: quotes, offers, execution and React bindings.