ArcBlock — docs

AFS

Developer documentation for the AFS path, provider, capability, and query contracts in ARC.

Author a provider

Start a provider from the current JSON provider and its conformance suite, then declare only enforceable capabilities.

Core contract

Use the AFS path operations through the capabilities declared by the provider that owns each path.

Browse AFS with the Explorer

Use the AFS Explorer blocklet to browse, inspect, and preview any mounted AFS path from a browser, with URLs that map 1:1 onto AFS paths.

Get started with AFS

Inspect the installed AFS command surface before choosing a provider, mount, or path.

Inspect a local AFS surface

Run a verified, mostly read-only inspection of mounts and paths on a named arc version without inventing storage myths.

AFS

Use AFS to address provider-backed resources through paths, capabilities, and explicit operations in ARC.

Provider catalog

Use tiered admission so only evidence-backed providers appear as public integrations—not the full repository package list.

Providers

Understand AFS providers as capability-owning modules that expose resources through paths.

AFS recipes

Repeatable AFS tasks verified on a named arc version, with explicit environment and mutation boundaries.

AFS reference

Terminology index and stable pointers to AFS operations, capabilities, errors, and related boards.

Runtime boundaries

Separate mounts, permissions, instance state, local validation, and formal publish so inspection never rewrites a user's environment by accident.

Search and query

Choose list, typed collection query, or provider-defined free-text search by their different contracts.

Agent Access

How an external agent discovers, connects to, authenticates against, and uses a blocklet running on ARC.

Access tiers

A request passes four independent gates: the method allowlist, the credential, the path policy, and the provider's capabilities. A credential clears one of them, not all four.

AFS over HTTP

A JSON-RPC endpoint that exposes the same AFS operations as the MCP tools, for clients that do not speak MCP.

Authorize a client

Follow the challenge from a rejected call to the authorization server, register the client, obtain a credential, and use it, plus what the credential leaves closed.

Connect your tool

Add a blocklet to Claude Code or Codex CLI, and sign in when you need more than public reads.

Connect a client

Point an MCP client at a blocklet host over streamable HTTP, then confirm the connection with an anonymous tools/list that needs no handshake.

Declare what agents see

A blocklet declares its content collections once. The declaration decides which agent-facing surfaces each collection reaches, and whether an anonymous caller can read it.

Credentials without a browser

Use the device grant when the client has no browser to redirect to: request, have someone approve, poll, and receive a blocklet- access key.

Discovery surfaces

Four documents under /.well-known/ describe the MCP endpoint, its authentication requirement, and its authorization server. All four are anonymous GETs.

Endpoints

Every path an agent uses, the method it takes, whether it needs a credential, and which component serves it.

Errors

Every failure an agent can hit, what caused it, and what to do, separated into transport failures and in-call failures, because they mean different things.

llms.txt

A short pointer document that names the agent surfaces on a host, plus per-collection shards for the collections that declared an llms face.

Agent access

Every blocklet running on ARC exposes an MCP endpoint and a set of discovery documents, so an external agent can find it, connect, and read what the blocklet has declared.

Tools

Eight generic AFS tools are always present. Three content tools appear only when the blocklet declares collections, and their schemas name those collections.

Understand agent access

The model behind the endpoints: what decides whether a call succeeds, what a blocklet chooses to expose, and which surface to use for which client.

AIGNE CLI

@aigne/cli is the official command-line tool for AIGNE Framework, designed to simplify the development, testing, and deployment processes for AIGNE applications. It provides a series of useful commands to help developers quickly create projects, run agents, test code, and deploy applications.

Built-in Apps

AIGNE CLI comes with pre-packaged applications that offer specialized, out-of-the-box functionality. These apps are complete AIGNE projects that you c

Command Reference

The AIGNE Command-Line Interface (CLI) is your primary tool for creating, managing, and deploying AIGNE agents. This section serves as a comprehensive

aigne create

The aigne create command scaffolds a new AIGNE project from a template. It sets up the necessary directory structure and configuration files, allowing

aigne deploy

The aigne deploy command packages and deploys your AIGNE application as a Blocklet to a specified Blocklet Server endpoint. This is the standard way t

aigne hub

The aigne hub command is your central tool for managing connections to the AIGNE Hub. The Hub provides access to managed large language models, handle

aigne observe

The aigne observe command launches a local web server for monitoring and analyzing agent execution data. It provides a user-friendly interface to insp

aigne run

The aigne run command is the primary way to execute an AIGNE agent. It can run agents from a local project directory or directly from a remote URL. It

aigne serve-mcp

Serves the agents in an AIGNE project as a Model Context Protocol (MCP) server. This command exposes your agents over a streamable HTTP endpoint, enab

aigne test

The aigne test command executes automated tests for your agents and skills. It provides a built-in mechanism for unit and integration testing to ensur

Contributing

We're thrilled that you're interested in contributing to @aigne/cli! Your help is invaluable in making the AIGNE development experience better for eve

Agents and Skills

In the AIGNE ecosystem, Agents and Skills are the fundamental building blocks that bring your AI applications to life. They

Core Concepts

labels: ["Reference"]

Project Configuration (aigne.yaml)

The aigne.yaml file is the heart of your AIGNE project. It serves as the central manifest, defining the project's metadata, language model settings, a

Getting Started

This guide will walk you through the essential steps to install the AIGNE CLI, create a new project, and run your first AI agent. By the end, you'll h

Guides

Welcome to the AIGNE CLI guides. This section provides practical, step-by-step tutorials designed to help you master common development workflows. Whe

Creating a Custom Agent

This guide provides a step-by-step tutorial on creating a new JavaScript agent and integrating it into your AIGNE project as a skill. Agents are the c

Deploying Agents

labels: ["Reference"]

Running Remote Agents

labels: ["Reference"]

Overview

Your command center for agent development@aigne/cli is the official command-line tool for the AIGNE Framework, designed to streamline the entire lifec

AIGNE Framework

The functional, composable, and typescript-first AI Agent framework for real-world LLM Apps.

Agent Library

The Agent Library provides a collection of pre-built, reusable agents designed to accelerate the development of complex AI applications. By integratin

Bash

This document details the Bash agent, which allows for the secure execution of shell scripts and command-line tools within an agentic workflow. You wi

Orchestrator

The Orchestrator agent provides a structured, reliable solution for managing complex, multi-step AI workflows. It breaks down high-level objectives in

Advanced Topics

After mastering the core concepts and building basic applications, you are ready to explore the more sophisticated features of the AIGNE Framework. Th

Defining Agents with YAML

The AIGNE Framework supports a declarative approach for defining agents using YAML configuration files. This method separates the agent's definition (

Hooks

Hooks provide a powerful mechanism to observe, intercept, and inject custom logic into an agent's execution lifecycle. They allow you to add functiona

Prompts

Effective communication with AI models is contingent upon the quality and structure of the prompts provided. The AIGNE framework supplies a robust sys

Streaming

The AIGNE Framework provides robust support for handling streaming responses from agents. This is particularly useful for applications requiring real-

Agent Types

The AIGNE Framework provides a suite of specialized agent types, each designed to perform a specific function. While all agents inherit from the base

AI Agent

The AIAgent is the primary component for interacting with large language models (LLMs). It serves as a direct interface to a ChatModel, enabling sophi

Function Agent

The FunctionAgent provides a straightforward method for encapsulating existing TypeScript or JavaScript functions, thereby elevating them to first-cla

Image Agent

The ImageAgent is a specialized agent responsible for generating images. It acts as an interface to an ImageModel, processing input data to formulate

MCP Agent

The MCPAgent is a specialized agent designed to interact with external systems that adhere to the Model Context Protocol (MCP). It acts as a bridge, a

Team Agent

A TeamAgent is a specialized agent that orchestrates a group of other agents (referred to as "skills") to perform complex tasks. It acts as a manager,

Transform Agent

The TransformAgent is a specialized agent that provides a declarative way to transform structured data using JSONata expressions. It is ideal for scen

Core Concepts

To effectively build applications with the AIGNE Framework, it is essential to first understand its fundamental architectural components. This section

Agents

In the AIGNE Framework, the Agent is the fundamental unit of work. It is an abstract class that establishes a standard contract for all specialized ag

AIGNE

The AIGNE class is the central execution engine of the framework. It orchestrates multiple agents to build complex AI applications, serving as the mai

Memory

The MemoryAgent provides a mechanism for agents to maintain state and remember information across interactions. It acts as a specialized orchestrator

Models

Models are specialized agents that serve as a crucial abstraction layer, providing a standardized interface for interacting with external AI services,

Getting Started

This guide provides the necessary steps to set up your development environment and run your first AI agent using the AIGNE Framework. The process is d

Examples

Explore a collection of practical examples that demonstrate the various features and workflow patterns of the AIGNE Framework. This section provides h

AFS Local FS

This guide demonstrates how to build a chatbot capable of interacting with your local file system. By leveraging the AIGNE File System (AFS) and the S

Chatbot

This guide provides a comprehensive walkthrough of the agent-based chatbot example. You will learn how to run the chatbot in different modes, connect

MCP Blocklet

This document provides instructions on how to utilize the AIGNE Framework and the Model Context Protocol (MCP) to interact with applications hosted on

MCP DID Spaces

This document provides a comprehensive guide to building a chatbot integrated with DID Spaces via the Model Context Protocol (MCP). Following these in

MCP GitHub

This document provides a comprehensive guide to an example that demonstrates how to interact with GitHub repositories using the AIGNE Framework and th

MCP Puppeteer

This guide provides a step-by-step demonstration of how to use the AIGNE Framework with a Puppeteer MCP Server for automated web scraping. By followin

MCP Server

This guide provides instructions on how to run AIGNE Framework agents as a Model Context Protocol (MCP) server. By the end of this document, you will

MCP SQLite

This guide provides a comprehensive walkthrough for interacting with an SQLite database using an AI agent powered by the AIGNE Framework. By following

Memory

This guide demonstrates how to build a stateful chatbot that retains conversation history across sessions. By leveraging the FSMemory plugin, the agen

DID Spaces Memory

This guide demonstrates how to build a chatbot with persistent memory using DID Spaces. By leveraging the DIDSpacesMemory plugin from the AIGNE Framew

Nano Banana

This guide demonstrates how to build and run a chatbot capable of generating images. By following these steps, you will learn how to execute a pre-bui

Workflow Code Execution

Executing dynamically generated code from an AI model presents significant security and reliability challenges. This guide provides a structured, step

Workflow Concurrency

Executing tasks in parallel can significantly improve the efficiency of complex workflows. This guide demonstrates how to build a concurrent workflow

Workflow Group Chat

This guide demonstrates how to build and run a multi-agent group chat workflow using the AIGNE Framework. You will learn how to orchestrate several ag

Workflow Handoff

This guide demonstrates how to build a workflow where one agent can seamlessly hand off control to another specialized agent. By the end, you will und

Workflow Orchestration

This guide demonstrates how to build and run a sophisticated workflow that orchestrates multiple specialized AI agents. You will learn to coordinate a

Workflow Reflection

Have you ever needed an AI to not just generate content, but also to critique and improve its own work? This guide demonstrates how to build a self-co

Workflow Router

Have you ever needed to direct user queries to different specialized handlers based on their content? This guide provides a complete, step-by-step wal

Workflow Sequential

This guide demonstrates how to construct and execute a sequential workflow using the AIGNE Framework. You will learn how to chain multiple agents toge

Models

The AIGNE Framework is designed to be model-agnostic, allowing you to connect to a wide range of third-party AI model providers. This flexibility is a

AIGNE Hub

The AIGNE Hub provides a unified proxy layer for accessing a variety of Large Language Models (LLMs), image, and video generation services from multip

Anthropic

This guide provides instructions for configuring and using Anthropic's Claude models within the AIGNE Framework via the @aigne/anthropic package. It c

AWS Bedrock

The @aigne/bedrock package provides a direct and robust integration between the AIGNE Framework and Amazon Web Services (AWS) Bedrock. This allows dev

Model Configuration

To integrate and utilize the various AI models within the AIGNE Framework, you must first configure the necessary credentials, primarily through envir

DeepSeek

This guide provides instructions for configuring and using DeepSeek models within the AIGNE Framework via the @aigne/deepseek package. It covers API k

Doubao

The @aigne/doubao package provides a seamless integration between the AIGNE Framework and Doubao's powerful language and image generation models. This

Google Gemini

This guide provides instructions for configuring and using Google's Gemini models within the AIGNE Framework via the @aigne/gemini package. It covers

Ideogram

This document provides a comprehensive guide for developers on integrating and utilizing Ideogram's image generation capabilities within the AIGNE Fra

LMStudio

The @aigne/lmstudio package provides a model adapter for integrating AIGNE with large language models (LLMs) hosted locally via LM Studio. This allows

Ollama

The @aigne/ollama package provides a seamless integration between the AIGNE Framework and AI models hosted locally via Ollama. This allows developers

OpenRouter

OpenRouter serves as a unified gateway to a diverse range of AI models from various providers, including OpenAI, Anthropic, and Google. The @aigne/ope

OpenAI

The @aigne/openai package provides a seamless integration with OpenAI's suite of models, allowing developers to leverage services like GPT for chat co

Overview

The AIGNE Framework is designed to be model-agnostic, allowing developers to integrate a wide variety of large language models (LLMs) and image genera

Poe

The @aigne/poe package provides a standardized interface for integrating with Poe, a service that offers access to a wide range of third-party languag

xAI

This guide provides instructions for configuring and using xAI's language models, specifically Grok, within the AIGNE Framework. It covers the install

Overview

The AIGNE Framework is a functional AI application development framework designed to simplify and accelerate the process of building scalable, agentic

User Guide

Welcome to the AIGNE User Guide. This guide is designed for a non-technical audience, including business leaders, managers, and anyone curious about h

Common Workflows

In the AIGNE Framework, a single agent can perform a specific task. However, the true power of the system is realized when multiple agents collaborate

Decision-Making

Illustrates a scenario where a 'manager' agent analyzes a request and decides which specialized agent is best suited to handle the task.

Parallel Tasks

In some situations, you need to perform several independent tasks at the same time to be more efficient. The parallel tasks workflow is designed for t

Sequential Tasks

A sequential task workflow processes a series of tasks in a specific, predetermined order. It operates like a digital assembly line, where the output

Understanding Agents

In the AIGNE framework, an "agent" is the fundamental building block for getting work done. Think of an agent as a specialized digital worker, hired t

Agent Teams

While a single, specialized agent is useful for a specific task, some problems are too large or complex for one agent to handle alone. Just as in a hu

Basic Agents

Think of a basic agent as a specialized digital assistant, like a helpful chatbot or a focused data entry clerk. Each agent is designed to perform one

What is AIGNE?

AIGNE (pronounced [ˈei dʒən], like "agent" without the "t") is a functional framework for developing AI applications. It is designed to simplify and a

AIGNE Hub

AIGNE Hub is the default multi-provider LLM/GPT adapter and API key usage manager for all AIGNE-based apps and Blocklets.

API Reference

This document provides technical specifications for the AIGNE Hub RESTful API. By following this guide, you will understand how to authenticate and in

API Authentication

Securely authenticating requests to the AIGNE Hub API is a critical step for programmatic access and integration. This guide provides a clear, step-by

Chat Completions

This document provides a detailed specification for the Chat Completions API endpoint. By following this guide, you will learn how to generate convers

Embeddings

This document provides a detailed specification for the AIGNE Hub Embeddings API endpoint. By following this guide, you will learn how to convert text

Image Generation

This document provides the technical specifications for the image generation endpoint. By following this guide, you will be able to integrate AI-power

Deployment Scenarios

Choosing the right deployment model is crucial for aligning AIGNE Hub with your specific operational and business objectives. This document outlines t

Enterprise Self-Hosting

Deploying AIGNE Hub within your own infrastructure grants your organization complete control over AI model access, data privacy, and operational costs

Service Provider Mode

Ready to offer your own multi-tenant AI service? This guide details how to activate Service Provider Mode in AIGNE Hub. You will learn to enable the c

Core Features

This section provides a technical deep-dive into the key functionalities of AIGNE Hub. By the end, you will understand the platform's primary capabili

Usage & Cost Analytics

Understanding AI model consumption is crucial for managing costs, monitoring performance, and ensuring fair resource allocation. This document provide

Provider Management

Effective management of upstream AI providers is crucial for maintaining a reliable and cost-efficient AI gateway. AIGNE Hub centralizes this process,

Security & Access

A secure and well-managed system is critical for any enterprise-grade deployment. This section details the robust security architecture of AIGNE Hub,

Getting Started

This guide provides a direct, task-oriented path to deploying and operating AIGNE Hub. By following these steps, a functional instance can be configur

Overview

Struggling to manage a growing collection of API keys, billing systems, and integrations for different AI providers? This document provides a comprehe

Release Notes

This document provides a detailed record of all notable changes, new features, and bug fixes for AIGNE Hub. DevOps and SRE teams can use this informat

AIGNE Studio

AIGNE Studio is a no-code platform for creating powerful LLM workflows and AI agents.

Introduce

Overview

Guide

Overview

Start AI Studio

Before you start, you need to install the DID wallet, you can refer to https://support.didwallet.io/howToDownload to complete the wallet download and

AIGNE WebSmith

AIGNE WebSmith is a powerful, AI-driven website generation tool built on the AIGNE Framework.

Advanced Features

Once you have mastered the basics of generating and updating your website, you can explore the advanced features of AIGNE WebSmith to gain more granul

Use Custom Component Libraries

Websites generated by AIGNE WebSmith are constructed from a library of pre-designed visual elements called components. While WebSmith includes a stand

Use Special Components

AIGNE WebSmith includes a library of special components designed to add powerful visual and interactive elements to your website with minimal configur

Latest Updates

The 'Latest Updates' component provides a dynamic way to showcase recent news, blog posts, or announcements on your website. It integrates with Discus

