Skip to documentation
Reality-grade bankingDocumentationOpen implementation
Documentation contents

Build

Start with the Receiz SDK

Run a no-money local example, inspect the exact package surface, then compose a source-bound operation.

Reviewed 2026-10-25 · SDK 129.0.0Read Markdown ↗

Install the documented release

In your own project. The docs app itself does not need this dependency.
npm install @receiz/sdk@129.0.0

Use an ES module project and a supported modern Node runtime for the local examples; the Bank repository’s native-source tooling documents Node 24 or newer. Package release, schema generation and constitutional ruleset are separate version coordinates. Do not infer an arbitrary deployed host’s capabilities from a local install.

Run a local synthetic exercise

Save as sdk-sandbox.mjs and run node sdk-sandbox.mjs. No production identity or money is used.
// Local synthetic exercise only: no production identity, money or proof authority.
import {createReceizClient, RECEIZ_SDK_VERSION} from '@receiz/sdk';
import {createReceizEmulator, runReceizConformance} from '@receiz/sdk/testing';
const client=createReceizClient();
const capabilities=await client.capabilities.describe();
const emulator=createReceizEmulator({seed:'docs-no-money',startTimeMs:1700000000000});
const owner=emulator.identity.create('reader');
const record=emulator.proof.record({ownerId:owner.id,payload:{title:'Local sandbox'}});
const sealed=await emulator.proof.seal(record.id);
const report=await runReceizConformance();
console.log(JSON.stringify({version:RECEIZ_SDK_VERSION,capabilitySchema:capabilities.schema,namespace:owner.namespace,sandboxVerified:sealed.sandboxVerified,checks:report.summary},null,2));

The example describes local capabilities, creates a synthetic sandbox identity/record/seal and runs packaged conformance. sandbox.receiz.test and sandboxVerified identify the synthetic realm. The packaged checks report networkCalls and dbCalls; this exercise must not be represented as a production original, funded transfer or live custody qualification.

Choose the correct entry point

Installed public entry-point families
ImportEnvironment/use
@receiz/sdkCore client and supported runtime interfaces.
@receiz/sdk/reactReceizProvider and useReceiz for compatible React applications.
@receiz/sdk/testingLocal emulator and runReceizConformance.
@receiz/sdk/compilerNode-only app inspection/compiler tooling.
@receiz/sdk/function-inventoryPublic operation inventory.
@receiz/sdk/offline and /offline/nodeSupported offline tools with their own source/resource requirements.
@receiz/sdk/subjects/nodeThe explicitly documented historical local-subject runtime.

Move from sandbox to integration

Select the exact installed operation, its verifier and required source/identity context. Configure the actual registered application and grant where required. Preserve integer unit strings, source closure, recipient and exact attempt across preparation and response validation. Never use an emulator identity, custom root or sandbox seal to qualify production money. Schema validation and SDK capability description are useful mechanics, not financial admission.

Inspect and verify the release

Packaged local checks; simulate-checkout returns synthetic sandbox_checkout evidence.
node node_modules/@receiz/sdk/dist/cli.js conformance
node node_modules/@receiz/sdk/dist/cli.js simulate-checkout --amount-usd 19.95

Read current output rather than hardcoding an older guide’s report schema. The coordinated release check, source manifests and schema digests describe the package actually used. Before live deployment, assess the selected host, source, permissions and financial/device boundaries independently.

Implementation sources

Inspect the exact path.

Source links retain revision 6c5d582. Read the documented operation and assessment scope alongside its code.