API reference
API reference
Every function and type the SDK exports, each documented once, generated from its TSDoc.
This section documents everything @umbra/nimbus-solana-web exports. Each function has one entry,
with its signature, an example, its parameters and what it returns. Each entry is generated from the
SDK's declarations and TSDoc when this site is built, so it matches the package.
The guides show how the functions fit together. This section is where you look one up. Every mention of an export elsewhere on the site links to its entry here.
Functions
| Export | What it does |
|---|---|
loadNimbusSdk | Loads the SDK for a cluster. Every other call starts from what it returns. |
listWallets | Lists the installed wallets that can sign on the cluster. |
followWallets | Calls you with the new list each time a wallet registers or unregisters. |
openWalletConnection | Connects a wallet and returns the signer a session takes. |
openNimbusSession | Opens the user's private account on this device. |
closeNimbusSession | Clears a session's keys and gateway token from memory. |
createMemorySignatureSecretStore | Keeps the unlock signature in the page's memory only. |
createTabSignatureSecretStore | Keeps the unlock signature for the tab. This is the default. |
createPersistentSignatureSecretStore | Keeps the unlock signature in the browser until it is wiped. |
readRegistration | Reads whether the user is registered now. |
createRegistrationContext | Creates the context a registration runs in. |
register | Registers the user, once, before their first deposit. |
createDepositContext | Creates the context a deposit runs in. |
deposit | Moves tokens from the wallet into a private balance. |
resolvePendingDeposit | Learns how a deposit whose outcome was unknown ended. |
refundStrandedDeposit | Returns funds a version 0 deposit left halfway. |
createTransferContext | Creates the context a Private Send runs in. |
transfer | Pays another user from the private balance. |
createWithdrawalContext | Creates the context a withdrawal runs in. |
withdraw | Moves tokens out of the private balance to any address. |
readBalances | Reads the private balance from the device. |
readHistory | Reads past payments, one page at a time. |
syncNoteStore | Brings the device up to date with Solana. |
listReservedSpends | Lists the payments that hold part of the balance. |
releaseReservedNotes | Gives back what stopped payments hold. |
findMintByIdentifier | Names the token of a history item. |
NimbusSdkError | The error the SDK throws when it cannot go on. |
isNimbusSdkError | Recognises a NimbusSdkError. |
isNimbusSolanaFlowError | Recognises the protocol's refusals. |
proveWorkerRequest | Answers a proof request inside a prover worker of your own. |
copy-assets | The command that copies the SDK's browser files into your app. |
Types
Types lists every exported type in alphabetical order. Here they are grouped by what they describe.
The SDK also exports Wallet, the Wallet Standard's own type.
Next
Last updated