Terminal Player

The Terminal Player is a specialized component used to display interactive, pre-recorded terminal sessions on your website. This component is an effec

Getting Started

Use this guide as the fastest path to a working site: install the AIGNE CLI, gather source materials, run aigne web generate, approve the plan, and re

Guides

Need to manage your website day-to-day? This section provides step-by-step guides for common operations like creating your site, publishing updates, m

Cleanup Workspace

Use this guide to run aigne web clear safely, whether you want to wipe generated pages, reset cached data, or remove authorization tokens before handi

Create Website

Use this guide to turn your source material into a live-ready site with a single command. You will inspect the available aigne web generate flags, app

Customize Theme

Consistent colors, typography, and spacing make your site feel professional. This guide walks through the exact commands to generate a new WebSmith th

Interactive Mode（Beta）

Note: Interactive mode is currently in beta. While fully functional, you may encounter unexpected behavior. We appreciate your feedback as we continue

Localize Website

Use this guide to run aigne web translate, select the pages and languages you want, and save localized versions that are ready to publish alongside yo

Manage Preferences

Use this guide to configure aigne web prefs, including how to list saved rules, toggle them on or off, and remove entries you no longer need.

Publish Website

Once your website is generated, the final step is to make it accessible online. This guide covers the various methods to publish your site using AIGNE

To Existing Website

This guide shows you how to publish to an ArcBlock-powered website you already operate. Publishing to your own infrastructure gives you complete contr

To New Dedicated Website

This guide walks you through creating and publishing to a brand-new dedicated website. This paid service provisions a fully managed hosting environmen

To WebSmith Cloud

This guide walks you through publishing to WebSmith Cloud—a free hosting service that makes your website publicly accessible without managing any infr

Add Page

Expanding your website is straightforward with AIGNE WebSmith. This guide explains how to use the aigne web add-page command to seamlessly integrate n

Update Website

Use this guide to select the right update workflow and then dive into the detailed sub-guides for structure or page-level changes.

Manage Update History

Use this guide to audit everything WebSmith has changed. The aigne web history command records every generate or update action, so you always know wha

Remove Page

Need to clean up your website's structure? This guide explains how to use the aigne web remove-page command to safely delete pages, automatically find

Update Page

Use this guide when you need to run aigne web update against a single page—rewriting sections, inserting new modules, reordering blocks, or trimming o

Update Structure

Follow this guide when you want to reshape the sitemap with aigne web generate, such as adding or removing pages before approving the plan.

Overview

This document provides a high-level introduction to AIGNE WebSmith. By the end, you will understand its core purpose, key features, and the fundamenta

Reference

This section provides detailed technical material for AIGNE WebSmith. It is designed for users seeking specific, in-depth information about commands,

Command Reference

This reference lists all commands available in the AIGNE WebSmith CLI, including their aliases, parameters, and usage examples.

Config Reference

The config.yaml file is the central control panel for your website generation. Understanding its settings allows you to customize every aspect of the

Prepare Materials

Great websites start before you run aigne web generate. This guide gives you a concrete checklist for collecting briefs, source docs, and proof so Web

Troubleshooting

This guide helps you diagnose and fix common issues when working with AIGNE WebSmith. If you encounter problems during generation, publishing, or conf

Release Notes

This document records all version updates for AIGNE WebSmith, including new features, bug fixes, and other changes, organized by version in reverse ch

ARC CLI

The command line for ARC — declare, build, deploy and inspect a site or a Blocklet from a terminal.

arc afs

arc afs is the command group for AFS file system operations: listing, reading, writing, deleting, and searching paths, running actions, and managing mounts.

arc attach

arc attach reverse-mounts a local directory into a remote arc daemon as a provider, so a machine you don't have shell access to can read your local files through AFS.

arc blocklet

arc blocklet covers the blocklet package and instance lifecycle: scaffold, build, check, list, deploy a single blocklet, or deploy a whole fleet.

arc collections

arc collections has authoring tools for blocklet.yaml's collections: declarations — today, scanning content/ to generate the fragment for you.

arc completion

arc completion prints a shell completion script for bash, zsh, or fish to stdout — it never writes a file itself, so installing it is a redirect you control.

arc deploy

arc deploy registers or publishes a blocklet: locally with the daemon for development, or to a DID Space (local or remote) for real publishing.

arc did

arc did manages identity and trust: generating a DID identity, issuing and verifying verifiable credentials, and managing which issuers you trust.

arc drain

arc drain is a long-running process that watches the work ledger and dispatches ready work to an idle peer until the ready set is empty.

arc dsl

arc dsl validates, lints, formats, generates, and inspects AUP DSL artifacts, the language pages/layout.aup files are written in.

arc mcp

arc mcp bridges stdio to a running AFS daemon's MCP endpoint, so Claude Desktop or any stdio MCP client can talk to AFS. It auto-starts the daemon if needed.

arc network

arc network doctor probes proxy discovery, DNS, HTTPS and WebSocket connectivity from this machine, and reports every check on its own line.

arc provider

arc provider handles provider package operations, currently publishing a provider's AUP resource tree to Cloudflare Pages so it can be referenced by URL.

arc serve

arc serve starts an AFS server over HTTP or MCP, so other processes (browsers, agents, MCP clients) can talk to your AFS instance over the network instead of the CLI.

arc service

arc service manages named AFS background instances: list, start, stop, restart, status, delete, gc, url, and logs.

arc skill

Bundled ARC how-to booklets: list, show one by name, install into host .agents/.claude skills. Not a full gh-skill-style manager or AFS .skills inventory (yet).

arc space

arc space manages local DID Space data: inspecting what's stored, moving data between two subtrees with a single sync command, and claiming, checking and repairing folder-backed spaces.

arc upgrade

arc upgrade upgrades arc itself to the latest published binary release, or to a pinned version.

arc vault

arc vault is encrypted secret storage: init a vault, then get/set/list/delete secrets organized by group and name.

Exit Codes

Every arc command reports its outcome as an exit code — 0 for success, plus seven distinct non-zero values (one reserved but not yet produced) — so a script can tell what kind of failure it hit without reading the message.

Install

Install arc with the official installer, then read the version line it reports back.

Overview

arc is the command line tool for operating an ARC runtime instance: the AFS file system, identity and trust, secrets, deployments, and the AUP DSL all go through it.

ArcBlock Jobs

ArcBlock job opportunities: Build blockchain ecosystem, seek full - stack talents.

ArcBlock Media Kit

ArcBlock Media Kit: Introduction to all media material resources.

AIGNE Logos

All image resources

ArcSphere Logos

All Brand Assets zip

DID Logos

All image resources

ArcBlock Logos

All image resources

Payment Kit Guide

Payment Kit User Guide: Explore core functions of payment solution.

How to Configure Additional Payment Methods

This guide explains how to configure additional payment options for EVM-compatible chains. 1. Add a Payment Method (EVM Chain) Navigate toayments → Se

Development Guide

Overview

How to activate the donation feature?

@blocklet/payment-react offers a robust tipping and donation feature. Using the CheckoutDonate component and the optional DonateProvider, developers

Enable SubGuard™ for subscriptions?

Enabling SubGuard™ for your application in Launcher ensures uninterrupted subscription services, even in cases of payment failures. This guide will wa

Payment Kit Event Listening Mechanism

Payment Kit provides two ways to listen for events, enabling you to respond to system events in a timely manner.

Custom Notification Processing Guide

Payment Kit allows applications to handle notifications directly, offering two configuration options.

Welcome to Payment Kit.

Payment Kit is ArcBlock's powerful payment solution designed to help developers quickly and easily integrate diverse payment functionalities into thei

Security

- How to configure and enable the Vault Wallet

User Guides

- Enable SubGuard™ for subscriptions?

How to configure and enable the Vault Wallet

1. Key Features of the Vault Wallet

AI Application Engineer (Filled)

Please send your resume to apply for this position: hr@arcblock.io Job responsibilities 💡 Depending on individual abilities and interests, you can c

Android Engineer (Filled)

Please send your resume to apply for this position: hr@arcblock.io

Full-Stack JS Engineer (Filled)

Please send your resume to apply for this position: hr@arcblock.io Job Responsibilities 💡 You can choose to participate in any of the following jobs

iOS Engineer (Filled)

Please send your resume to apply for this position: hr@arcblock.io Job Responsibilities Design and implement user-oriented product features, deliver

Join Us

Why join ArcBlock?

JS backend engineer (Filled)

Please send your resume to apply for this position: hr@arcblock.io Job Responsibilities Design and implement user-oriented product features, deliver

What is our recruitment process?

What are the steps to successfully join ArcBlock? How should one prepare? You can take a look at two articles written by CEO.

Site Reliability Engineer (Filled)

Please send your resume to apply for this position: hr@arcblock.io Job Responsibilities Organize and implement comprehensive and automated online ser

UI/UX designer (Filled)

Main responsibilities

WEB Front-end Engineer (Filled)

Please send your resume to apply for this position: hr@arcblock.io

ArcBridge Node

ArcBridge Node: Trustless cross - chain component enabling asset cross - chain transfer.

How to add stake for your node?

Login to your ArcBridge Node, and open "Stake" page Click "Add Stake" on the Stake page Input stake amount in the stake dialog: Complete the stake wit

Join ArcBridge

You can join ArcBridge by just run the following blocklet:

ARC Architecture

Developer documentation for the ARC architecture: AFS, AFS UI, AUP, Web Device, Blocklets, identity, data spaces, and product lineage boundaries.

AFS UI

Understand AFS UI as the projection of AFS data and capabilities into interactive and site UI, not as a third authoring board equal to AUP or Web Device.

ARC and AFS

Treat AFS as the path and capability layer, and ARC as the runtime shell that hosts mounts, Blocklets, and CLI entry points.

Contracts and evidence

Classify ARC documentation claims as current contract, architecture, experimental, or lineage, and know what evidence each status requires.

Mental model

Use one short vocabulary map for ARC architecture, then open the board that owns each task.

ARC Architecture

Place AFS, AFS UI, AUP, Web Device, Blocklets, identity, and data-space concepts before choosing a task-specific guide.

Product layers

Choose the AFS, AFS UI, AUP, Web Device, Blocklet, or identity layer that owns a task, and keep their contracts separate.

Product lineage and boundaries

Map older ArcBlock product names to current ARC homes without promising full feature equivalence.

Reference

Index of architecture terms and links into AFS, AUP, Web Device, Blocklets, Identity, and ARC CLI boards.

AUP

Developer documentation for AUP authoring, validation, and runtime behavior in ARC.

Author with DSL

Treat DSL as AUP’s source-first authoring layer and make the JSON-compatibility boundary explicit.

Caller identity and safety

A UI tree can express intent, but identity, path scope, write permission, and embedded trust remain separate server-side decisions.

AUP capability tour

Walk web slideshow as AUP host: 18 primitives + widgets (readonly shells where needed), Markdown surface, and deck media host demos. Hard excludes: rtc and camera-preview only.

CLI diagnostics

Choose the diagnostic that answers the question; no single green command is browser or device acceptance.

Core concepts

Understand AUP from semantic trees, events, sessions, and capabilities instead of inferring the protocol from one renderer.

Custom primitives and Web widgets

Distinguish portable primitives from Web widgets, and acceptance of a custom name from implementation on every target.

Device capabilities and degradation

Let a device report actual primitive capability, then use AUP's explicit degradation chains on limited targets.

App, page, and shell

Declare a compact app manifest, then keep shell, page discovery, and named navigation within one inspectable source boundary.

Components, loops, and i18n

Use compile-time components and loops for source structure; use runtime lists and locale contracts for data and language.

Events, navigation, and visibility

Use current DSL sugar for clicks, named-page navigation, and local updates while keeping visible version-bounded.

Generate, lint, and migrate

Keep DSL source readable, validate its meaning, and materialize JSON only when a compatibility consumer needs it.

DSL language reference

Navigate the DSL by authoring layer, then use the compiler and validation for the exact target-version grammar.

Nodes, values, and sugar

Use readable node sugar for author intent, while knowing the semantic AUP node it compiles into.

DSL source model

Separate editable DSL sources, generated artifacts, and compatibility consumers that still use them.

Events, state, and bindings

Separate reads, writes, server-managed prop bindings, UI state, and user events.

Example: AFS data binding

Use the DSL Showcase list-template source to distinguish a runtime AFS list from a compile-time loop, then verify scope on the actual target.

Example: interaction flow

Use the DSL Showcase overlay source to reason about a multi-step interaction, while keeping source evidence separate from target acceptance.

Example: local state and events

Read the current DSL Showcase `set-sugar` source as a source-level state/event example, not a deployed behavior guarantee.

Example: minimal app

Use the verified `minimal-app` recipe as a bounded end-to-end path, not as a claim of a pure protocol-only scaffold.

Example: Web layout

Use the verified Web Device first site as a static Web layout example, without turning it into a generic interactive-renderer claim.

Examples and evidence

Choose Showcase and recipe examples through registered routes, source, and explicit evidence boundaries.

Build a first AUP app

Use the minimal-app recipe for a verified ARC AUP starting path.

Frames, bridges, and embedded surfaces

Use frames, bridges, and surfaces only with explicit trust, origin, and runtime boundaries.

Get started

Start with a minimal complete app: create, check, run, and inspect AUP.

Live examples: scope and contract

Keep documentation read-only while placing source, runtime output, and the exact acceptance boundary in one reference page.

Nodes, events, and messages

Use a small semantic node contract; keep authoring semantics distinct from renderer transport details.

AUP on Web Device

Separate AUP static-HTML tree rendering, page-layout composition, and Web Device site responsibilities.

AUP

Describe an interface with AUP, author its source with DSL, and run it through ARC on a target device.

Patches, scenes, and capabilities

Understand render-first updates, target-reported capabilities, and the deliberately narrow degradation contract.

Primitive taxonomy and evidence

Separate 18 cross-device primitives, 42 Web-only widgets, and the capabilities an actual target reports.

AUP primitives

Open one page per cross-device AUP primitive: contract, document capability, fallback, and sample boundary.

`action` primitive

Declare a button or navigation action without promising exec on the document target.

`afs-list` primitive

afs-list lists AFS-backed entries; document can render empty or static children, but live path data is not a closed docs contract yet.

`calendar` primitive

Calendar is a structured date surface; document is unsupported and may degrade to table or text.

`canvas` primitive

Canvas is drawing-surface intent; document is unsupported and degrades toward media or text.

`chart` primitive

Chart is a cross-device primitive on full web; static documents must not claim a live chart.

`chat` primitive

Chat is a session-oriented primitive; document has no chat capability chain.

`editor` primitive

Editor can render on document as a local textarea; do not promise a writable IDE or AFS write-back.

`explorer` primitive

Explorer is a composition pattern over list/stat/preview surfaces, not a document widget.

`input` primitive

Author an unbound form control on document; keep bind and write paths off docs pages.

`map` primitive

Map is portable intent for geo surfaces; document is unsupported and degrades toward media or text.

`media` primitive

Bind image, video, audio, or avatar media as a portable media primitive with a docs-safe live image sample.

`overlay` primitive

Reserve overlay for interactive sessions; document reports unsupported and degrades toward text.

`rtc` primitive

RTC is media-permission sensitive; the shared chain ends at unsupported.

`surface` primitive

Surface is a cross-device mount intent; do not confuse it with Web Device layout surfaces.

`table` primitive

Present columnar data as a table primitive; distinguish GFM tables and chart fallback tables.

`text` primitive

Express readable copy, headings, and admonitions as a portable text primitive.

`time` primitive

Show time values with partial document support; do not promise a live clock in static docs.

`view` primitive

Use the portable container primitive for structure, tabs, and steps — not for layout.aup site sections.

Product layers and scope

Decide whether a task belongs to AUP semantics, DSL authoring, a renderer, or a Web Device site.

Reference

Look up AUP nodes, patches, support matrix, DSL, and artifact boundaries by current version.

Release compatibility

Keep CLI/runtime, source checkout, generated artifacts, and Showcase material as separate compatibility evidence.

Renderers, sessions, and support

Separate a loadable source, a target-renderable tree, and an interaction that has actually been accepted.

Run in ARC

Explain how AUP enters renderers, sessions, and concrete device surfaces.

Semantic tree

Describe interface intent with stable ids, types, props, bindings, and children rather than pixels for one device.

Sessions, patches, and scenes

Keep interactive full-tree rendering, incremental patches, and device context separate.

Sources, artifacts, and JSON compatibility

Separate the source ARC reads from generated compatibility artifacts without turning either into a second UI model.

Validate, run, and inspect

Format, check, and directly run minimal-app, then accept its AUP result in a browser.

AUP Web-only widgets

Navigation hub for all 42 AUP_WIDGETS entries — one page per widget; not a multi-widget reference body.

afs-dropzone

AUP Web-only widget `afs-dropzone`: purpose, boundaries, surfaces, fallback, and evidence.

afs-preview

AUP Web-only widget `afs-preview`: purpose, boundaries, surfaces, fallback, and evidence.

afs-stat

AUP Web-only widget `afs-stat`: purpose, boundaries, surfaces, fallback, and evidence.

agent

AUP Web-only widget `agent`: purpose, boundaries, surfaces, fallback, and evidence.

app-footer

AUP Web-only widget `app-footer`: purpose, boundaries, surfaces, fallback, and evidence.

app-header

AUP Web-only widget `app-header`: purpose, boundaries, surfaces, fallback, and evidence.

auto-fire

AUP Web-only widget `auto-fire`: purpose, boundaries, surfaces, fallback, and evidence.

auto-surface

AUP Web-only widget `auto-surface`: purpose, boundaries, surfaces, fallback, and evidence.

block-revealer

AUP Web-only widget `block-revealer`: purpose, boundaries, surfaces, fallback, and evidence.

blocklet-embed

