For the complete documentation index, see llms.txt. This page is also available as Markdown.

Developer overview

Build on the same on-chain policy that the Bloxchain Platform enforces, using the open-source Bloxchain Protocol and its TypeScript SDK (@bloxchain/sdk).

You need: Node.js, an RPC endpoint on Sepolia, a wallet key for writes

Who these pages are for

The documentation serves four audiences. This section is the third.

Audience
Start here

Individual users operating the Platform

Your first smart account

Organizations governing a shared account

Organization governance

Builders and developers using the Protocol in their own application

this section, then Configure an account programmatically

AI agents and agent builders preparing work a person approves

What you can build

A Bloxchain smart account is a contract you own. It holds assets and performs actions only through governed requests: a request is posted or signed, waits or collects approvals according to rules stored in the account, and only then executes. The Platform at bloxchain.app is one client of that contract. The SDK is another. Both talk to the same address and neither can bypass the policy on chain.

That gives you four practical options. You can automate an account your team operates in the Platform, for example a service that submits signed approvals with a Broadcaster key, or a monitor that watches request status. You can deploy your own accounts from the Protocol at the pinned release, on Sepolia today and on Ethereum mainnet when mainnet deploys open, and then import them into the Platform or operate them entirely from code. You can configure accounts from code rather than by clicking: register actions, create roles, assign each step of an execution path, grant gates and manage allowlists in signed batches. See Configure an account programmatically. Or you can embed the policy layer in your own product, with the Protocol contracts as the source of truth.

The Protocol core is audited; see Audit status for the scope and Security for the model, the known limits and how to report a problem. The Platform runs on Sepolia today; Ethereum mainnet is coming soon, and Supported networks tracks the chains as they open. Maturity is Alpha · Testnet · Local-first.

Pages in this section

Page
What it covers

Integration surfaces

Platform, SDK and Protocol compared, how to choose one, and how to combine them

Install, pin versions, clients, keys, environment variables

SDK core patterns

Reads, the three execution paths, statuses, errors, retries, worked examples

Script actions, roles, permissions, gates and allowlists

Deploy the Protocol

Clone and deploy at the pinned release; immutable clones versus custom proxies

Production readiness

Checklist before moving real value, plus recovery planning

For AI agents

llms.txt, MCP, canonical sources, copy-paste prompt templates

Prerequisites

  • Node.js 18.20 or later to run the SDK; Node.js 22.12 or later to work inside the Protocol repository.

  • An RPC URL for Sepolia (chain 11155111). The SDK works with any EVM RPC; you pay gas from your own wallet.

  • A funded Sepolia wallet for writes. Reads need no key.

  • Basic familiarity with viem, which the SDK uses for clients and signing.

Where to start

Last updated

Was this helpful?