Build on Note
On this page
Note is a permissionless structuring desk on Robinhood Chain. Other products can embed vaults, distribute notes or lend against wrapped legs. Partner fee attribution is available only through eligible vault deposits; direct note distribution and credit do not carry a partner id. The Build on Note page gives the visual tour; this section is the reference.
Three Ways In
| Depth | What your product does | Contract calls | Status |
|---|---|---|---|
| Embed a vault | One ERC-4626 deposit. The vault allocates across in-band series, harvests coupons and fills redemptions at one share price | deposit, requestRedeem, claimRedeem, previewDeposit | live on testnet |
| Distribute notes | Surface live series and let users pick a COUPON or SHIELD leg; the desk fills at the discovered coupon | openSeriesOf, getSeries, depositCoupon, accruedCoupon, claim, redeem | live on testnet |
| Lend against legs | Wrap COUPON legs into ERC-20 collateral and post them to a Credit market | wrap, harvest, unwrap | live on testnet |
What Every Depth Has in Common
- Nothing is self reported. Coupons, barriers, observations and fees are read from
NoteCoreandRollPolicy. Your interface renders what the contracts enforce. - No custody. Deposits go to the protocol’s escrow or to a vault the depositor holds shares in. Your product never holds user funds.
- Bounded reads. Every list is paged (
vaults(start, count),requestsOf(owner, start, count),openSeriesOf(underlying)), so a wallet can render positions without an indexer. - Vault-only attribution. Eligible vault deposits can carry a registered
partnerId. Fees attributable to tagged shares are allocated to the configured payee when fees are collected. Direct note and credit integrations do not use this field. See Economics.
The SDK
TypeScript integrations use @note-systems/sdk, a typed client over viem covering the vault depth end to end: discover, verify, quote, deposit with attribution, track, exit, create. Releases are tarballs served from note.systems/sdk/ with a published sha512, and npm pins the integrity in your lockfile.
npm install viem https://note.systems/sdk/note-systems-sdk-0.1.2.tgz
The SDK guide covers the client, the releases table the digests, and examples/partner-integration.ts inside the package walks the six steps against testnet.
Where to Start
- Read Economics to see what an integration earns and how the treasury share works.
- Pick a depth and follow its guide. For the vault depth in TypeScript, install the SDK above and run the bundled example against testnet.
- Run the checklist before you ship.
Addresses for every network are on the Addresses page; audits are listed under Security.
Keep exploring, or revisit this topic from the navigation.