AUP Web-only widget `blocklet-embed`: purpose, boundaries, surfaces, fallback, and evidence.

breadcrumb

AUP Web-only widget `breadcrumb`: purpose, boundaries, surfaces, fallback, and evidence.

broadcast

AUP Web-only widget `broadcast`: purpose, boundaries, surfaces, fallback, and evidence.

camera-preview

AUP Web-only widget `camera-preview`: purpose, boundaries, surfaces, fallback, and evidence.

chip

AUP Web-only widget `chip`: purpose, boundaries, surfaces, fallback, and evidence.

comments-surface

AUP Web-only widget `comments-surface`: purpose, boundaries, surfaces, fallback, and evidence.

deck

AUP Web-only widget `deck`: purpose, boundaries, surfaces, fallback, and evidence.

entity-overview

AUP Web-only widget `entity-overview`: purpose, boundaries, surfaces, fallback, and evidence.

finance-chart

AUP Web-only widget `finance-chart`: purpose, boundaries, surfaces, fallback, and evidence.

frame

AUP Web-only widget `frame`: purpose, boundaries, surfaces, fallback, and evidence.

globe

AUP Web-only widget `globe`: purpose, boundaries, surfaces, fallback, and evidence.

hero-widget

AUP Web-only widget `hero-widget`: purpose, boundaries, surfaces, fallback, and evidence.

key-value-list

AUP Web-only widget `key-value-list`: purpose, boundaries, surfaces, fallback, and evidence.

moonphase

AUP Web-only widget `moonphase`: purpose, boundaries, surfaces, fallback, and evidence.

natal-chart

AUP Web-only widget `natal-chart`: purpose, boundaries, surfaces, fallback, and evidence.

pagination

AUP Web-only widget `pagination`: purpose, boundaries, surfaces, fallback, and evidence.

photo-story

AUP Web-only widget `photo-story`: purpose, boundaries, surfaces, fallback, and evidence.

post-editor

AUP Web-only widget `post-editor`: purpose, boundaries, surfaces, fallback, and evidence.

progress-bar-3d

AUP Web-only widget `progress-bar-3d`: purpose, boundaries, surfaces, fallback, and evidence.

scroll-explainer

AUP Web-only widget `scroll-explainer`: purpose, boundaries, surfaces, fallback, and evidence.

searchable-dropdown

AUP Web-only widget `searchable-dropdown`: purpose, boundaries, surfaces, fallback, and evidence.

skills

AUP Web-only widget `skills`: purpose, boundaries, surfaces, fallback, and evidence.

terminal

AUP Web-only widget `terminal`: purpose, boundaries, surfaces, fallback, and evidence.

text-highlight

AUP Web-only widget `text-highlight`: purpose, boundaries, surfaces, fallback, and evidence.

text-image-expand

AUP Web-only widget `text-image-expand`: purpose, boundaries, surfaces, fallback, and evidence.

ticker

AUP Web-only widget `ticker`: purpose, boundaries, surfaces, fallback, and evidence.

tooltip

AUP Web-only widget `tooltip`: purpose, boundaries, surfaces, fallback, and evidence.

type-block

AUP Web-only widget `type-block`: purpose, boundaries, surfaces, fallback, and evidence.

url-default

AUP Web-only widget `url-default`: purpose, boundaries, surfaces, fallback, and evidence.

webgl-hero

AUP Web-only widget `webgl-hero`: purpose, boundaries, surfaces, fallback, and evidence.

wm

AUP Web-only widget `wm`: purpose, boundaries, surfaces, fallback, and evidence.

wm-surface

AUP Web-only widget `wm-surface`: purpose, boundaries, surfaces, fallback, and evidence.

xeyes

AUP Web-only widget `xeyes`: purpose, boundaries, surfaces, fallback, and evidence.

Blockchain Guide

ArcBlock Blockchain User Guide: Functions and Help Instructions.

Blockchain SDK (Node.js)

@ocap/client is a client library for Node.js and browsers to link apps to an OCAP Chain.

API Reference

Welcome to the OCAP Client API Reference. This section provides a comprehensive and searchable reference for all available classes, methods, and data

Helper Methods

The GraphQLClient class is the primary interface for interacting with an OCAP-powered blockchain. It provides a comprehensive set of methods for query

Data Types

This section provides a comprehensive reference for all the custom data structures, input parameters, and response objects used throughout the OCAP Cl

Low-level API

The Low-level API provides granular control over the entire transaction lifecycle. Unlike the High-level API which abstracts away the details, these m

Query & Mutation Methods

The OCAP Client interacts with the blockchain through GraphQL. Methods are categorized into two main types:

High-level API

Transaction helpers are high-level functions built into the OCAP Client that abstract away the complexity of creating and signing common transactions.

Core Concepts

This section dives into the fundamental principles and architectural decisions that shape the OCAP Client library. Understanding these core concepts w

Client Architecture

The OCAP Client is designed with a modular architecture to cater to different JavaScript environments and specific use cases. Instead of a one-size-fi

Event Subscriptions

The OCAP Client provides a powerful, real-time event subscription system that allows your application to listen for on-chain activities as they happen

Gas Payment

In most blockchain systems, every transaction requires a fee, commonly known as "gas," to be paid by the initiator. This can be a significant hurdle f

Transaction Lifecycle

Every action that modifies the state of the blockchain, such as transferring tokens or creating an asset, is executed through a transaction. Understan

Getting Started

Welcome! This guide will get you up and running with the OCAP Client in under 30 minutes. You'll learn how to install the client, connect your applica

Basic Usage

This guide will walk you through the essential steps to get started with the OCAP Client. You'll learn how to initialize the client, connect to the Ar

Installation

The OCAP Client is a JavaScript library that connects your application to an OCAP blockchain. It works in both Node.js and browser environments. This

How-to Guides

This section provides practical, step-by-step instructions for completing common tasks with the OCAP Client. Each guide is designed as a self-containe

Delegate Permissions

Delegating permissions is a powerful feature that allows one account (the delegator) to authorize another account (the delegatee) to send specific typ

Manage Accounts

