DocumentationBuild on Note

Integration Checklist

Documentation snapshot 28 October 2026. Deployment · Audit Status
On this page

Work through every row that applies to your integration route. The two-column checklists can be read without horizontal scrolling.

Addresses and ABIs

fact Addresses and ABIs
CheckHow
Addresses pinned per chain idCopy from Addresses; refuse to run against an address that fails the explorer's verification
ABIs from the tagged sourceforge build in contracts/ at the release tag the address table names
Vault set boundvault.mandate(), vault.adapter(), adapter.vault() and mandate.vault() agree
SDK release pinnedInstalled from https://note.systems/sdk/<file>.tgz; lockfile integrity equals the integrity in latest.json; lockfile committed
SDK matches the chainfactory.codeMatches() true and vaults.verifyBinding(vault) true at start-up on the chain id you ship

Units

fact Units Reference
CheckHow
USDG amounts in 6 decimalsRead asset().decimals(); never hard-code
Vault shares in 18 decimalsvault.decimals(); one share is one USDG at inception
Prices in 1e8s0, lastPrice and feed answers
Stock in 18 decimalsRaw balances, not balanceOfUI

Reads

fact Reads Reference
CheckHow
Every list is pagedvaults(start, count), requestsOf(owner, start, count), openSeriesOf(underlying)
Nothing self reportedCoupons from accruedCoupon, terms and fees from getSeries, vault mandate from mandate.*
Previews before signaturespreviewDeposit, previewRedeem, previewWrap, previewUnwrap, requiredPrefund
Staleness shownSurface the series feed's updatedAt; a vault will not value breach stock from a feed older than PRICE_MAX_AGE (1 day)

States

fact States Reference
CheckHow
Pausedmandate.paused(); deposits and allocations revert, exits still work
QueueRender Request.filledAssets − claimedAssets as claimable and the rest as pending
BreachA series below barrier at maturity delivers stock; show the stock amount, not only the USDG figure
Under-matchedRefund path (core.refund) for the unmatched part of a subscription

Disclosures

fact Disclosures Reference
CheckHow
Stock TokensNot available to US persons; carry the issuer's notice
Structured notes can lose valueState the breach outcome next to the coupon
MarksPartner marks identify the network or product and imply no endorsement

Before You Announce

  • Verified addresses and audit hashes pinned in your release notes.
  • SDK version and tarball sha512 pinned in your release notes.
  • One deposit and one exit exercised on testnet from your interface.
  • Partner id registered on the mandate and visible through mandate.partner(id).
  • Contact: info@note.systems.
A little more clarity?

Keep exploring, or revisit this topic from the navigation.