@inaya-network/custody-sdk

Client-side cryptographic sovereignty SDK for Inaya Network — encrypt, shard, anchor, and reconstruct files against BNB Chain Testnet, with full TypeScript support and a client for the card-payment (no-wallet) flow.

Full documentation lives in SDK_GUIDE.md — quick starts, error handling, retry behavior, the Metadata (rename/move/delete/folders/sharing) client, TypeScript usage, testing, and known limitations. This file is just the front door.

Install

npm install @inaya-network/custody-sdk ethers

Live on the public npm registry, published under both latest and beta dist-tags (1.0.7-beta) — see SDK_GUIDE.md §1 for the GitHub-install alternative if you'd rather track a specific commit. ethers (v6) is a peer dependency.

30-second example

import { InayaKernel } from "@inaya-network/custody-sdk";

const connection = await InayaKernel.connectWallet();
const salt = InayaKernel.generateSecureSalt(16);
const vaultKey = await InayaKernel.deriveVaultKey({ passkey: "user-supplied-passkey", salt });
const sharded = await InayaKernel.disperseAndSlice({ file, encryptionKey: vaultKey });

// Pin sharded.shardAlpha / sharded.shardBeta to IPFS yourself, then:
await InayaKernel.approveFeeTokens({ connection, fileSizeBytes: file.size });
const receipt = await InayaKernel.anchorToLedger({
  connection,
  fileName: sharded.filename,
  fileSizeBytes: file.size,
  dataShardAlpha: cidAlpha,
  dataShardBeta: cidBeta,
});

See SDK_GUIDE.md §3 for the full walkthrough, including retrieval.

What's in here

• Crypto (src/crypto.js) — client-side AES-GCM-256 encryption and binary sharding. Pure JS (@noble/hashes + @noble/ciphers), works in browsers, Node.js, and React Native alike.
• On-chain (src/index.js) — wraps the deployed InayaCustody and InayaStaking contracts. Dual-mode: browser wallet or a server-held ethers.Wallet.
• Payments (src/payments.js) — a typed client for the card-payment (no-wallet) backend routes.
• Metadata (src/metadata.js) — rename/move/delete, virtual folders, and sharing — an off-chain layer authenticated by wallet signatures, since the on-chain contract itself is write-once.
• Backup (src/backup.js) — replica redundancy status/health/recovery for your uploaded shards across independent pinning providers. Not to be confused with createPasskeyBackup/restorePasskeyBackup (a separate, local-only pair of functions that back up your passkey, not file data — see SDK_GUIDE.md §15).
• AppStore (src/appStore.js) — submit your own app to Inaya's Web3 App Store (submitListing), check your submission's review status (getMyListings), or browse what's already public (getListings). Every submission is wallet-signed and reviewed by an admin before it's public — see SDK_GUIDE.md §16. Pair it with inaya deploy (below) to pin a whole static site to IPFS and submit it in one command.

Runnable examples for React (upload, staking, file management), Next.js (all three backend clients), and plain Node.js are in examples/.

The wider ecosystem

This repo is also a monorepo for the tooling built on top of the SDK — see packages/ for @inaya-network/react (drop-in UI components), inaya-cli (terminal/CI-CD tool — including inaya deploy <path>, which pins a local static site directory to IPFS via your own Pinata account and submits it to the App Store for review), and create-inaya-dapp (project scaffolding). All three are published and installable now:

npm install @inaya-network/react
npm install -g inaya-cli
npx create-inaya-dapp my-app

Component documentation lives in a live Storybook, auto-deployed from packages/react on every push.

Contributing

Bug reports, feature requests, and pull requests are welcome — see CONTRIBUTING.md for how this repo is organized and what a good PR looks like. Please also read the Code of Conduct. Issues labeled good first issue are a good place to start.

License

MIT