On an OCAP-powered blockchain, an account is fundamentally a state associated with an address, controlled by a pair of cryptographic keys (a public ke

Manage Assets (NFTs)

This guide provides a comprehensive walkthrough of managing the entire lifecycle of Non-Fungible Tokens (NFTs), also known as assets, using the OCAP C

Manage Tokens

This guide provides step-by-step instructions for managing fungible tokens using the OCAP Client. You will learn how to set up a token factory, which

Stake Tokens and Assets

Staking is the process of locking up tokens or assets (NFTs) to a specific receiver, often to secure a network, participate in governance, or earn rew

Transfer Tokens and NFTs

This guide provides a step-by-step walkthrough for transferring fungible tokens (both native and custom) and non-fungible tokens (NFTs or assets) betw

Overview

The OCAP Client is a powerful and versatile JavaScript library designed to connect your applications to an OCAP-powered blockchain. It provides a stre

Blockchain Utils

Utility libraries for working with wallets, big numbers and DID.

@arcblock/did

This package provides a JavaScript library for working with ArcBlock's Decentralized Identity (DID) protocol. It allows you to create, manage, and val

API Reference

This section provides a comprehensive API reference for all public functions and types within the @arcblock/did library. It includes practical, copy-p

Core Concepts

This section explains the fundamental concepts behind ArcBlock's Decentralized Identity (DID). A DID in the ArcBlock ecosystem is more than just an id

Getting Started

This guide provides a quick, step-by-step walkthrough to get you up and running with ocap-libs. In just a few minutes, you'll install the necessary pa

Overview

Welcome to the official documentation for OCAP Libraries, a comprehensive suite for building applications with decentralized identity. This guide prov

@ocap/util

The @ocap/util package is a foundational library providing a collection of essential helper functions shared across multiple OCAP JS libraries. Design

API Reference

This is a comprehensive reference for all utility functions available in the @ocap/util package. It provides practical examples for data conversion, b

@ocap/wallet

This package provides utility functions to create and use an OCAP-compatible crypto wallet. The generated wallets are also compatible with ArcBlock's

API Reference

This section provides detailed documentation for the Wallet object and its factory functions. You'll find descriptions of each function, its parameter

Core Concepts

This section introduces the fundamental concepts behind the @ocap/wallet package. You'll learn what a Wallet object is, its structure, the different w

Conceptual Guides

- Understanding DIDs

Frequently Asked Questions

How the documentation is organized?

Getting Started

If you are an intermediate or advanced javascript developer, you can start from Send first transaction.

How-to Guides

- Create Account

Reference Guides

- Working with DIDs

Setup Node.js

About why Node.js is required and how to install Node.js please refer to Blocklet Developer Guide

Create Account

An account is a data entry that's stored in the chain ledger, on-chain accounts are controlled by off-chain wallets, see understanding accounts and w

Create Token

此文档描述如何从 ArcSwap 界面上创建 Token。

Query Accounts

Query account by address

Query NFT

Query NFT State

Query Transactions

The listTransactions query allows you to fetch a list of transactions on the blockchain based on various criteria. This can be useful for monitoring s

Send first transaction

In this tutorial you will learn how to connect to a running chain and send your first transaction.

Migration Guides

- Upgrade from 1.18.x to 1.19.x

Transaction Types

Account Related

Understanding DIDs

What is DID?

Understanding NFTs

We use the term NFT and Asset interchangeably throughout this documentation because they mean the same thing on the ArcBlock chain. What is NFT? NFTs

Understanding Tokens

What is token?

Understanding Transactions

A transaction must be encoded and signed by the sender's wallet, once sent to the chain, it's decoded and verified, and then executed and appended to

Understanding Verifiable Credentials

Learn the basic concept, mental model, use cases and benefits of verified credentials, understand it's difference between NFTs

Understanding Wallets and Accounts

What is Wallet?

Upgrade from 1.18.x to 1.19.x

ArcBlock's blockchain, as of v1.19.x, includes native support for Passkeys, allowing them to have corresponding accounts on the blockchain and to sign

Welcome

ArcBlock blockchain is an open, secure, and extensible billing layer for the ArcBlock ecosystem, the blockchain has native DID support, and it's wide

Work with Verifiable Credentials

@arcblock/vc includes several utility functions to issue and verify verifiable credentials and their presentations.

Working with DIDs

Utility functions to create/inspect did, and do did-based auth, an implementation of abt-did-protocol

Blocklet CLI

A comprehensive guide for developers on @blocklet/cli library, covering installation and its features.

Advanced Topics

Welcome to the advanced topics section. While the core workflows cover day-to-day development and server management, this section dives into more spec

Cleanup Blocklet

The blocklet cleanup command is a utility for performing maintenance tasks on a specific blocklet installed on your Blocklet Server. It allows you to

DID Document Management

Every blocklet is identified by a Decentralized Identifier (DID), which is associated with a DID Document. This document contains crucial metadata, su

Blocklet Workflows

The Blocklet CLI provides a comprehensive suite of commands to support the entire lifecycle of a blocklet, from initial project creation to final dist

Component Management

Blocklets can be composed of other blocklets, which are referred to as components. This powerful feature allows you to build complex applications by a

Add Component

The blocklet add command adds a new component as a dependency to your blocklet. It automatically updates the components section of your blocklet.yml f

Remove Component

The blocklet remove command provides a straightforward way to remove a component dependency from your blocklet's blocklet.yml metadata file. This acti

Component Studio CLI

The blocklet component command serves as a convenient proxy to execute commands from the @blocklet/component-studio-cli package. This allows you to in

Distribution

Once your blocklet is developed and bundled, the next step is to make it available for others to install and use. The Blocklet CLI provides two primar

Connect to Store

Before you can upload a blocklet to a Blocklet Store, you first need to connect your local CLI to it. The blocklet connect command facilitates a one-t

Deploy Blocklet

The blocklet deploy command is your direct line for pushing a blocklet from your local development environment to a running Blocklet Server instance.

Upload to Store

After you have successfully bundled your blocklet, the next step in distribution is to upload it to a Blocklet Store. The blocklet upload command send

Local Development

Developing and testing your blocklet locally is a crucial part of the workflow. The Blocklet CLI provides a powerful set of tools to run your blocklet

Debug Blocklet

The blocklet debug command is a utility for developers to set environment variables on a running blocklet, primarily for enabling detailed logging and

Develop Mode

The blocklet dev command is a crucial tool for local development. It runs your blocklet in a live-reloading development mode, connecting it to a runni

Execute Script

The blocklet exec command is a powerful utility for running a script within the live context of an installed blocklet. This is invaluable for tasks li

Packaging & Versioning

Once you've finished developing and testing your blocklet, the next step is to prepare it for distribution. This involves two critical processes: vers

Bundle Blocklet

The blocklet bundle command is a crucial step in the development lifecycle. It packages your blocklet's source code, assets, and metadata into a stand

Manage Version

The blocklet version command is a convenient utility for updating your blocklet's version number in the blocklet.yml file. It follows the rules of sem

Project Setup

Getting a new blocklet project off the ground is straightforward. The Blocklet CLI provides two primary commands to bootstrap your development environ

Create Project

The blocklet create command is the fastest way to start a new Blocklet project. It uses create-blocklet, an interactive scaffolding tool that lets you

Initialize Project

The blocklet init command is an interactive utility that helps you create the fundamental structure for a new blocklet within an existing directory. I

Command Reference

The Blocklet CLI provides a comprehensive set of commands to manage both your Blocklet Server instances and individual blocklet projects. This referen

blocklet

The blocklet command is the primary interface for managing the entire lifecycle of a Blocklet project. It provides a comprehensive suite of subcommand

blocklet server

The blocklet server command is the primary tool for managing the lifecycle and configuration of your Blocklet Server instance. It allows you to initia

Configuration

Proper configuration is essential for both running a Blocklet Server instance and for interacting with it and other services using the Blocklet CLI. T

Environment Variables

Environment variables provide a powerful way to configure Blocklet Server and the blocklets it runs. They override default settings and values from co

Getting Started

This guide will walk you through the essential steps to get your first Blocklet Server instance up and running. In just a few minutes, you'll go from

Overview

The Blocklet CLI is your primary tool for managing Blocklet Server and developing blocklets. It provides a comprehensive set of commands to handle eve

Server Management

The blocklet server command is your primary tool for managing the lifecycle of a Blocklet Server instance. It allows you to initialize configurations,

Cleanup Server

The blocklet server cleanup command is a utility tool for performing various server-level maintenance tasks. It helps you resolve issues by clearing c

Get Server Info

The blocklet server info command is a vital diagnostic tool designed to collect and display a comprehensive summary of your Blocklet Server's environm

Initialize Server

The blocklet server init command initializes a new Blocklet Server instance by creating a dedicated configuration directory, .blocklet-server, in the

View Logs

The blocklet server logs command is an essential utility for troubleshooting and monitoring. It doesn't display the log content directly but instead p

Migrate Database

The blocklet server migrate command is a crucial utility for scaling your Blocklet Server instance. It facilitates the migration of your server's unde

Start Server

The blocklet server start command is the primary method for launching your Blocklet Server instance. It initializes and runs all necessary components

Check Status

The blocklet server status command is a vital tool for monitoring the health of your Blocklet Server instance and all the blocklets running within it.

Stop Server

The blocklet server stop command gracefully shuts down the running Blocklet Server instance. This process includes stopping all running blocklets, the

Upgrade Server

This document provides instructions for upgrading the Blocklet Server Command Line Interface (CLI) to the most recent version available.

Blocklet Platform

Guide to understand and build on our blocklet platform

Request Entity too Large

Blocklet Server limits file size on uploading within a certain range for efficiency considerations, since larger file uploads will consume more resour

Manage Blocklet Versions

This documentation provides guidelines on managing the versioning of Blocklets, ensuring consistency and clarity across releases.

Blocklet SDK (Browser)

The Blocklet JS SDK is the official frontend library provided to assist in the development of blocklets.

Test a Blocklet

After creating the application, we can directly install the Blocklet locally to test if it meets expectations.

Adding a component

This document explains how to install Blocklets on your website and details the characteristics, use cases, and important considerations for each inst

Access Control

Blocklet Service 为 Blocklet 提供的访问控制基于 RBAC(Role-based access control)

Access Key

What Are Access Keys?

Application vs Blocklet

Before we start developing Blocklets, let’s first understand what an application is and what a Blocklet is.

How to bind a domain to Blocklet and generate SSL/TLS certificate

Overview

Blocklet GitHub Actions

If you are using GitHub Actions to manage the process of packaging, publishing, and deploying Blocklet applications, then you will more efficient Bloc

Blocklet CLI

Blocklet CLI provides blocklet command-line tool for controlling and administering Blocklets. Use the following syntax to run blocklet commands from y

Blocklet Composition

Imagine you're playing with Lego bricks. Each brick is unique, with its own color, shape, and function. Now, picture being able to snap these bricks t

Blocklet Lifecycle

This doc is a draft and needs to be updated

Blocklet SDK (Node.js)

Blocklet SDK for blocklet developer

Blocklet Server Architecture

[!NOTE] this page is a draft and need to be updated

Blocklet Server CLI

Blocklet Server CLI provides blocklet server command-line tool for controlling and administering Blocklet Server in local machine. Use the following s

Blocklet Server Routing

TBD: Blocklet server routing pipeline

Blocklet Server Troubleshooting Checklist for Self-inspection

Introduction

Blocklet Service

Blocklet Service provides some out-of-the-box services for Blocklets.

Blocklet Storage

Using local database

Blocklet Studio

What is Blocklet Studio?

Create a Blocklet

Before Create a Blocklet, you need to become a developer of the Blocklet Store. Please refer to:

Delete a Blocklet

In the Blocklet Studio list, you can click the delete button of a specific Blocklet to remove it:

Upload static resources

If you have a project with static resources, you can directly use Blocklet Studio to create a Blocklet.

Blocklet UI

Blocklet UI 是一个用于快速构建 Blocklet 的前端组件库。区别于一般的 UI 组件库，Blocklet UI 提供的组件通常需要工作在 Blocklet 环境中，在页面渲染时，Blocklet UI 会读取 Blocklet 运行时信息 (称为 Blocklet Meta), 比如 Blocklet Logo，应用名称，导航菜单等信息，然后基于这些信息来渲染用户界面。

blocklet.js

What is blocklet.js?

blocklet.yml

DID

Build blocklet for profit [deprecated]

设置价格

Bundle your blocklet

Introduction

Communicate with DID Wallet

Establish connection with DID Wallet

Conceptual Guides

- Platform Overview

Developer Best Practices.

- Developing Blocklet in Docker

Create Blocklet

Before proceeding, please ensure you have followed the steps outlined here: Create Blocklet from Scratch If you want to start a new blocklet from sc

Compose Blocklets

What is Blocklet Composition?

Create a Blocklet of type Docker

Before you begin:

Create your first blocklet

There are usually two ways to create a Blocklet application: Create Blocklet and the blocklet create command. The latter is a command provided by @b

How to add custom well-known URI

In some cases you may want to add custom well-known URI on your website, such as:

Customize user profile page

As Blocklet development progresses, a demand for personalized profile page is highly likely to emerge. Because of the Blocklet platform's composabilit

Defend against CSRF attacks

Overview

Deploy your blocklet

If you are a blocklet developer, or you have a blocklet release bundle, you can deploy the blocklet directly to your Blocklet Server

Develop Blocklet

Start development

Developing Blocklet in Docker

When you are unable or unwilling to directly install @blocklet/cli on the computer for some reason, it can be difficult to develop Blocklet because @b

Developing with GitHub Codespaces

Setting Up the Blocklet Server

Enable Web Application Firewall

This page need to be updated Blocklet Server has opt-in support for Web Application Firewall with following open-source projects: https://github.com/o

Event Bus Service (Beta)

Event Bus service is a powerful communication system that helps your blocklet's components work together seamlessly. Imagine it as a smart messaging c

Frequently Asked Questions

How the documentation is organized?

Getting Started

If you are an intermediate or advanced developer, and you already have a basic understanding of how blocklet works, you can start from Create first bl

How to configure security rules

Overview of Security Rules

How to Guides

- Application vs Blocklet

How to install local Blocklet as an application into the local Server?

问：如何将本地的 Blocklet 作为应用（而不是作为组件）直接安装到本地运行的 Server 中。答： 1. 在浏览器中访问 Server - Blocklet 列表页，点击 “安装应用” - “从 URL 安装“ 2. 将 blocklet 打包后，复制 blocklet bundle 目录

How to install a resource by URL after creating it

Step 1: After creating the resource, click "Install" and copy the link

Install Blocklet CLI

目前只能在 Linux(Ubuntu) 或 macOS 上安装和运行 Blocklet Server，Windows 平台下的用户请使用 Docker 来运行。The Blocklet CLI is a command-line tool for managing both Blocklets an

Integrate Blocklet Studio

Developers of ArcBlocklet should all be familiar with this diagram, which shows how AIGNE utilizes Blocklet Studio and Blocklet Store to form a flywhe

Known Issues or Limitations

- Can not access server/blocklet with DID Domain?

Claude

Preconditions

Cline

Preconditions

Cursor

Preconditions

Roo Cline

Preconditions

MCP Servers

Blocklet offers an official Model Context Protocol (MCP) server, enabling access to Blocklet data within MCP-compatible AI applications.

Windsurf

Preconditions

Witsy

Preconditions

Not using 80/443 ports?

Sometimes after you initialize and start a blocklet server and find that the server is not using 80/443 ports, this may happen for several reasons:

DID Connect

Developer Guide

OAuth Server

This is work in progress, will introduce more about how OAuth work in Blocklet Server Overview Blocklet Service can function as an OAuth server, suppo

Operation your blocklet

How to customize Blocklet Logo

Setup with AWS EC2

Running in AWS

Performance

Performance Modes in Blocklet Server

Permission Issues on Linux

Usually, it's recommended to run blocklet server as a non-root user for security reasons, and you should always use the same user that created the ser

Platform Overview

Publishing a Blocklet

Prerequisites

Publish your blocklet to the world

Publish to Blocklet Store

Read/Write blockchain in blocklet

- ArcBlock chain: @ocap/client - Ethereum chain: web3.js, ethers.js - Standard chain info for DID Connect: blocklet sdk and development

Reference Guides

- DID Connect

Resource-based Blocklet

If a Blocklet is only associated with resources and not linked to any components, it is defined as a Resource-based Blocklet. A Resource-based Blockle

Migration Guide

- 1.17.x 升级与迁移指南

Blocklet Manager

- Adding a component

Security

- blocklet security: sk, config, data backup - server security: sk, ssh, data-disk - access-key: passport - integrations

1.17.x Upgrade and Migration Guide

Overview

Add PWA Integration to Blocklet

PWA integration is currently in its early stages, and we will continue to improve the experience.Make sure the version of @blocklet-cli is greater tha

Setup Blocklet Server

Blocklet Server can run in various environments:

Setup DID Wallet

Why do I need DID Wallet?

Setup Node.js

You can safely skip this step if you have already Node.js v20+ installed on your development environment.Why Node.js? Most of the components in the Bl

Setup on Ubuntu + FNM

Ubuntu is a popular Linux distribution loved by the developer community, Blocklet Server can run on it with the following steps.

Setup on Ubuntu + Nodesource

For how to get your server up and running on ubuntu with nodesource, please checkout the recording here: https://asciinema.org/a/629699

The meaning of each input item in the release resource form

The source drawing contains no extractable text; preserve its exported image when regenerating this page.

Theming

This comprehensive guide covers all aspects of the Theming functionality, from basic usage to advanced features and technical details.

How to transfer a Blocklet

If you need to change the owner of a Blocklet, you need to transfer the Blocklet to achieve this. This article will introduce how to transfer a Blockl

Configure OAuth Server using Grafana.

Requirements

Understanding Blocklet

The core concepts in the Blocklet ecosystem and the relationships between the concepts are shown in the following diagram.

Understanding Blocklet Payment

this page is a draft and need to be updated

User and Passport

Blocklet Auth Service provides DID-based authentication and Passport-based access control for Blocklets.

Using Blocklet Logger

You can use @blocklet/logger to manage logs at your blocklet runtime, here are the steps:

Using Blocklet Preferences

What are Blocklet Preferences?

Run Blocklet using Docker container

Blocklet Server enables Blocklets to run in Docker containers, thereby providing better isolation for each.

Can not access server/blocklet with DID Domain?

If you can not access your blocklet or server with DID Domain (in the following screenshot)

WebHooks

What are Webhooks?

Welcome

Welcome to Blocklet the Web 3.0 Application Platform

When stuck in maintenance mode?

Blocklet server supports several maintenance operations directly from the server dashboard:

When stuck on a blank screen?

If your website shows a blank screen and refreshing and clearing cache does not help, please consider the following steps to recover:

Why can't see the uploaded Blocklet on the Blocklet Store?

When a user successfully uploads a feature to the Store (as shown below), we need to publish the Blocklet in the Store in order to see our Blocklet on

Setup with Docker

Starting a server with Docker

How to mange static asset cache?

The Blocklet Server is designed to cache specific assets within its routing engine to enhance performance. These assets include the Blocklet Logo, JS/

Setup with ArcBlock Launcher

Launching a server via ArcBlock Launcher

Blocklet SDK (Browser)

@blocklet/js-sdk is the client-side JavaScript SDK for Blocklet, helping developers build Blocklet apps.

SDK Client

The SDK Client provides the primary entry points for interacting with the @blocklet/js-sdk. It offers a main BlockletSDK class that bundles all availa

API Reference

Welcome to the API reference for the @blocklet/js-sdk. This section provides detailed, technical documentation for all the classes, methods, functions

AuthService

The AuthService provides a comprehensive API for managing all aspects of a user's account. It handles user profiles, privacy and notification settings

BlockletService

The BlockletService provides methods to access the metadata of a blocklet. This metadata, represented by the Blocklet object, contains essential infor

ComponentService

The ComponentService provides a convenient API for interacting with component blocklets that are mounted within your main application. It allows you t

Services

The @blocklet/js-sdk is organized into several service classes, each responsible for a specific domain of functionality. These services act as dedicat

FederatedService

The FederatedService provides an API for interacting with Federated Login Group settings. It allows you to retrieve information about the "master" app

TokenService

The TokenService provides a low-level API for direct interaction with session and refresh tokens. It handles the logic of storing and retrieving these

UserSessionService

The UserSessionService provides an API for fetching and managing a user's login sessions across different devices and applications. This service is es

Types

This section provides a detailed reference for the core TypeScript types and interfaces exported by the @blocklet/js-sdk. Using these types in your pr

Getting Started

This guide will walk you through the essential steps to install the @blocklet/js-sdk and make your first API call. Our goal is to get you up and runni

Authentication

The @blocklet/js-sdk is designed to make authentication seamless by automatically handling the complexities of token-based security. It manages sessio

Guides

Welcome to the practical guides for the @blocklet/js-sdk. This section is designed to get you up and running with common tasks quickly. Each guide pro

Making API Requests

The @blocklet/js-sdk provides powerful, pre-configured helpers for making API requests to your Blocklet services. These helpers, createAxios and creat

Managing User Sessions

The @blocklet/js-sdk provides a UserSessionService to help you fetch and manage user login sessions across different devices. This is particularly use

Overview

The @blocklet/js-sdk is a comprehensive JavaScript library designed to streamline interactions with Blocklet services. Whether you're building a front

Blocklet SDK (Node.js)

@blocklet/sdk is a Blocklet SDK for developers to build apps in Node.js and integrate systems.

API Reference

Welcome to the Blocklet SDK API Reference. This section provides a detailed breakdown of all the modules, classes, functions, and utilities exported b

Type Definitions

The Blocklet SDK is strongly typed to help you write more robust and maintainable code. This section provides a reference for the most common TypeScri

Authorization Middleware

The auth middleware is a powerful tool for adding a layer of authorization to your blocklet's routes. It works in conjunction with the session middlew

Authentication

In modern web applications, robust authentication and authorization are critical for security and user management. The Blocklet SDK provides a compreh

DID Connect

The Blocklet SDK provides a streamlined way to integrate decentralized identity into your application using DID Connect. This allows users to log in s

Session Middleware

The session middleware is a core component of the Blocklet SDK's authentication system. It acts as a gatekeeper for your Express.js routes, verifying

Core Concepts

The Blocklet SDK is built upon a few fundamental concepts that form the backbone of any application you build. Understanding these core pillars—Config

Configuration & Environment

The Blocklet SDK provides a robust and unified way to manage configuration and environment variables for your application. It aggregates settings from

Security Utilities

The Blocklet SDK includes a robust set of security utilities designed to protect your application's data and communications. These tools help you hand

Wallet Management

In the Blocklet SDK, a wallet is a fundamental cryptographic object that represents your application's identity. It's essential for signing data, auth

Getting Started

This guide will walk you through the essential steps to install the Blocklet SDK and get a minimal application up and running. Our goal is to help you

Guides

Welcome to the Blocklet SDK Guides. This section provides practical, step-by-step tutorials to help you solve common challenges and implement key feat

Component-to-Component Communication

In a Blocklet application composed of multiple components, enabling them to communicate with each other securely and reliably is essential. The Blockl

Using Web Server Middlewares

The Blocklet SDK comes bundled with a suite of powerful, ready-to-use middlewares for Express.js. These tools are designed to handle common web develo

Overview

The Blocklet SDK (@blocklet/sdk) is the essential toolkit for building applications on the ArcBlock platform. It simplifies development by providing a

Blocklet Service

The BlockletService is a powerful client that acts as the primary interface for your blocklet to interact with the underlying ABT Node services. It si

Services

The Blocklet SDK abstracts away the complexity of direct API calls by providing a suite of powerful service clients. These clients offer a clean, prog

Event Bus

The Event Bus provides a powerful publish-subscribe mechanism that allows different components within your blocklet and even across different blocklet

Notification Service

The Notification Service is a core component of the Blocklet SDK, enabling your application to send various types of notifications to users and subscr

Blocklet Server SDK (Node.js)

@blocklet/server-js is an official JS library for devs to connect web apps to Blocklet Server in Node.js

Advanced Usage

This section covers advanced topics for developers who need to go beyond the standard client methods or troubleshoot issues. Here, you'll learn how to

Debugging

When building an application with @blocklet/server-js, you might encounter issues with API requests, authentication, or data fetching. To help you tro

Raw Queries & Subscriptions

While the @blocklet/server-js library provides convenient helper methods for most common GraphQL operations, there are situations where you might need

API Reference

Welcome to the complete API reference for the @blocklet/server-js. This section provides detailed documentation for every GraphQL query, mutation, and

Mutations

Mutations are GraphQL operations used to create, update, or delete data on the Blocklet Server. The @blocklet/server-js library provides a set of conv

Data & Operations

This section details mutations for data management and operational tasks within Blocklet Server, primarily focusing on creating and managing backups,

Networking & Services

This section details the mutations available for managing networking and services on your Blocklet Server. You can perform actions such as configuring

Node & Blocklet Management

This section provides a detailed reference for mutations related to managing the lifecycle and configuration of the Blocklet Server node and the block

Publishing & Projects

This section details the mutations available for managing the entire lifecycle of your blocklet projects, from creation and release management to conn

User & Access Management

This section provides a detailed reference for mutations that manage users, roles, permissions, invitations, and access keys within a Blocklet. These

Queries

Queries are used to fetch data from the Blocklet Server. The @blocklet/server-js library provides a set of methods that correspond to the available Gr

Data & Operations

This section provides detailed references for GraphQL queries used to fetch operational data from your Blocklet Server. These queries are essential fo

Networking & Services

This section provides a detailed reference for all GraphQL queries related to networking and services on the Blocklet Server. These methods allow you

Node & Blocklet Management

This section provides a detailed reference for GraphQL queries used to manage and retrieve information about the Blocklet Server node and the blocklet

Publishing & Projects

This section provides a detailed reference for GraphQL queries used to manage publishing projects, releases, and associated resources. These queries a

User & Access Management

This section provides a detailed reference for queries related to managing users, roles, permissions, sessions, and access keys within Blocklet Server

Types

The Blocklet Server Client API utilizes a variety of GraphQL types to structure the data for queries and mutations. This section provides a comprehens

Authentication

The @blocklet/server-js library provides two primary methods for authenticating API requests: Auth Tokens and Access Keys. The appropriate method depe

Getting Started

This guide provides a step-by-step walkthrough to get you up and running with the @blocklet/server-js library. You'll learn how to install the client,

Overview

The @blocklet/server-js library is the official JavaScript client for interacting with the Blocklet Server GraphQL API. It provides a convenient and p

Blocklet Service

A suite of reusable, out-of-the-box services for blocklets, including authentication, notifications, and more, designed for both end-user management and developer integration.

Developer Guide

Welcome to the Developer Guide for Blocklet Service. This guide provides comprehensive information for developers who want to programmatically integra

Authentication Service

The Authentication Service provides a comprehensive solution for managing user identity, authentication, and session control within your blocklet. It

Discovery & SEO Services

Effective Search Engine Optimization (SEO) and content discoverability are critical for any web application's success. They ensure that your blocklet

Open Graph

Overview

OpenEmbed

This is a placeholder for a diagram. Do not edit this line directly.

EventBus Service

The EventBus Service is a messaging system that facilitates communication between different blocklets and the core system. It employs a publish-subscr

Image Service

The Image Service provides robust, on-the-fly image processing capabilities through a simple URL-based API. Developers can perform various manipulatio

KYC Service

The Know Your Customer (KYC) Service provides a standardized way to verify user identity attributes within your application. This service enables deve

MCP Service

The Model Context Protocol (MCP) Service provides a standardized way for blocklets and their components to expose AI-powered tools and capabilities. I

Notification Service

The Blocklet Service provides a robust, multi-channel Notification Service designed to streamline communication with your users. Instead of building a

OAuth Service

The OAuth Service enables developers to integrate third-party authentication providers and to expose a standard OAuth 2.0 interface for their own appl

Overview

Blocklet Service is a foundational layer that provides a suite of ready-to-use, reusable services for blocklets. It is designed to run within a Blockl

User Guide

This guide is for administrators and non-technical users, providing step-by-step instructions for configuring and managing the Blocklet Service throug

AIGNE Hub

The AIGNE Hub acts as a centralized control panel for integrating and managing AI capabilities across all your blocklets. It simplifies the administra

Blocklet Studio

Blocklet Studio is a no-code platform designed for administrators to create, manage, and publish new blocklets using pre-built templates. It streamlin

Dashboard

The Dashboard is the central administrative interface for your Blocklet Service. It functions as the primary hub for managing blocklets, monitoring th

Developers

The Developer Tools section provides administrators with access to a suite of powerful tools for monitoring, debugging, and understanding the inner wo

Logs

The Logs section provides administrators with direct access to real-time and historical log data generated by the blocklet. This tool is essential for

Performance

The Performance section provides administrators with essential tools to monitor the runtime health and resource utilization of blocklets. Consistent m

DID Connect

DID Connect is a comprehensive user and identity management center designed for administrators. It provides a centralized suite of tools for managing

Members

The Members section within DID Connect serves as the central administrative hub for user management. It provides a comprehensive interface for viewing

OAuth Apps

OAuth Apps functionality allows your service to act as an OAuth 2.0 provider. This enables third-party applications to securely access user data throu

Passports

A Passport is a verifiable digital credential issued to a user, serving as proof of identity or authorization within your application. As a fundamenta

Security

For administrators, the Security section is where you define advanced security rules, access policies, and response handling to protect your applicati

Settings

The Settings section within DID Connect is the central control panel for administrators to configure authentication policies, user verification proces

DID Spaces

DID Spaces provides a decentralized and secure storage solution integrated directly into your Blocklet Service. It allows administrators to manage app

Backups

The Backups feature, integrated with DID Spaces, provides a robust solution for safeguarding your application's data. It allows administrators to esta

Storage

The Storage section, part of the DID Spaces service, provides administrators with essential tools for monitoring and managing the storage resources al

Integrations

The Integrations section provides the tools necessary to connect your Blocklet Service with external systems and to manage programmatic access via the

Access Keys

Access Keys provide a method for granting programmatic access to your blocklet's services. They are used by applications, scripts, or external service

MCP Servers

The Model Context Protocol (MCP) provides a standardized framework that allows the main blocklet and its components to expose and consume AI-powered t

WebHooks

WebHooks provide a mechanism for your Blocklet Service to send real-time notifications to external services. By subscribing to specific system events,

Operations

The Operations section provides a centralized suite of tools for administrators to manage and monitor the production environment of their blocklets. I

Advanced

The Advanced settings section provides administrators with access to powerful, low-frequency administrative functions. These tools are intended for cr

Analytics

The Analytics section provides essential tools for understanding your blocklet's performance and user engagement. It allows administrators to monitor

Audit Logs

The Audit Logs service provides administrators with a comprehensive and chronological record of all activities that occur within the system. This feat

Notifications

Overview

Website

The Website service provides a centralized control panel for administrators to manage all aspects of a site's public-facing presentation. This include

Branding

The Branding section allows administrators to customize the application's visual identity to align with their brand. Proper branding ensures a consist

Domains

Proper domain configuration is fundamental to establishing your website's brand identity and ensuring users can easily access your services. This sect

Navigation

The Navigation section provides administrators with the tools to configure and manage the navigation menus for the website. This includes creating, ed

Theming

The Theming section provides administrators with granular control over the visual appearance of their website, ensuring a consistent and on-brand user

Blocklet Spec

@blocklet/meta library standardizes blocklet metadata, offering parsing & validation tools for devs

API Reference

The @blocklet/meta library provides a comprehensive suite of utility functions for programmatically interacting with blocklet.yml metadata. These help

Component & State Utilities

The @blocklet/meta library provides a comprehensive suite of utility functions designed to simplify interaction with the BlockletState object. Blockle

DID & Wallet Utilities

This section provides a detailed reference for utility functions related to Decentralized Identifiers (DIDs) and cryptographic wallets. These helpers

File Utilities

This module provides a set of low-level functions for interacting with blocklet.yml files on the filesystem. It includes utilities for locating, readi

Metadata Helpers

These utility functions are your toolkit for fetching, processing, and validating Blocklet metadata from remote sources. Whether you're resolving a Bl

Miscellaneous Utilities

This section covers a collection of specialized helper functions provided by @blocklet/meta. These utilities handle tasks such as parsing and creating

Navigation Utilities

These functions are the engine behind building dynamic user interfaces in a Blocklet-based application. They parse and process the navigation property

Parsing & Validation

This section provides a detailed reference for the functions used to read, parse, and validate blocklet.yml files. These utilities are the programmati

Security Utilities

The @blocklet/meta library provides a suite of security utilities for handling cryptographic operations. These functions are essential for ensuring th

URL & Path Utilities

This section provides a set of helper functions for creating URL-friendly strings and validating URL paths. These utilities are essential for generati

Getting Started

This guide provides a quick introduction to using the @blocklet/meta library. You'll learn how to install the package and perform the most common task

Overview

@blocklet/meta is a foundational library within the Blocklet ecosystem, serving as the definitive toolkit for managing blocklet metadata. It establish

Blocklet Specification (blocklet.yml)

The blocklet.yml file is the heart of every Blocklet. It's a YAML manifest that defines all the essential metadata about your application, serving as

Composition (Components)

Blocklet composition is a powerful feature that allows you to build complex, modular applications by assembling smaller, independent blocklets. This a

Core Metadata

Core metadata fields establish the fundamental identity of a Blocklet. They provide essential, at-a-glance information for identification, versioning,

Distribution & Links

This section covers the fields in blocklet.yml that define how your blocklet is packaged for distribution and provide essential links to its source co

Execution & Environment

The execution and environment configuration within your blocklet.yml is the blueprint for how your Blocklet runs. It specifies the necessary runtime,

Interfaces & Services

Blocklets interact with the outside world through interfaces and are enhanced with powerful, reusable functionalities via services. The interfaces pro

Monetization

Blocklet developers can monetize their work through a built-in payment system powered by OCAP (Open Capability Access Protocol) and NFTs. When a user

People & Ownership

Properly attributing authorship and defining roles for contribution and maintenance is crucial for a healthy open-source ecosystem. In blocklet.yml, y

Security & Resources

Security and resource management are crucial for creating trustworthy and interoperable Blocklets. The blocklet.yml specification provides two key fie

UI & Theming

This section details the navigation and theme properties within the blocklet.yml file. These properties are instrumental in defining a blocklet's cont

Blocklet Store

Blocklet Store: A decentralized platform for publishing and trading blocklet apps.

Best practice

NOTE: this page is in draft and is subject to change.

Blocklet Detail Page

Instructions on obtaining a meticulously configured blocklet detail page.

Frequently asked questions

Q：How to create a blocklet from scratch?

Publish your blocklet

TODO: this page is not yet complete

Choose License

TODO: this page need to be updated

Request Entity too large

Blocklet Store limit blocklet bundle size within a certain range for efficiency considerations, since larger bundles takes much more time to download

Developer Program Policies

Effective Date: 2024-06-01 Welcome to the Blocklet Store Developer Program. The following policies are designed to ensure a safe, trustworthy, and eff

Get your developer passport

If we want to publish an application to the Blocklet Store, we need the Blocklet Store to issue a Developer certificate to us.

Internationalize your blocklet

This page describes how to support multiple languages of an blocklet in the Blocklet Store.

Listing information

Welcome to the Blocklet Development Guide. This document is designed to provide all developers with a complete list of steps to develop blocklets, hel

How to fix logo and screenshot ratio?

To guarantee the effective presentation of the Blocklet detail page, we require Blocklet developers to submit images that adhere to certain specificat

Manage your blocklet

TODO: this page need to be updated, topics to be covered: auto publish, private publish

Prepare your Blocklet

Best practice Internationalize your blocklet

Error: Bundles with the same did cannot in different stores

If you encounter the above error when publishing your blocklet to the blocklet store, like the following screenshot

Publish your Blocklet

Permission Modes

At the heart of permission models of Blocklet Store is the DID and Verifiable Credential-based developer passport mechanism, an advanced system for

Supplying images

Welcome to the Blocklet Development Guide. This document is designed to help developers understand what images are required and how to add them to you

How to upload/update different links and videos on the Blocklet page?

How to create a new Blocklet and upload various links and videos:

Terms and Policies

- Developer Program Policies

What is blocklet store

NOTE: this page is in draft and is subject to change.

How to create high-quality screenshot?

Blocklet Store has always been committed to providing developers and users with an excellent experience. To further improve the display effect of bloc

Blocklet UI (React)

@blocklet/ui-react offers components for Blocklet dev to speed up development.

Components

This section provides a comprehensive reference for all available UI components in the Blocklet UI React library. Each component is documented with it

Component Management

Component management provides a suite of tools for dynamically installing, publishing, and managing blocklet components within a running application.

BlockletStudio

The BlockletStudio component provides a streamlined, embeddable user interface for publishing and managing blocklet resources. It operates by renderin

ComponentInstaller

The ComponentInstaller is a utility component that acts as a gatekeeper for features that depend on other blocklets. It verifies whether specified com

Layout

Layout components are the foundational building blocks for structuring your blocklet application's user interface. They provide a consistent and predi

Dashboard

The Dashboard component provides a pre-built, responsive layout for blocklet applications, typically used for administrative interfaces or user-centri

Footer

The Footer component provides a standardized, responsive footer for your application. It automatically populates its content—including branding, navig

Header

The Header component provides a responsive and customizable header for a Blocklet application. It automatically populates navigation links, the applic

Notifications

This section provides a detailed guide to the components and utilities available for implementing a real-time user notification system. The system is

User Management

The User Management suite provides a collection of pre-built React components designed to handle essential user-related functionalities. These compone

UserCenter

The UserCenter component is a comprehensive, pre-built interface that provides a complete user profile and settings management page. It integrates var

UserSessions

The UserSessions component renders a comprehensive data table for displaying and managing a user's login sessions. It provides a clear overview of all

Utilities

This section provides documentation for a collection of helper components, Higher-Order Components (HOCs), and utility functions. These tools are desi

Icon

The Icon component is a flexible utility built upon Material-UI's Avatar component. It is designed to render icons from multiple sources, including Ic

Core Concepts

This document explains the fundamental principles of the Blocklet UI React library. The core design philosophy is a metadata-driven approach, where UI

Getting Started

This guide provides a step-by-step walkthrough to install the @blocklet/ui-react library and render your first components. The objective is to have a

Hooks API

This section provides a detailed reference for the custom React Hooks available within the library. These hooks are designed to encapsulate and reuse

How-to Guides

This section provides practical, step-by-step guides for completing common tasks and implementing specific workflows using the library's components. E

Overview

The @blocklet/ui-react library provides a collection of essential React components designed to accelerate the development of applications, known as Bl

Blocklets

Developer documentation for ARC Blocklets: package and instance, local run, manifest, surfaces, and publish boundaries.

Read the agent-run dashboard

The Agent Observability dashboard answers what your agents did lately — failures, cost outliers, round counts and per-app roll-ups — and which of its numbers are not what their labels suggest.

Read one agent run in Traces

Open an agent-run trace in Agent Observability: which runs you are allowed to see, the list and its filters, the round-by-round timeline, the event inspector, and the trace assistant.

Read your AI usage in Agent Observability

Read the AI token ledger the Agent Observability blocklet renders — the personal face, the admin face, and the AFS paths both are bound to, with the reconciliation limits verified on a live deployment.

Author a Blocklet

Organize declared capabilities, data boundary, and Web-facing surfaces without conflating their contracts.

Check, build, and inspect

Run arc blocklet check, build, inspect, and dev with real outputs; treat each command as a different proof.

Create and run locally

Scaffold a Blocklet with arc blocklet create, validate it, and serve it with blocklet run or service start — no DID Space required.

Data and AFS

Use AFS paths, mounts, seed, and collection declarations from a Blocklet without binding the product contract to a storage engine.

Discuss Kit lineage

Locate the current Discuss Kit reference implementation for replicated discussion data — without claiming full legacy product parity.

Get started

Install arc, pick a recipe, and walk the local package → check → run path before any remote publish.

Lifecycle

Separate local observation, package checks, build artifacts, and remote publish/deploy as distinct lifecycle stages.

Manifest and capabilities

Declare a Blocklet with blocklet.yaml fields the current parser and checker accept — not wishlists.

Blocklets

Understand ARC's application package-and-instance unit, start locally, and keep authoring, runtime, and release boundaries explicit.

Package and instance

Keep the shipped Blocklet package distinct from a particular running or configured instance.

Publish and deploy

Split local daemon registration, local DID Space publish, remote --server publish, and Pages deploy — mark unverified paths experimental.

Reference

Index of Blocklet commands, manifest field groups, lifecycle states, and evidence boundaries for ARC 2.0.0-beta.28.

Reference applications

Study real packages under ArcBlock/arc blocklets/ as bounded examples — not universal templates or product-parity proofs.

Test and diagnose

Collect source, contract, runtime, and visible-surface evidence when a Blocklet fails — and map each failure to the right command.

Web surfaces

Use AUP for interface semantics and Web Device for Web content/site rendering inside a Blocklet — link out, do not copy primitive catalogs.

Create Blocklet

Create Blocklet: A command - line tool to build blocklets with one click.

Add new template

[!NOTE] this page is a draft and need to be updated

Available Scripts

The project created by the create-blocklet tool will have the corresponding npm script configured in package.json for developers to use.

Folder Structure

After creation, your project should look like this:

Composition folder structure

After creation, your project should look like this:

Create blocklet composition

What is a Combined Application

Create first blocklet

Create Blocklet is an officially supported Blocklet creation tool that allows you to quickly create Blocklets and automatically add them to your project.

How to create a single blocklet?

create-blocklet supports two creation modes, create single application and combined application of type monorepo

Customize your blocklet

In the root directory of every Blocklet application there exists a blocklet.yml file, which is the configuration file for the Blocklet application, including the project name, version, author, description of the project and other configuration information.

FAQs

How the documentation is organized?

vite-plugin-wss-hmr

This page need to be updated

How To Guides

- How to create a single blocklet?

Install Blocklet CLI

About why Blocklet Server is required and how to install and setup Blocklet Server please refer to Blocklet Developer Guide.

Manage blocklet release

The project created by the create-blocklet tool is automatically configured with the corresponding versioning script

Getting Started

If you are an intermediate or advanced developer, and you already have a basic understanding of how blocklet works, you can start from Create first bl

Reference Guides

- Folder Structure

Setup DID Wallet

About why DID Wallet is required and how to install and setup DID Wallet please refer to Blocklet Developer Guide.

Setup Node.js

About why Node.js is required and how to install Node.js please refer to Blocklet Developer Guide

Welcome

Welcome to Create Blocklet, your Blocklet Project Assistant

Where to go from here?

- Blocklet Server - Blocklet CLI - Blocklet Pages - Blocklet Actions - Blocklet SDK - Blocklet UI

vite-plugin-blocklet

Creator Studio

Explore Creator Studio, a powerful tool for content creators.

Forum

Forum Blocklet is a customized application package of Discuss Kit, designed specifically for users and teams who wish to set up a forum.

FAQs

Overview

Getting Started

Overview

How To Guides

Overview

How to use the "Knowledge Planet" Blocklet

Introducing

Blog

The Blog Blocklet is a customized application package of Discuss Kit, specifically designed for users who wish to set up personal or corporate blogs.

Knowledge Planet (Beta)

This blocklet is in beta and is not recommended for production use

Personal Website (Beta)

This blocklet is in beta and is not recommended for production use

Bookmarklet

The Bookmarklet Blocklet is a customized application pack of Discuss Kit, aimed at providing a simple and efficient solution for saving and managing w

Doc

The Doc Blocklet is a customized application pack for Discuss Kit, specifically designed for users and teams who need to build and maintain a knowledg

Welcome

Overview

DID Connect Guide

The open protocol and development kit for connecting users and dapps.

DID Connect UI (React)

@arcblock/did-connect-react aids DID Connect with components & session management.

Advanced Topics

Once you are comfortable with the core components like SessionProvider and DidConnect, you're ready to explore the more powerful and flexible features

Authentication Methods

While DID Wallet is the primary and most secure method for authentication, @arcblock/did-connect-react provides robust support for several alternative

Utilities

The @arcblock/did-connect-react library exports a collection of utility functions designed to simplify common tasks related to authentication flows, d

API Reference

This section provides a comprehensive reference for all the major TypeScript types used throughout the @arcblock/did-connect-react library. Understand

Core Components

The @arcblock/did-connect-react library is built around a few essential components that provide the foundation for integrating decentralized identity

Connection UI (DidConnect)

The DidConnect component is a pre-built, comprehensive UI solution for handling various decentralized identity (DID) connection flows. It provides a u

Session Management (SessionProvider)

The SessionProvider is the cornerstone of the @arcblock/did-connect-react library. It's a React Context Provider that encapsulates all session-related

Getting Started

This guide will walk you through the essential steps to integrate decentralized identity (DID) authentication into your React application using @arcbl

Hooks

The @arcblock/did-connect-react library offers a powerful set of React hooks that provide programmatic control and flexible data access. While the Ses

useConnect

The useConnect hook provides a powerful, programmatic way to open, close, and manage the DidConnect UI modal. It's the ideal solution when you need mo

useDid

The useDid hook is a convenient utility for easily extracting and working with specific DID-related information from the session.user object. It simpl

useOAuth & usePasskey

While the DidConnect component and useConnect hook provide a comprehensive, pre-built UI for all authentication methods, you may need to build a custo

Overview

The @arcblock/did-connect-react library provides a comprehensive set of React components and hooks designed to seamlessly integrate decentralized iden

UI Components

The @arcblock/did-connect-react library includes a set of pre-styled, supplementary UI components designed to help you display DID-related information

Address

The Address component is a specialized UI element designed to display Decentralized Identifier (DID) addresses in a clean, readable, and user-friendly

Avatar

The Avatar component is a simple and convenient way to display a user's profile picture. It can automatically generate a unique avatar based on the us

Button

The ConnectButton component offers a pre-styled and recognizable button for initiating the DID Connect authentication process. It simplifies creating

Logo

The Logo component provides a simple and consistent way to display the official DID Connect logo within your application. It's a straightforward visua

DID Connect SDK (Node.js)

@arcblock/did-connect-js helps Node.js apps integrate DID Connect for secure authentication

API Reference

This section provides detailed documentation of the core classes, constructors, methods, and options available in the DID Connect SDK. Understanding t

WalletAuthenticator

The WalletAuthenticator is the core class for server-side logic in a DID Connect session. It is responsible for creating authentication requests, sign

WalletHandlers

The WalletHandlers class is a high-level utility designed to seamlessly integrate the DID Connect workflow into an Express.js or similar server-side f

Agreement Claim

The Agreement Claim is a powerful tool for obtaining explicit user consent for documents like Terms of Service, Privacy Policies, or any other formal

Asset Claim

The Asset Claim is used to request that a user present proof of ownership for a specific on-chain digital asset, such as a Non-Fungible Token (NFT). T

Asset or VC Claim

The assetOrVC claim provides a flexible way to request that a user present proof of ownership of either an on-chain asset (like an NFT) or a Verifiabl

Auth Principal Claim

The authPrincipal claim is the cornerstone of any DID Connect session. It is the most fundamental and commonly used claim, designed to ask the user to

Claims Reference

DID Connect enables applications to request specific information or actions from a user's digital wallet. These requests are called "claims." Each cla

Encryption Key Claim

The encryptionKey claim is a powerful feature that allows your application to request a secret encryption key from the user's wallet. This key is dete

Key Pair Claim

The Key Pair Claim is a powerful feature that allows your application to request the user's wallet to generate a new cryptographic key pair. This is p

Prepare Transaction Claim

The prepareTx claim is a powerful tool for dApps that need users to complete and sign transactions, especially in payment and asset transfer scenarios

Profile Claim

The Profile Claim is used to request personal information from a user's DID Wallet. This is a foundational step for many applications, enabling featur

Signature Claim

The Signature Claim is a versatile tool used to request a user to sign arbitrary data using the private key associated with their DID. This cryptograp

Verifiable Credential Claim

A Verifiable Credential (VC) is a digital tamper-proof credential that can be used to prove something about the holder. The Verifiable Credential clai

Examples

Welcome to the examples section. Here, you'll find a collection of practical, end-to-end examples designed to help you quickly understand and implemen

Multi-Chain Connect

DID Connect is designed with interoperability in mind, extending its capabilities beyond the ArcBlock ecosystem. You can configure it to seamlessly in

Multi-Step Session

In many real-world applications, a single interaction isn't enough to complete a task. You might need to guide a user through a sequence of steps, suc

NFT Gated Access

This example demonstrates how to restrict access to specific content or features in your application to users who own a particular Non-Fungible Token

Simple Login

This example provides a step-by-step guide to implementing a basic user login system using DID Connect. The goal is to authenticate a user with their

Transaction Payment

This example demonstrates a common and powerful use case for DID Connect: requesting a user to sign and submit an on-chain transaction for payment. Th

Getting Started

This guide provides a minimal, step-by-step example to help you set up a basic DID Connect session in your Node.js application. By the end of this tut

Guides

Welcome to the DID Connect Guides. This section provides practical, step-by-step instructions for implementing common use cases and leveraging the adv

Chaining Workflows

DID Connect allows you to link multiple, distinct authentication sessions together, creating a seamless, multi-step process for the user from a single

Delegated Connect

Delegated Connect is an advanced feature that enhances security by allowing an application to perform DID Connect operations using a temporary or lowe

Handling Wallet Responses

Once you've defined the claims for a DID Connect session as shown in the Requesting Claims guide, the next critical step is to process the user's resp

Requesting Claims

In a DID Connect session, a "claim" is a specific piece of information or action you request from a user's wallet. This could be anything from their n

The DID Connect Workflow

A DID Connect session is a secure, decentralized authentication process that allows a user to interact with a decentralized application (DApp) using t

Overview

Welcome to DID Connect, a protocol designed for seamless and secure authentication using Decentralized Identifiers (DIDs). This library, @arcblock/did

How to add/switch accounts?

Click on the profile picture in the top right corner of the site to open the personal control panel Click on the account section below the avatar to s

How do I connect my social account to a wallet?

You can easily connect to some Blocklets using your social accounts, like Google or Apple, without setting up a DID Wallet right away.

Developer Guide

Overview

Specify the behavior of DID Connect via URL.

In some cases, users need to be able to quickly switch to a specified account in any link. This can be achieved by customizing the behavior of the DID

Quick Start

Integrating DID Connect is simplest by first creating a Blocklet. If you are unsure how to create a Blocklet, please refer to: Create Blocklet Docume

Introduction

This is where you will learn everything about DID Connect.

DID Connect Protocol

DID Connect Protocol is an open protocol that provides a secure and decentralized mechanism for connecting users with DApps by using cryptography tech

DID Connect Workflow

Glossary

FAQ

- How to use DID Connect in other frameworks

User Guides

- How do I update profile?

Configure OAuth login

- Configure GitHub login

Configure Auth0 Login

Auth0 is a third-party login management platform that allows easy integration of login methods such as Google, Apple, GitHub, etc. Blocklet Server sup

Configure GitHub login

Github provides OAuth login method, users can log in to GitHub OAuth-enabled applications through their GitHub accounts. For users, they no longer nee

Configure Google Login

Google provides the OAuth login method, allowing users to log in to applications that have integrated Google OAuth using their Google accounts. For us

Reference

- DID Connect Protocol

Request digest signature

This function is basiclly same as , the difference lies in the ability to simplify the data to be signed and protect the original content of the sign

Request multiple claims

In some cases, you may need do multiple signature in single one DID Connect, which can get a smoother experience, follow this article to learn how to

Request multiple steps

Similar to , you can do multiple signature in single one DID Connect, but there are some different features, follow this article to learn how to do m

Request NFT

In some cases, you may need check if your DID Wallet has specific NFT or VC, like if you've been to ArcBlock devcon 2021, follow this article to learn

Request payment

In some cases, you may need to pay some fees to a Blocklet, follow this article to learn how to request payment with DID Connect. The basic process is

Request for signature

In some cases, you may need to use your DID Wallet to sign some data, this signature can be verified by your DID Wallet, follow this article to learn

How to manage storage?

Click on the personal avatar in the upper right corner of the website, click to show the menu, and click on the personal center button . On the user c

Subscribe to DID Connect Events

Overview

How to change my passport?

During the process of accessing the blocklet, you may encounter some page prompts indicating that you do not have permission to access it. This means

How do I update profile?

Open any site (such as https://www.arcblock.io/en ), click on the person's profile picture in the upper right corner Click on the personal center to

Type cheatsheet

Agreement

How to manage login sessions?

Click on the profile picture in the top right corner of the website, click on the menu that appears, and then click on the personal center button On

How to use DID Connect in other frameworks

DID Connect currently only supports React, Vue.js, svelte, Solid.js, AngularJS are actively under development

DID Names

Naming Service based on NFT and verifiable credentials.

How to Guides

Quick help when you have setup your domain.

Bulk host domains using the didnames CLI

DID Names offers a didnames CLI tool to simplify managing domains hosted with other providers within the DID Names system.

FAQs

Overview

Hosting Domain

DID Names supports hosting domains registered with other registrars. After an NFT is issued for the domain, it can be used on the Blocklet platform.

How to hosting domains from Godaddy?

Different registrars have different ways of making modifications. This document will demonstrate some methods for registrars to modify name servers an

Enable DID Domain in Blocklet Server

The older version of Blocklet Server does not have DID Domain enabled by default. You need to manually configure the URL of the DID Domain service to

Get DID Domain

Before using the DID domain name, you need to obtain a domain name. You can follow the steps below to obtain a domain name.

How to host a domain from Namecheap on DID Names

If you purchased your domain on Namecheap, please consult the following documentation to update your nameservers.

Introduction

What Is a DID Name?

Terminology

What is the relationship between DID Domain and DID Names? A DID Domain name is a type of DID Name Service. Standardize the terms "top-level domain,"

Getting Started

Step-by-step instructions on how to get and use a domain on the blocklet platform:

Upgrade DID Names Subscription

If you want to update your DID Names subscription, from monthly to yearly billing, checkout video below:

Use DID Domain

There are two ways to add your DID domain to a running Blocklet:

DID Space SDK (Node.js)

@blocklet/did-space-js runs on Node.js to programmatically interoperate with DID spaces.

API Reference

Welcome to the complete API reference for the DID Space Client SDK. This section provides detailed documentation for every class, method, and command

NFT Commands

Specialized commands for handling NFT-related assets and their associated DID Documents. These commands streamline the process of storing digital asse

PutNftObjectCommand

The PutNftObjectCommand is a specialized command designed to upload a digital asset (like an image, video, or audio file) and simultaneously create or

Object Commands

Object Commands are the core tools for interacting with individual files (or "objects") within a DID Space. They provide the fundamental building bloc

DeleteObjectCommand

The DeleteObjectCommand is used to permanently delete an object from your DID Space. This action is irreversible.

GetObjectCommand

The GetObjectCommand is used to retrieve or download an object from your DID Space. The content of the object is returned as a readable stream, making

ListObjectsCommand

The ListObjectsCommand is used to retrieve a list of objects, which can be files or directories, from a specified path within your DID Space. It offer

PutObjectCommand

The PutObjectCommand is used to upload a new object or update an existing object in your DID Space. This command is versatile and can handle various d

SpaceClient

The SpaceClient is the primary interface for interacting with the DID Space API. It's the main entry point for the SDK, responsible for handling confi

Sync Commands

High-level commands for synchronizing the state between a local folder and a remote directory in a DID Space. These commands simplify the complex proc

SyncFolderPullCommand

The SyncFolderPullCommand is a high-level command designed to synchronize a remote directory from a DID Space to a local folder. It intelligently comp

SyncFolderPushCommand

The SyncFolderPushCommand is a high-level command designed to efficiently synchronize a local directory with a remote directory in your DID Space. It

Client Initialization & Auth

The SpaceClient is the primary interface for interacting with the DID Space network. Before you can upload files or manage data, you must first create

Core Concepts

This section delves into the fundamental principles and architectural patterns that power the @blocklet/did-space-js SDK. Understanding these concepts

Request Signing

To ensure the security and integrity of every interaction with your DID Space, all API requests are protected by a robust cryptographic signing mechan

Getting Started

Welcome to the DID Space Client SDK! This guide will walk you through the essential steps to get the SDK installed, configured, and to perform your fi

Guides

Welcome to the Guides section. Here you'll find practical, step-by-step tutorials designed to help you accomplish common tasks and implement specific

Managing Folder Previews

DID Space allows you to set a custom preview for any folder. This feature enables you to define how a folder is presented in applications, turning a s

Synchronizing Folders

Keeping a local directory in sync with a remote one in your DID Space is a common requirement for applications like static website hosting, data backu

Overview

Welcome to the DID Space Client SDK for JavaScript! This is a powerful, modern library designed for Node.js environments, enabling you to seamlessly i

Utilities

The @blocklet/did-space-js library exports a collection of utility functions designed to simplify common tasks you'll encounter while building your ap

DID Spaces Guide

DID Spaces User Guide: Learn features, characteristics and help channels.

DID Spaces UI (React)

@blocklet/did-space-react: A React component library for DID Spaces connection & display.

API Reference

This section serves as a reference for the key TypeScript types and interfaces used as props in the DIDSpaceConnect and DIDSpaceConnection components.

Types

This section provides a detailed reference for the core TypeScript types and interfaces used throughout the DID Space component library. Understanding

Components

The DID Space React library provides a set of core components to streamline the process of connecting to and interacting with DID Spaces. These compon

DIDSpaceConnect

The DIDSpaceConnect component provides a versatile button for initiating connections to a DID Space. It simplifies various authentication flows, inclu

DIDSpaceConnection

The DIDSpaceConnection component is a versatile UI card designed to display key information about a connected DID Space. It provides a clear and inter

Getting Started

This guide will walk you through the essential steps to integrate DID Space functionality into your React application. You'll learn how to install the

Overview

Welcome to the documentation for @blocklet/did-space-react. This library provides a set of React components designed to streamline the integration of

Prod Spaces data retention policy updated

Welcome to the ArcBlock community! Here, we are committed to providing you with a platform to share insights, report issues, seek help, and inspire in

AIGNE

Scenario

Application Example

To help developers understand how to integrate DID Spaces and ensure they function correctly, we have prepared the following examples.

DID Spaces v0.5.83: OAuth integrated DID Space

The updates introduce the following new features:

Reading and Writing to DID Space Using @blocklet/did-space-js

Overview

Backup Blocklet to DID Space.

Overview

Get DID Space

Overview

Get the endpoint of the DID Space when logging into the application for the first time.

Overview

Get the endpoint of DID Space

Overview

Get the endpoint of the DID Space during the installation startup process.

Overview

Data retention policy

Overview

Best Practices for Developers

Here are some guidelines for using DID Spaces.

Install the DID wallet

You can refer to https://support.didwallet.io/howToDownload for completing the wallet download and installation.

Frequently Asked Questions

- Data retention policy

User Guide

Overview

Developer Guide

Overview

MCP服务器 MCP Server

Overview

Welcome

Overview

Fix CORS error when connecting DID Space

Overview

Create a DID Space by installing Personal DID Spaces.

Summary

Receive DID Space for free

Overview

Draft: Purchase DID Space

Overview

Reference Terminology

DID Spaces

Draft: Default Space How to upgrade by payment?

This is just a draft, to be perfected.

Connecting to the DID Space using the Gateway Address

Overview

The automatic backup of Blocklet is stuck, how can it be quickly restored?

Overview

How to re-subscribe to an expired DID Space

Overview

Switch the DID Space bound to NFT Blender.

Overview

DID Spaces v0.4.26 released: subscription fully adopts pay-as-you-go & supports paid upgrade Default Space

Through the relentless efforts of engineers, DID Spaces officially released a new version v0.4.26. The main features of this update include subscripti

Store the data of the DID Wallet.

Overview

NFT Maker

Scenario

The application connects to the DID Space to store and display personalized data.

Overview

Pricing policy

Overview

Restore Blocklet

Overview

Restore the Blocklet to the Blocklet Server.

Overview

Restore Blocklet to Launcher

Overview

Store personal data

Overview

DID Spaces v0.3.75 released: Supports reading and writing component spaces

As of now, the new version v0.3.75 of DID Spaces has been released. This update includes added read and write component space functionality, as well a

Todo List --> 待办事项列表

Overview

DID Spaces v1.0.48: 支持预览 post/bookmark/blog/doc

执行摘要

DID Spaces v0.6.0: OAuth Integration in DID Spaces

The key feature of this update is the integration of OAuth accounts with DID Spaces. Additionally, there are several enhancements and fixes responding

Change log

- Draft: Purchase DID Space

Application case

Currently, several online applications have integrated with DID Spaces and are operating successfully. These applications include:

DID Wallet Guide

DID Wallet: Supports multiple chains, integrates identity and asset management.

Get Started

- What is DID wallet？

How to add a chain?

Open your wallet and go to the home page Click the upper right corner to enter My, and then click the upper right corner Settings Click the Chain Mana

How to add a token?

Which chains and tokens are supported?

How to add ERC721 NFT?

On the token list page, find the EVM token (depending on which chain your NFT is on) and enter the token details page; Select your account with ERC721

How to backup mnemonic code?

Open DID Wallet and go to the home page of assets. Click the icon in the upper right corner to enter the Settings page. Continue to click the icon in

How to Connect Dapp?

DID Wallet supports three ways to connect to DApps:

How to create a bridge?

Which accounts can initiate Bridge Move

How to create wallet?

The creation process of DID wallet is very simple in design. It only needs one click to complete the creation process of wallet.

How to download DID Wallet?

DID Wallet currently supports installation on multiple client platforms.

How to turn on Face ID?

1. Enter menu page

How to find the hash of a bridge transaction?

Find the account for your bridge transactions, click "View in Block Explorer" Find transactions of type Withdraw Token Click to enter transaction deta

How to generate backup file?

Backup files are one way to fully restore a wallet. For more information about how to restore a wallet, refer to other help documents.

How to get native ABT?

Currently, there is only one way to get Native ABT: first get ERC20 ABT assets on the Ethereum mainnet, then exchange ERC20 ABT to native ABT via Arc

How to provide your NFT/Passport to a Dapp

Where is your NFT

How to provide a profile to a Dapp

How to create a profile

How to recover bridge(deposit/withdraw) history?

We currently only support recovery withdrawal history. How to recover withdrawal history: Enter the wallet homepage, click on ABT Click Bridge. Cli

How to recovery a passport from a Dapp?

From Dapp web

How to recover the wallet?

DID Wallet supports two ways to recover your Wallet:

How to swap ABT to Ethereum Mainnet

Currently, there is only one way to transfer your native ABT to Crypto Exchange.

Manage Asset

- How to add a token?

Manage Wallet

- How to turn on Face ID?

Q&A

- How to find the hash of a bridge transaction?

What can the scanning function do?

DID Connect, is the most important function of scanning the DID Connect QR code and performing subsequent operations.

What if I forget wallet password?

The DID wallet is a non-custodial wallet that does not store any information elsewhere. If your password is lost or forgotten, we can NOT help you get

What is DID?

The experience and use of decentralized identities implemented by DID technology is very different from traditional digital identities: First of all,

What is DID wallet？

DID Wallet is an advanced digital wallet that supports both centralized identity and digital asset management. DID wallet supports ArcBlock Asset Chai

What is mnemonic code?

Mnemonic is another form of plaintext private key, which was first proposed by BIP39, and its purpose is to help users remember complex private keys.

What is revoke waiting period?

Revoke Waiting period

What is slasher?

Slasher

What is stake?

In the Arcblock blockchain system, staking is a way to gain benefits privileges and prevent malicious behavior. Simply put, staking is like temporaril

Which chains and tokens are supported?

DID Wallet supports ArcBlock Chain, Ethereum Mainnet, EVM Compatible Chain (like BNB Smart Chain), and more different chains in the future.

Why wallet has multiple addresses?

When a new DID Wallet is initialized, there are three addresses by default. Respectively is:

AIGNE DocSmith

AIGNE DocSmith is a powerful, AI-driven documentation creation tool built on the AIGNE Framework. It automates the creation of detailed, structured, and multi-language documentation directly from your source code.

Configuration Reference

The config.yaml file is the core control panel for your documentation generation. By adjusting its settings, you can control how AI generates document

Initial Setup

This guide provides a step-by-step walkthrough of the interactive setup process for AIGNE DocSmith. This procedure runs automatically the first time y

Manage Preferences

Have you ever wished your AI assistant would remember your instructions? This guide explains how to view, remove, and toggle your saved preferences fo

Troubleshooting

This guide helps you diagnose and fix common issues when using AIGNE DocSmith. If you encounter problems during generation, publishing, or configurati

Getting Started

This guide provides a direct, step-by-step procedure for installing AIGNE DocSmith and generating your first set of documents. The process is designed

Guides

This section provides structured, step-by-step instructions for performing common document tasks with AIGNE DocSmith. Each guide is designed to walk y

Add a Document

Ever find your documentation has a gap? The aigne doc add-document command provides a straightforward, interactive way to introduce new topics into yo

Cleanup Workspace

Need to reset your project or remove sensitive data? This guide explains how to use the aigne doc clear command to safely remove generated files, conf

Evaluate Documents

Wondering if your documents hit the mark? This guide introduces the evaluate command, a powerful tool that systematically assesses your documents qual

Create Document

This guide walks you through creating a complete set of documents from your project's source files using a single command. The process is designed to

Interactive Mode (Beta)

Feeling overwhelmed by command-line options? This guide explains how to use the interactive mode, a conversational interface that simplifies every ste

Manage Update History

Ever wondered what changes were made to your documents and when? AIGNE DocSmith keeps a detailed log of every update. This guide will show you how to

Publish Documents

Once your documents are created, the final step is to make them available online. This document provides a step-by-step guide on how to publish your d

Remove a Document

Keeping your documentation accurate involves not just adding content, but also pruning it. This guide details how to use the aigne doc remove-document

Localize Document

Making your documents available in multiple languages is essential for reaching a global audience. This guide provides a step-by-step process for usin

Update Content

This guide explains how to use the update command to modify existing documents. You can update document content, add or update diagrams, and remove di

Update Document

As your project evolves, your documentation needs to keep pace. This section provides a central hub for all tasks related to modifying your documentat

Overview

AIGNE DocSmith is a documentation tool that uses AI to analyze your project's source code and generate documentation automatically. Built on the AIGNE

Release Notes

Stay up-to-date with the latest developments for AIGNE DocSmith. This page provides a chronological record of new features, performance improvements,

DIF Hackathon Guide (2024)

2024 DIF Hackathon Guide: Introduction to Key Points.

FAQ

Q1: What to do if I failed to connect to test store

Building on DID Connect

Introduction

Building with DID Wallet

The DID Wallet Dapp template provides a powerful foundation for building decentralized identity applications. Following this guide, you can create a f

Building on AIGNE

Introduction

Building on DID Spaces

Introduction

DIF Hackathon Guide (2024)

Welcome to the ArcBlock DIF Hackathon! As proud Decentralized Identity Foundation (DIF) members, we are thrilled to invite developers of all skill le

Identity and Data Spaces

Developer documentation for ARC caller context, DID-scoped storage, session data views, and their verified boundaries.

Caller context

ARC resolves caller identity and optional instance membership on trusted server context, not from a UI message or a path supplied by the client.

Core model

Separate verified caller context, DID-scoped storage, and the documentation term Data Space before choosing an integration path.

Current contract boundaries

Know the limits of the present identity and data-space documentation before you make a runtime, deployment, or administration promise.

What “Data Space” means here

Use Data Space as a way to discuss data context and visibility, not as the name of an already-public ARC SDK surface.

DID Connect in ARC

ARC embeds DID Connect service code to resolve trusted credentials into caller information and optional instance membership context.

DID-scoped storage

Mount a DID Space as an AFS provider when data needs a DID-scoped logical storage boundary, and treat transport capabilities as unequal.

Evidence and version boundaries

Re-verify identity and data-space claims against a named ARC release using source, tests, and isolated CLI runs.

Integrate identity

Treat verified caller context as the handoff into session views and provider policy, then add DID Connect only where the runtime already resolves credentials.

Inspect local spaces

Run arc space list, sync, tree, path, and rm against an isolated root on ARC 2.0.0-beta.42 and read the real outputs.

Identity and Data Spaces

Understand ARC caller context, DID-scoped storage, session data views, and the boundaries that keep them separate.

Reference and boundaries

Check which identity and data-space statements are current contracts, which are architecture terms, and which still require release-specific evidence.

Session data

Read the caller-specific, temporary, and optional space views that ARC composes for one session.

User, temporary, and space views

A session receives a constrained AFS view: its own user data, session-local temporary data, and an optional caller space view.

Blocklet Launcher

Blocklet Launcher: ArcBlock's hosting service to boost Blocklet startup efficiency.

Data retention policy

After the invoice is overdue, the data will not be immediately deleted. After the due date, it is divided into two stages, Past-due and Canceled, wher

Launch an application on my own Blocklet Server

Blocklet Launcher supports launching applications on existing Blocklet Servers, whether they are launched on your own server or in dedicated spaces pu

Launch the application in a dedicated space.

Dedicated Space is an independent server instance that adopts a pre-paid charging method.

Unable to install certain Blocklets in an On-demand space

Reason

Launch on-demand application

The billing method of On-demand space is based on the number of components and usage duration. This more refined billing model allows users to subscri

FAQs

What is the difference between on-demand space and dedicated space?

Getting Started

Overview

Reference Guides

Understanding pricing and data retention policies.

Welcome

What is blocklet launcher?

Pricing policy

The latest version of Launcher has upgraded the payment method, with the aim of making it easier for users to purchase and maintain space. The new pay

Transfer subscription of application

Applicable scenarios

Media Assets

Official ArcBlock and DID logos, lockups, and color values. Download SVG and PNG from this board.

ArcBlock logos

Official cube, wordmark, horizontal and vertical lockups, and the ABT token mark. Each lockup on a light plate and a dark plate, with SVG and PNG downloads.

DID logos

Official DID, DID Names, DID Spaces, DID Connect, and DID Wallet marks. Each lockup on a light plate and a dark plate, with SVG and PNG downloads.

Media Assets

Official ArcBlock and DID logos, lockups, and color values. Download SVG and PNG from this board.

Usage

Which official file to use on light or dark backgrounds, and the color stops taken from the official SVG.

Media Kit

Media Kit: 📸 A simple yet powerful Blocklet for media asset uploading and hosting. Features drag-and-drop, image tagging, and easy CDN integration. Perfect for managing digital assets! ✨

API Reference

Welcome to the API reference for the Blocklet Uploader packages. This section provides comprehensive details on all exported components, functions, pr

Component Props

The

Frontend: @blocklet/uploader

The @blocklet/uploader package provides a powerful and highly customizable React component for handling file uploads within the Blocklet ecosystem. It

Available Plugins

@blocklet/uploader extends the core Uppy library with several powerful, custom-built plugins. These plugins integrate seamlessly with the Blocklet eco

and Hooks

For more advanced use cases, you might need to trigger the Uploader from a different part of your application, or programmatically control its behavio

initCompanion(options)

The initCompanion function initializes and configures the Uppy Companion middleware, which is essential for enabling users to import files from remote

initDynamicResourceMiddleware(options)

The initDynamicResourceMiddleware is a powerful Express middleware designed to serve files from one or more specified directories dynamically. Unlike

Backend: @blocklet/uploader-server

The @blocklet/uploader-server package provides a suite of Express.js middleware designed to handle various file handling tasks on the backend of your

initLocalStorageServer(options)

The initLocalStorageServer function is the core middleware for handling direct file uploads from a user's device to your blocklet's local storage. It

initStaticResourceMiddleware(options)

The initStaticResourceMiddleware is a powerful Express middleware designed to serve static assets from other installed blocklets. This allows your app

Utility Functions

The @blocklet/uploader/utils module exports a collection of helper functions designed to simplify common tasks associated with file handling, URL mani

Concepts

The @blocklet/uploader packages are designed to be both powerful and easy to integrate. To get the most out of them, it's helpful to understand the co

Internationalization (i18n)

The @blocklet/uploader component is designed with a global audience in mind, offering robust support for multiple languages and text customization. Th

Integration with Media Kit

The @blocklet/uploader package is designed for seamless, zero-configuration integration with the Media Kit blocklet. Media Kit provides a centralized

Integration with Uppy

The @blocklet/uploader package is built directly on top of Uppy, a sleek, modular, and open-source file uploader for the web. Instead of building a fi

Backend Setup (@blocklet/uploader-server)

This guide will walk you through setting up the @blocklet/uploader-server package in your Express.js-based blocklet. This package provides the necessa

Getting Started

This guide will walk you through the essential steps to integrate a powerful file uploader into your blocklet. We'll cover both the frontend UI compon

Frontend Setup (@blocklet/uploader)

This guide will walk you through the process of installing and integrating the @blocklet/uploader React component into your Blocklet. This component p

Configuring Plugins

The @blocklet/uploader component is built on the flexible and powerful Uppy file uploader. This architecture allows for extensive customization throug

Creating a Custom Plugin

The @blocklet/uploader is designed for extensibility. While it comes with several powerful built-in plugins, you can easily add your own custom tabs t

Guides

Welcome to the Guides section. Here you'll find practical, task-oriented walkthroughs to help you implement common features and customizations for the

Handling Uploads

After a file is successfully uploaded, you often need to perform actions on both the client and server. This guide explains how to use the onUploadFin

Integrating Remote Sources (Companion)

To allow users to import files from external sources like direct URLs or services like Unsplash, you need to set up Uppy's Companion service on your b

Overview

The Blocklet Uploader is a comprehensive file upload solution designed for blocklets, built upon the robust and extensible Uppy file uploader. It cons

NFT Studio

Enables digital creators to have complete creative control and generate cutting-edge NFT experiences for their audiences.

Concept Guide

What's NFT?

By using the NFT Blender + AI tool, 6000 NFTs with a theme of the Year of the Dragon for the Spring Festival can be quickly created.

Put some result pictures first

Ecological projects

Summarize

FAQs

Overview

How to Bind a Domain to a Blocklet (Google Domain)

Why do I need to bind a domain name to Blocklet?

How to Build a Complete NFT Program

Overview

How to Mount NFT Series Blocklets Locally

Overview

How to publish NFT Templates to the Blocklet Store

Summary

How to Upload NFTs to DID Spaces Using the SDK

Overview

How to use AIGC to generate NFT image resources

Overview of AIGC

How to use NFT Blender to manage materials

Overview

How to use NFT Maker to create Collection

You can learn more by going to

How to use the SDK to recycle or redistribute NFTs

Overview

Midjourney

Overview

Getting Started

Overview

How To Guides

Overview

Welcome

Overview

Official Projects

You can learn more by going to

Reference Guide

Overview

NFT Studio + Payment Kit

How to add Stripe payment method to receive currencies other than Virtual Currencies You need to go to Payment Kit to add new payment methods, restart

Sample Projects

Overview

Stable Diffusion（DrawThings）

Overview

Stable Diffusion（InvokeAI）

Overview

Payment Kit UI (React)

@blocklet/payment-react is a React library for blocklet payment systems with Payment Kit.

Components

The @blocklet/payment-react library offers a comprehensive suite of pre-built React components designed to accelerate the development of payment, subs

Business Logic Components

Business Logic Components are specialized React components designed to handle complex, stateful operations related to subscription and invoice managem

Auto-Topup Components

The auto-topup feature ensures uninterrupted service by automatically recharging a user's credit balance when it falls below a specified threshold. Th

OverdueInvoicePayment

The OverdueInvoicePayment component is a specialized tool designed to handle the payment of overdue invoices for a specific customer or subscription.

ResumeSubscription

The ResumeSubscription component provides a straightforward UI for users to resume a canceled subscription. It renders a dialog that guides the user t

Checkout Components

This section covers the high-level components that serve as entry points for various checkout flows. These components are designed to provide a comple

CheckoutDonate

This document provides a detailed guide to implementing the CheckoutDonate component, a flexible solution for adding donation functionality to your ap

CheckoutForm

The CheckoutForm component is the primary entry point for handling payment links and checkout sessions. It serves as a high-level wrapper that automat

CheckoutTable

The CheckoutTable component provides a complete, out-of-the-box solution for subscription checkouts. It fetches and renders a pricing table, allows us

History Components

The @blocklet/payment-react library provides a suite of history components designed to give your users a clear and detailed view of their past activit

CreditGrantsList

The CreditGrantsList component renders a paginated table displaying a customer's credit grants. It provides a clear overview of each grant's status, r

CreditTransactionsList

The CreditTransactionsList component renders a detailed and paginated table of all credit transactions, providing a clear log of credit usage and adju

CustomerInvoiceList

The CustomerInvoiceList component is designed to render a customer's invoice history. It fetches and displays invoice data from the payment service, o

CustomerPaymentList

The CustomerPaymentList component renders a detailed history of a customer's payments. It automatically handles fetching, pagination via infinite scro

UI Components

The @blocklet/payment-react library provides a set of granular UI Components designed to give you maximum flexibility when building your payment and c

Form Elements

The @blocklet/payment-react library provides a collection of granular input components designed to simplify the creation of custom payment and contact

AddressForm

The AddressForm component provides a pre-built UI for collecting billing address information. It integrates seamlessly with react-hook-form and includ

CountrySelect

The CountrySelect component provides a user-friendly dropdown for selecting a country. It features a searchable list, displays country flags, and offe

CurrencySelector

The CurrencySelector component provides a user-friendly interface for selecting a payment currency from a list of available options. It displays each

PhoneInput

The PhoneInput component provides a user-friendly, international phone number input field. It integrates seamlessly with react-hook-form and includes

PaymentSummary

The PaymentSummary component is a crucial UI element for any checkout process. It provides a detailed breakdown of the order, including all line items

PricingTable

The PricingTable component is a flexible UI element designed to display subscription plans and pricing options in a structured, responsive table. It a

Getting Started

This guide will walk you through the essential steps to install @blocklet/payment-react and integrate a basic, functional payment form into your appli

Guides

Welcome to the guides section. Here, you'll find in-depth articles on advanced topics that go beyond individual component usage. These guides are desi

Theming

Learn how to customize the appearance of payment components using the built-in theme provider and Material-UI theme options. The @blocklet/payment-rea

Utilities

The @blocklet/payment-react library exports a suite of utility functions and classes designed to simplify common tasks such as making API requests, ma

Hooks

The @blocklet/payment-react library provides a set of custom React hooks to encapsulate and simplify common logic, such as handling real-time events o

useMobile

The useMobile hook is a convenient utility for detecting if the application is being viewed on a mobile-sized device. It helps in creating responsive

useSubscription

The useSubscription hook provides a simple way to subscribe to real-time events from the payment service using WebSockets. It handles the connection,

Overview

This document provides a high-level overview of the @blocklet/payment-react library. By the end of this guide, you will understand its core features,

Providers

To enable payment functionalities in your application, you must first wrap your components with the appropriate context providers. These providers use

DonateProvider

The DonateProvider is a crucial context provider that manages the state and settings for all donation-related components within your application. It h

PaymentProvider

The PaymentProvider is the cornerstone of the @blocklet/payment-react library. It functions as a context provider that must wrap your application or t

Payment Kit SDK (Node.js)

@blocklet/payment-js: A JS SDK for Payment Kit API interaction in blocklet payments.

API Reference

The API reference provides detailed documentation for every resource and method available in the PaymentKit Node.js SDK. Each resource has a dedicated

Checkout Sessions

A Checkout Session represents your customer's session as they are making a payment. It is the primary mechanism for collecting payment details to crea

Coupons

Coupons are a powerful tool for offering discounts on your products and services. A coupon object contains information about a specific discount, such

Credit Grants

Credit Grant objects are used to issue credits to your customers, which can then be applied to future invoices, particularly in usage-based or credit-

Credit Transactions

Credit Transaction objects record every change to a customer's credit balance. This includes grants, consumptions, adjustments, and expirations. You c

Customers

Customer objects allow you to create and manage the customers your business serves. They store essential information such as contact details, addresse

Invoices

The Invoices API allows you to create, manage, and finalize invoices. It provides comprehensive functionality for handling various billing scenarios,

Meter Events

Meter Events are records of usage that you report to a specific Meter. Each event represents a quantifiable action performed by a customer, which can

Meters

Meters are used to define and track usage for credit-based billing. They represent a specific feature or resource that you bill for, such as API calls

Payment Currencies

The Payment Currencies API allows you to manage the currencies accepted for payments. This includes standard blockchain-based tokens (like ERC-20 or A

Payment Intents

A Payment Intent is an object that represents your intent to collect payment from a customer and tracks the lifecycle of the payment process. It is a

Payment Links

A Payment Link is a shareable, reusable page to sell a product or service. You can create a link for a specific set of products and prices and share i

Payment Methods

Payment Method objects represent the different ways a customer can pay, such as with Stripe (credit cards, bank accounts) or through various cryptocur

Prices

A Price object defines how much and how often to charge for a specific product. It associates a price amount and currency with a Product. For example,

Products

Product objects represent the goods, services, or digital credits you offer to your customers. You can think of them as the items in your catalog. Eac

Promotion Codes

A Promotion Code is a specific, user-facing code that customers can enter at checkout to receive a discount. Each Promotion Code is linked to a parent

Refunds

Refund objects represent the return of funds to a customer for a previous charge. You can create new refunds, retrieve details for an existing one, an

Settings

The Settings API allows you to manage various configurations within PaymentKit, such as creating donation widgets or setting up notification handlers.

Subscription Items

Subscription Items represent a specific product and price that a customer is subscribed to. They are components of a Subscription and are essential fo

Subscriptions

Subscriptions are used to manage recurring payment plans for customers. The Subscriptions API allows you to create, retrieve, update, cancel, and mana

Webhook Endpoints

Webhook endpoints allow PaymentKit to send asynchronous event notifications to your server. This is essential for handling events like successful paym

Core Concepts

The PaymentKit Node.js SDK is designed to handle a wide range of billing scenarios. This section provides practical guides for implementing the most c

Credit-Based Billing

Credit-based billing is a flexible, pay-as-you-go model perfect for services where usage varies, such as API calls, data storage, or compute time. Ins

Credit Top-Up

PaymentKit's credit-based billing system allows customers to replenish their credit balance through top-ups. You can configure a credit currency to be

Discounts

PaymentKit offers a flexible discount system using Coupons and Promotion Codes. This allows you to provide various types of discounts to your customer

One-Time Payments

PaymentKit offers several flexible ways to handle one-time charges for goods or services. This guide will walk you through the three primary methods a

Subscriptions

Subscriptions are the cornerstone of recurring revenue, allowing you to charge customers on a repeating schedule for your products and services. In Pa

Webhooks

Webhooks are a vital mechanism for building reliable and scalable integrations with PaymentKit. Instead of constantly polling the API for status chang

Environments

The PaymentKit SDK operates in two distinct modes: Live Mode for processing real transactions and Test Mode for development and testing. Every API req

Getting Started

This guide will walk you through the essential steps to get the PaymentKit Node.js SDK up and running in your project. In just a few minutes, you'll i

Overview

The PaymentKit Node.js SDK provides a convenient wrapper around the PaymentKit REST API, enabling you to build powerful and flexible payment experienc

SDK Structure

The PaymentKit Node.js SDK is built on a modular, resource-oriented architecture. This design ensures that interactions with different parts of the Pa

Web Device

Developer documentation for building static sites with ARC Web Device.

AUP layout boundary

Use AUP as source-first page layout input, while keeping direct static-tree rendering separate from layout component composition.

Author a site

Web Device documentation draft: configure, compose, and extend an existing site.

Component resolution

Find the component that the target runtime actually resolves; do not treat a historical component name as a stable universal catalog.

Layout components

Navigation hub for default-theme and site layout components — one page per unit; not a multi-component reference body.

Use and override components

Put reusable Web presentation in components, then override deliberately at the theme or site layer.

`access-gate`

Web Device layout component `access-gate`: purpose, boundaries, author entry, evidence, and sample honesty.

`content-card`

Web Device layout component `content-card`: purpose, boundaries, author entry, evidence, and sample honesty.

`detail-content`

Web Device layout component `detail-content`: purpose, boundaries, author entry, evidence, and sample honesty.

`detail-sidebar`

Web Device layout component `detail-sidebar`: purpose, boundaries, author entry, evidence, and sample honesty.

`event-card`

Web Device layout component `event-card`: purpose, boundaries, author entry, evidence, and sample honesty.

`event-hero`

Web Device layout component `event-hero`: purpose, boundaries, author entry, evidence, and sample honesty.

`hero-banner`

Web Device layout component `hero-banner`: purpose, boundaries, author entry, evidence, and sample honesty.

`news-ticker`

Web Device layout component `news-ticker`: purpose, boundaries, author entry, evidence, and sample honesty.

`page-sections`

Web Device layout component `page-sections`: purpose, boundaries, author entry, evidence, and sample honesty.

`page-stack`

Web Device layout component `page-stack`: purpose, boundaries, author entry, evidence, and sample honesty.

`platform-stack`

Web Device layout component `platform-stack`: purpose, boundaries, author entry, evidence, and sample honesty.

`portal-footer`

Web Device layout component `portal-footer`: purpose, boundaries, author entry, evidence, and sample honesty.

`portal-header`

Web Device layout component `portal-header`: purpose, boundaries, author entry, evidence, and sample honesty.

`post-hero`

Web Device layout component `post-hero`: purpose, boundaries, author entry, evidence, and sample honesty.

`product-frame`

Web Device layout component `product-frame`: purpose, boundaries, author entry, evidence, and sample honesty.

`product-frame-gallery`

Web Device layout component `product-frame-gallery`: purpose, boundaries, author entry, evidence, and sample honesty.

`product-hero`

Web Device layout component `product-hero`: purpose, boundaries, author entry, evidence, and sample honesty.

`product-showcase`

Web Device layout component `product-showcase`: purpose, boundaries, author entry, evidence, and sample honesty.

`related-content`

Web Device layout component `related-content`: purpose, boundaries, author entry, evidence, and sample honesty.

`site-home`

Web Device layout component `site-home`: purpose, boundaries, author entry, evidence, and sample honesty.

site `container-members`

Site layout component `container-members` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `content-card`

Site layout component `content-card` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `editorial-feed`

Site layout component `editorial-feed` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `event-detail`

Site layout component `event-detail` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `globe`

Layout component `globe`: COBE WebGL globe as figure, scene, or backdrop. Copy the AUP, set variant and optional markers. Not the AUP globe primitive.

site `glossary-index`

Site layout component `glossary-index` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `landing-hero`

Site layout component `landing-hero` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `landing-shell`

Site layout component `landing-shell` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `leaf-shadow`

Layout component `leaf-shadow`: looping gobo overlay (video or procedural canvas) with mix-blend-multiply. Set src to a 100–400 KB clip; use gobo-loop to mint new clips from a scene sentence.

site `object-card`

Site layout component `object-card` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `page-breadcrumb`

Site layout component `page-breadcrumb` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `period-index`

Site layout component `period-index` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `product-meta`

Site layout component `product-meta` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `related-objects`

Site layout component `related-objects` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `site-footer`

Site layout component `site-footer` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `term-meta`

Site layout component `term-meta` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

site `topic-meta`

Site layout component `topic-meta` under `.web/components`: purpose, boundaries, evidence, and sample honesty.

`tag-list`

Web Device layout component `tag-list`: purpose, boundaries, author entry, evidence, and sample honesty.

`tech-hero`

Web Device layout component `tech-hero`: purpose, boundaries, author entry, evidence, and sample honesty.

`technology-card`

Web Device layout component `technology-card`: purpose, boundaries, author entry, evidence, and sample honesty.

Restrict who can read a page

Declare a collection default, tighten individual records with access, and check the serve-time gate before you publish.

Content access reference

Fields, resolution order, admit rules, HTTP headers, and discovery boundaries for the Web Device serve-time access gate.

Content objects, metadata, and locales

Keep each item as a directory-shaped object and manage body and metadata with an explicit read order.

Web Device Content Markdown

Separate Markdown in content items from an AUP text primitive and .web components, then start from verified source-plus-rendered examples.

Content site

Add a content collection by preserving directory-shaped objects and declaring an explicit list/detail presentation contract.

Custom component

Add one complete site component, verify its resolver contract, then compose it from a page rather than copying presentation trees.

Customize a theme and tokens

Customize one site-owned token layer first; treat local component overlays as a separate, explicitly verified mechanism.

Diagnose a site

Start with the narrowest failing boundary, then distinguish source errors, build errors, and a stale or incorrect local preview.

Directory and file conventions reference

Locate each public Web Device concern by responsibility, not by a copied historical tree.

Build a first site

Create the smallest static site that Web Device can render directly on your machine.

Get started

Web Device documentation draft: move from scope to a first site that runs locally.

Hero lab · webgl-hero backgrounds

Working catalog of landing-hero heroVisual candidates built on the webgl-hero widget, with exact config and honest verdicts.

In-page review mode

Open a rendered Web Device page with ?review=1, leave text-anchored feedback next to the content item, and keep two-level status for page approval and item processing.

Install ARC CLI

Install the current ARC release and confirm that your shell can run arc.

Markdown directives & structures

Navigation hub for content-reader MD directives and structures — one page per unit; not a multi-unit reference body.

Use cards in Markdown

Organize documentation entry points with link-card, info-card, and card-group, then inspect their read-only rendered result in place.

Embed external and internal content in Markdown

Write a supported external or same-site Markdown embed, then inspect the actual frame rendered on this page — source and live result together.

Write tables and callouts in Markdown

Place GFM tables and GitHub-style callouts in a Web Device content item, then inspect their actual rendered output on the same page.

Write and embed Markdown slides

Turn one Markdown content record into a readable deck, mount its player with a named layout, and embed it as a same-site 16:9 player — source and live player on this page.

Write step-by-step guides in Markdown

Use the steps and step directives to organize a read-only tutorial, then inspect the actual numbered result and nesting rule.

`:::action-card`

Place navigation choices in an action-card without promising exec or data writes.

`::::card-group`

Group navigation cards in a document grid and verify fence depth plus real render.

`::embed`

Embed a supported URL as a sandboxed frame or media block and document refusal fallbacks.

fenced code

Web Device Markdown structure `fenced-code`: purpose, boundaries, author entry, evidence, and sample honesty.

Generic MD directive (incl. `::input`)

Web Device Markdown directive `generic-directive`: purpose, boundaries, author entry, evidence, and sample honesty.

GFM admonition

Place GitHub-style callouts in content Markdown and inspect their real document render on the same page.

GFM table

Place pipe tables in content Markdown and inspect their real document render on the same page.

heading

Web Device Markdown structure `heading`: purpose, boundaries, author entry, evidence, and sample honesty.

image (inline)

Web Device Markdown structure `image`: purpose, boundaries, author entry, evidence, and sample honesty.

`:::info-card`

Place a non-interactive info card and inspect its read-only body on the same page.

`::link-card`

Organize a navigation entry with link-card and inspect its read-only rendered result in place.

list

Web Device Markdown structure `list`: purpose, boundaries, author entry, evidence, and sample honesty.

paragraph

Web Device Markdown structure `paragraph`: purpose, boundaries, author entry, evidence, and sample honesty.

raw HTML

Web Device Markdown structure `raw-html`: purpose, boundaries, author entry, evidence, and sample honesty.

`slides: true` front matter

Mark a content record as slides, split on HR boundaries, and link the live slides demo honestly.

`:::step`

Nest a single step body under steps; full live sample lives with the steps container.

`::::steps`

Author a static numbered tutorial with steps/step fences and inspect the real document render.

thematicBreak / HR

Use horizontal rules as separators; under slides: true they become slide boundaries.

Folder-backed media gallery (`::gallery`)

Put a media folder next to a content item and present it with layout, density, and optional lightbox — samples for every mode live on this page.

Immersive video gallery (Expose-style)

Pair a cover still with a short video in a folder-backed ::gallery so stage/expose/story plates can fall back to the cover, then play a muted seamless loop.

Immersive plates

Minimal information site

Use the verified first-site path to establish a small information site before adding a content collection or theme overlay.

Web Device

Build a static site with Web Device from AFS-native pages, content, and site configuration.

Page variants

Declare several finished renders of one page URL, compare them on the existing ?review=1 HUD, and keep visitor assignment separate from the authoring choice.

Build a page with AUP

Compose site components in a page layout and understand ARC's current layout lookup order.

Compose pages and layouts

Give each route a layout boundary, then keep reusable presentation in Web components and reader data in content objects.

Preview, build, and publish

Keep local acceptance, build artifacts, and formal publishing as three separate stages.

Publish and maintain

Web Device documentation draft: preview, build, publish, check, and diagnose a site.

Recipes

Task-oriented site and AUP composition paths that only link to canonical unit pages and verified guides — no re-documented component APIs.

Recipe: bind source to layout

Declare a content source, then bind it into a layout component — sequence of guide and unit pages only.

Recipe: collection list page

Build a list page over a content collection by linking source binding and layout component unit pages — no prop tables here.

Recipe: docs board

Wire a documentation board shell from surface and component unit pages — contracts stay on those pages.

Recipe: first site

Compose a minimal Web Device site by chaining verified getting-started steps with layout and AUP unit pages — no API re-documentation.

Recipe: slides in an article

Turn a Markdown article into slides by chaining MD structure units and the deck widget unit — no re-documented APIs.

Reference

Web Device documentation: directory, syntax, component, surface, Markdown, and version contracts.

Requirements and scope

Use ARC 2.0.0-beta.25 to verify a minimal Web Device site from one local blocklet.

Routes and locales reference

Map declared pages and content to route families, then add locale variants without duplicating a site tree.

Routes, navigation, and locales

Derive paths from declared pages and content, and treat locale as a view of one site rather than a copied site.

Run, check, and inspect

Check, build, and directly run a local blocklet, then verify its Web Device page in a browser.

SEO, links, and accessibility

Use generated SEO and link checks as a floor, then finish with human accessibility inspection.

Showcase mapping

Map showcase-dsl / showcase pages to AUP primitive and widget unit pages, and run the showcase blocklets locally — not a hosted full showcase.

Site-wide configuration

Use .web/site.yaml to declare locale, presentation, SEO, template, and theme selection.

Site configuration reference

Use `site.yaml` for site-level scalar configuration and retain separate files for tokens, redirects, and assets.

Understand a site directory

Use pages, content, and .web to separate page entry points, content objects, and site capability.

Slide lab · ceiling

Speaker-led ceiling sample: one decoration layer (AIGC plates + shells), disciplined type/color/paper, boards and marks — Path A without free HTML.

Slide lab · coolbackgrounds

Three coolbackgrounds-inspired surfaces on porcelain paper: topo-soft, facet-soft, horizon-band.

Slide lab · dune

guizang-inspired dune pack: sand paper, charcoal type, topo-soft default.

Slide lab · editorial

Experimental editorial deck with boards, tones, and ink theme. Path A: AUP dual-mode with real composition.

Slide lab · grid-dense

Experimental denser deck: short grid media, compact compare, tight statements. Still overflow-safe — dense is not cluttered.

Slide lab · kraft

guizang-inspired kraft paper theme: warm stock, serif display, paper-grain default.

Slide lab · shell-demo

Experimental shell-demo deck: one live shell per page (chart, map, calendar). Boundary prose stays off the visual pages.

Slide lab · surface

Speaker-led demo of deckSurface: curated CSS abstract backgrounds as the default decoration layer. Zero image assets.

Slide lab · visual-first

Experimental visual-first deck: single plate, mosaic, grid, sized stage. Tests media-fill discipline inside the 16 by 9 player.

Web Device Slides demo

A small, runnable Markdown deck used by the Web Device Slides guide.

Web Device Markdown Slides at a Glance

Why Markdown Slides keeps a presentation and readable page in the same content record.

Source-binding reference

Reference the four-field source contract without turning a page query into a global variable.

Bind content to a page

Declare a content source first, then hand it to a page layout by its $source name.

Surfaces

Navigation hub for Web Device surface packages — one page per surface; not a multi-surface reference body.

`comments-surface` surface

Web Device surface `comments-surface`: purpose, boundaries, author entry, evidence, and sample honesty.

`docs-page` surface

Web Device surface `docs-page`: purpose, boundaries, author entry, evidence, and sample honesty.

`in-page-toc` surface

Web Device surface `in-page-toc`: purpose, boundaries, author entry, evidence, and sample honesty.

`pagination` surface

Web Device surface `pagination`: purpose, boundaries, author entry, evidence, and sample honesty.

`search-page` surface

Web Device surface `search-page`: purpose, boundaries, author entry, evidence, and sample honesty.

Theme and token reference

Reference the token and theme boundary without confusing palette/tone with component-overlay selection.

Themes and tokens

Use tokens for stable visual vocabulary and keep theme-library choice distinct from component overlays.

Understand a site

Web Device documentation draft: understand an existing site's directories, pages, content, routes, and locales.

Version compatibility

Read every command and behavior claim against the ARC version that actually produced its evidence.

Web3 Kit

A series of ready-to-use modules for building Web3 applications.

How to install Point Up

Point Up does not contain any practical business logic; it merely offers the most basic and purely points-related capabilities. As a result, its use c

Rules for customizing badges

Point Up also supports the configuration of customized badge rules. The context for these badge rules is that when we want users to perform certain sp

In the Virtual Gift Card

If you have Virtual Gift Card installed in your service

In the DiscussKit

If DiscussKit is installed in your service

How to use components from Store?

Pages Kit is designed with extensibility in mind. You can use custom components from Blocklet Store to extend its capabilities.

By calling through code

To use Point Up through configuration as mentioned above, the corresponding Blocklet must support the capability of Point Up. Implementing this capabi

By configuring way

Some Blocklets now support the integration of Point Up's point system through configuration. Below are several common types of Blocklets.

AD Kit (Beta)

This blocklet is in beta and is not recommended for production use

AI Kit

Overview

Daily Attendance

Overview

Discuss Kit

Overview

How to bookmark a website

If you come across a website and content that you like, and want to bookmark it, Discuss Kit's Bookmark module can help you complete this task more ef

Discuss Kit

- How to use the Blog Module

How to use the Blog Module

If you encounter something happy and want to record it, then the Blog Module of Discuss Kit can help you accomplish this!

Preference Setting

I hope this document can help everyone understand how to set preferences for Discuss Kit.

Rules for using points

Access the Point Up management console, navigate to the "Usage Points Rules" tab, and click the add button on the page to begin creating your first us

Pages Kit

- Custom Component

How to use the Doc Module

If you encounter a scenario where you need to provide documents to other users, then the Doc Module of Discuss Kit can help you accomplish this task!

Lucky Draw

Overview

How to configure point rules

Point Up supports various types of points rules, which can be configured as per the documentation below.

Rules for earning points

Open the management console of Point Up, switch to the "Earning Points Rules" tab, and then click the add button on the page to start adding your firs

Pages Kit

Overview

Built-in Package List

React

Custom Component

- How to use third-party dependencies (CDN)

How to use third-party dependencies (CDN)

Introduction

Point Up

Overview

Promotion Kits

Overview

In the Lucky Draw

In the previous section, we introduced two ways to configure the use of Point Up, both allowing users to earn points within our services. The introduc

How to use the point rules

On the ArcBlock platform, a complex service is always composed of several smaller Blocklets, and Point Up is no exception. A service based on the Bloc

Token Prize Pool

Overview

Tweet Token (Share 2 Win)

Overview

Rules of the points level

Point Up also supports configuring different level rules. When users accumulate points that meet these level criteria, they will receive a correspondi

Virtual Gift Card

Overview

Vote Kit

Overview

Waiting List

Overview

FAQs

Overview

Getting Started

Overview

How To Guides

WIP

Reference Guide

WIP

Sample Projects

WIP

Welcome

Overview

ArcBlock White Paper V1

ArcBlock Technical White Paper: Explain the platform architecture and core components.

ArcBlock Technical White Paper

Version 1.0 (2017.12)