Tools

Reusable packages for building with Arkiv. Explore a sample dapp, then install the package in your own application.

These packages are intended for testnet use.

arkiv-graph

Explore your app's Arkiv entities in tables and a graph, with wallet-signed Lifetime Extension and deletion.

Tiramisu testnet (7738577).

npm install arkiv-graph@0.3.1

Try sample dapp Sample source Documentation View on npm

Setup, limitations and agent prompt

Prompt for your agent

Integrate arkiv-graph@0.3.1 into my app using its public npm API. First read https://github.com/SantiagoDevRel/arkiv-graph/blob/v0.3.1-docs.1/packages/arkiv-graph/AGENTS.md and the linked README; do not assume node_modules instructions load automatically. Ask me for the target network, public owner address, app namespace/type attributes and relationship rules. Start with a read-only table and graph from the same scoped query. Use the published package; do not copy its implementation. For wallet mutations, also read https://github.com/SantiagoDevRel/arkiv-graph/blob/v0.3.1-docs.1/apps/example/AGENTS.md. If I request Lifetime Extension or deletion, follow that integration, verify account/network/owner, obtain explicit deletion confirmation and confirm the transaction before reporting success. Never request a private key in chat or frontend code. Test the installed package, empty/error states and rendered layouts, and report exact versions and any unverified steps.

Sample setup: Node.js 22 and pnpm 9. Clone tag v0.3.1-docs.1, run pnpm install --frozen-lockfile, then pnpm dev. Open localhost:3012. The sample consumes the exact published npm version. No env file is required for reads.
Prerequisites: Explore the public social example without a wallet. For your app, supply its public owner and namespace attributes. Creation, Lifetime Extension and deletion require an injected wallet such as MetaMask or Rabby and test GLM from the Hub faucet. No private keys in the app.
Supported network: Tiramisu testnet (7738577).
Arkiv SDK: @arkiv-network/sdk 0.8.0; viem 2.56.3. SDK 0.6/0.7 clients are not supported by this release.
Limitations: Public data; filters do not provide privacy. Relationships are resolved by the library, not SQL joins. The sample loads up to 500 entities and marks partial results. Refresh is manual or follows a confirmed mutation. Expiration dates are estimates. Deletion has no undo or cascade and does not erase chain history. The hosted query endpoint allows 60 requests per IP per minute.
Last verified: 2026-09-09

ARKIV-CHUNKING

Split files into queryable Arkiv entities, then retrieve and verify the original bytes.

Tiramisu testnet (chain ID 7738577)

npm install arkiv-chunking@0.1.0

Try sample dapp Sample source Documentation View on npm

Setup and limitations

Sample setup: git clone --branch sample-v0.1.0-r1 https://github.com/SantiagoDevRel/arkiv-chunking.git cd arkiv-chunking/sample npm ci npm run dev Open http://127.0.0.1:3076.
Prerequisites: Node.js 22.12+ for the sample. Uploads need a browser wallet and test GLM; reads need neither a wallet nor an access key.
Supported network: Tiramisu testnet (chain ID 7738577)
Arkiv SDK: 0.8.0 (tested with viem 2.56.3)
Limitations: Public files, up to 32 MiB in memory. Uploads span multiple transactions without rollback. Entity Expiration affects availability; integrity verification does not establish publisher identity.
Last verified: 2026-09-09

ARKIV-STORE-IMAGES

Store public PNG and JPEG images as queryable Arkiv entities, then retrieve and verify the original bytes.

Tiramisu testnet (chain ID 7738577)

npm install arkiv-images@0.1.1

Try sample dapp Sample source Documentation View on npm

Setup, limitations and agent prompt

Prompt for your agent

Integrate arkiv-images@0.1.1 using its public npm API. First read https://github.com/SantiagoDevRel/arkiv-images/blob/feat/image-storage/AGENTS.md and its linked README. For a browser app also read https://github.com/SantiagoDevRel/arkiv-images/blob/feat/image-storage/sample/AGENTS.md; do not assume node_modules guides load automatically. Ask whether I need public upload or existing-image retrieval, and request the image entity key or file, testnet and Entity Expiration. Keep image bytes and metadata public only with the developer's understanding. Reuse the package's chunking and integrity checks; do not copy or bypass them. Use the visitor's wallet for writes and never request a private key in chat. Verify the installed version, image decoding and byte-exact retrieval, handle both ImageStorageError and ChunkingError, and report actual checks and limitations.

Sample setup: git clone --branch feat/image-storage https://github.com/SantiagoDevRel/arkiv-images.git cd arkiv-images/sample npm ci npm run dev Open http://127.0.0.1:3082.
Prerequisites: Node.js 22.12+ for the sample. Uploads need MetaMask or Rabby and test GLM on Tiramisu. Reads need an image entity key; no wallet or access key is required by the sample.
Supported network: Tiramisu testnet (chain ID 7738577)
Arkiv SDK: 0.8.0 (tested with viem 2.56.3)
Limitations: PNG/JPEG only, up to 25 MiB and 40 million pixels. Above 120,000 bytes, images use multiple entities and wallet confirmations. Original metadata stays public. No encryption, resizing or transaction rollback; Entity Expiration affects availability.
Last verified: 2026-09-09