ArcBlock — docs

AFS

ARC における AFS のパス、プロバイダ、ケイパビリティ、クエリ契約の開発者向けドキュメント。

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 Framework の公式コマンドラインツール。エージェントの作成・実行・デバッグを簡単にします。

組み込みアプリ

AIGNE CLIには、専門的な機能をすぐに利用できる、事前パッケージ化されたアプリケーションが付属しています。これらのアプリは完全なAIGNEプロジェクトであり、ローカルプロジェクトを最初に初期化する必要なく、直接実行できます。

コマンドリファレンス

AIGNEコマンドラインインターフェース（CLI）は、AIGNE Agentを作成、管理、デプロイするための主要なツールです。このセクションは、利用可能なすべてのコマンドとそのオプションを網羅したリファレンスとして機能し、素早く参照できるように構成されています。

aigne create

aigne create コマンドは、テンプレートから新しい AIGNE プロジェクトの雛形を作成します。これにより、必要なディレクトリ構造と設定ファイルがセットアップされ、すぐに Agent の開発を開始できます。

aigne deploy

aigne deploy コマンドは、AIGNE アプリケーションを Blocklet としてパッケージ化し、指定された Blocklet Server エンドポイントにデプロイします。これは、agent を本番環境で使用するために公開するための標準的な方法であり、自己完結型の実行可能なサービスとし

aigne hub

aigne hub コマンドは、AIGNE Hub への接続を管理するための中心的なツールです。Hub は、管理された大規模言語モデルへのアクセスを提供し、API キーの管理を行い、クレジット使用量を追跡します。Hub が提供するモデルを利用する Agent を実行するには、Hub 接続を適切に設定

aigne observe

aigne observe コマンドは、エージェントの実行データを監視および分析するためのローカルウェブサーバーを起動します。トレースの検査、詳細な呼び出し情報の表示、実行中のエージェントの振る舞いの理解を可能にする、ユーザーフレンドリーなインターフェースを提供します。このツールは、デバッグ、パフォ

aigne run

aigne run コマンドは、AIGNE agent を実行するための主要な方法です。ローカルのプロジェクトディレクトリから、またはリモートURLから直接 agent を実行できます。入力の提供、AIモデルの設定、出力の処理に関する柔軟なオプションを提供し、対話型 agent のためのインタラクテ

aigne serve-mcp

AIGNE プロジェクト内の Agent をモデルコンテキストプロトコル (MCP) サーバーとして提供します。このコマンドは、ストリーミング可能な HTTP エンドポイントを介して Agent を公開し、MCP 標準をサポートする外部システムやアプリケーションとのシームレスな統合を可能にします。

aigne test

aigne test コマンドは、Agent とスキルの自動テストを実行します。これは、ユニットテストと統合テストのための組み込みメカニズムを提供し、Agent とそれが依存するツールがデプロイ前に正しく機能することを確認します。

貢献

@aigne/cliへの貢献に関心をお寄せいただき、ありがとうございます。皆様のご協力は、AIGNEの開発体験を向上させる上で非常に貴重です。バグの修正、新機能の提案、ドキュメントの改善など、どのような貢献も歓迎いたします。

Agent とスキル

AIGNE エコシステムにおいて、Agent とスキルは、AI アプリケーションに命を吹き込む基本的な構成要素です。これらは連携して、ツールで拡張された高度な AI システムを作成します。Agent は推論と会話を担当する脳、スキルはアクションを実行し、外部世界と対話するために使用するツールだと考え

コアコンセプト

AIGNEプロジェクトは、AI Agentを開発、テスト、デプロイするための構造化された環境を提供します。プロジェクトの核心は、Agent、Agentが使用できるスキル、そして接続する言語モデルを定義する設定ファイルを含むディレクトリです。このセクションでは、これらの基本的な構成要素を詳しく説明しま

プロジェクト設定 (aigne.yaml)

aigne.yamlファイルは、AIGNEプロジェクトの中心です。これは中心的なマニフェストとして機能し、プロジェクトのメタデータ、言語モデルの設定、およびagentやスキルといったコアコンポーネント間の関係を定義します。適切に構造化されたaigne.yamlは、強力で整理されたagentを構築する

はじめに

このガイドでは、AIGNE CLIのインストール、新規プロジェクトの作成、そして最初のAI Agentの実行という基本的な手順を説明します。このガイドを終える頃には、ローカルで動作するAgentが完成します。

ガイド

AIGNE CLI ガイドへようこそ。このセクションでは、一般的な開発ワークフローを習得するための、実践的なステップバイステップのチュートリアルを提供します。初めてのカスタム agent の構築、リモートリポジトリからのコードの実行、アプリケーションの本番環境への準備など、これらのガイドは必要な手順

カスタム Agent の作成

このガイドでは、新しい JavaScript Agent を作成し、それをスキルとして AIGNE プロジェクトに統合するためのステップバイステップのチュートリアルを提供します。Agent は、アプリケーションに独自の機能を与えるコア実行可能コンポーネントです。カスタム Agent を作成することで

Agent のデプロイ

AIGNE プロジェクトをデプロイすると、ローカルの開発セットアップから Blocklet として知られる自己完結型の配布可能なアプリケーションに変換されます。これにより、Agent は本番環境で実行され、他者と共有され、より広範な Blocklet エコシステムにシームレスに統合できます。aign

リモート Agent の実行

AIGNE CLI は、ローカルファイルシステムからプロジェクトを実行するだけではありません。リモートURLから直接 Agent を実行する強力な機能も提供します。これは、リポジトリをクローンしたり、手動でファイルをダウンロードしたりすることなく、Agent のテスト、共有、実行に非常に便利です。

概要

Agent 開発のコマンドセンター@aigne/cli は、AIGNE Framework の公式コマンドラインツールであり、Agent 開発のライフサイクル全体を効率化するように設計されています。プロジェクトの作成、ローカルでの実行、テスト、デプロイを簡素化するための包括的なコマンドスイートを提供

AIGNE Framework

実運用の LLM アプリケーション向けエージェントフレームワーク。関数型・合成可能・TypeScript ファースト。

Agent ライブラリ

Agent ライブラリは、複雑な AI アプリケーションの開発を加速させるために設計された、ビルド済みで再利用可能な Agent のコレクションを提供します。これらの既製のコンポーネントを統合することで、すべてをゼロから構築することなく、洗練されたワークフローのオーケストレーション、同時タスクの管理

Bash

このドキュメントでは、Bash Agentについて詳しく説明します。Bash Agentは、Agentワークフロー内でシェルスクリプトやコマンドラインツールを安全に実行できるようにするものです。サンドボックス環境の設定方法、コマンド権限の管理方法、そしてシステムレベルの操作のためにアプリケーションに

オーケストレーター

Orchestrator Agent は、複雑で複数ステップにわたる AI ワークフローを管理するための、構造化された信頼性の高いソリューションを提供します。高レベルの目標を一連の管理可能なタスクに分解し、それらを順次実行し、その結果を最終的で一貫性のある応答に統合することで、自律的なタスク計画と実

高度なトピック

コアコンセプトをマスターし、基本的なアプリケーションを構築した後、AIGNEフレームワークのより洗練された機能を探求する準備ができました。このセクションは、複雑で堅牢、かつ高度にカスタマイズされたAIアプリケーションの構築を目指す開発者向けに設計されています。ここでは、エージェント定義、プロンプトエ

YAMLによるAgentの定義

AIGNEフレームワークは、YAML設定ファイルを使用したAgentの宣言的な定義アプローチをサポートしています。この方法では、Agentの定義（プロパティ、指示、スキル）をアプリケーションのビジネスロジックから分離し、複雑なAgentシステムのより良い整理、再利用性、および容易な管理を促進します。

フック

フックは、Agent の実行ライフサイクルを監視、インターセプトし、カスタムロジックを注入するための強力な仕組みを提供します。これにより、Agent のコア実装を変更することなく、ロギング、モニタリング、入力/出力の変換、カスタムエラー処理などの機能を追加できます。

プロンプト

AIモデルとの効果的なコミュニケーションは、提供されるプロンプトの品質と構造に左右されます。AIGNEフレームワークは、PromptBuilderクラスと統合されたNunjucksテンプレートエンジンを通じて、動的で再利用可能、かつ構造化されたプロンプトを作成するための堅牢なシステムを提供します。こ

ストリーミング

AIGNE フレームワークは、Agent からのストリーミングレスポンスを処理するための堅牢なサポートを提供します。これは、チャットボット、ライブデータフィード、または即時かつインクリメンタルな更新の恩恵を受けるあらゆるユーザーインターフェースなど、リアルタイムのデータ処理を必要とするアプリケーショ

Agent タイプ

AIGNE フレームワークは、それぞれが特定の機能を実行するように設計された、専門的な Agent タイプのスイートを提供します。すべての Agent はベースの Agent クラスを継承しますが、これらの特殊な実装は、AI モデルとの対話から複雑なワークフローのオーケストレーションまで、一般的なタ

AI Agent

AIAgent は、大規模言語モデル (LLM) と対話するための主要なコンポーネントです。ChatModel への直接的なインターフェースとして機能し、高度な会話型 AI、関数呼び出し (ツールの使用)、構造化データ抽出を可能にします。この Agent は、プロンプトの構築、モデルの呼び出し、応答

Function Agent

FunctionAgent は、既存の TypeScript または JavaScript 関数をカプセル化し、AIGNE フレームワーク内でファーストクラスの Agent に昇格させるための簡単な方法を提供します。これにより、カスタムビジネスロジック、外部 API との連携、または任意のコードを

Image Agent

ImageAgent は、画像の生成を担当する特殊な Agent です。ImageModel へのインターフェースとして機能し、入力データを処理してプロンプトを形成し、画像生成サービスに画像の作成を要求します。

MCP Agent

MCPAgent は、モデルコンテキストプロトコル (MCP) に準拠した外部システムと対話するために設計された特殊な Agent です。これはブリッジとして機能し、AIGNE アプリケーションがリモートの MCP サーバーに接続し、ツール、プロンプト、リソースなどの機能を、あたかもフレームワークの

Team Agent

TeamAgent は、他の Agent のグループ（「スキル」と呼ばれる）をオーケストレーションして複雑なタスクを実行する、特化した Agent です。マネージャーとして機能し、定義された戦略に従って情報の流れを指示し、スキルの実行を調整します。これにより、複数の特化した Agent が協力して、

Transform Agent

TransformAgent は、JSONata 式を使用して構造化データを宣言的に変換する方法を提供する特殊な Agent です。複雑な命令型ロジックを必要とせずに、データをある形式から別の形式にマッピング、再構築、または変換する必要があるシナリオに最適です。

コアコンセプト

AIGNE フレームワークで効果的にアプリケーションを構築するには、まずその基本的なアーキテクチャコンポーネントを理解することが不可欠です。このセクションでは、主要な構成要素とその相互作用の概要を説明します。これらの概念を明確に把握することで、より直感的な開発プロセスが促進されます。

Agent

AIGNE フレームワークにおいて、Agent は作業の基本単位です。これは、すべての特殊な Agent タイプに対して標準的な契約を確立する抽象クラスです。Agent は、特定のタスクを実行し、情報を処理し、システム内の他の Agent と対話できる個別のワーカーとして概念化できます。AI モデル

AIGNE

AIGNE クラスは、フレームワークの中心的な実行エンジンです。複数の Agent を統合して複雑な AI アプリケーションを構築し、Agent のインタラクション、メッセージパッシング、および全体的な実行フローの主要な調整ポイントとして機能します。

メモリ

MemoryAgent は、Agent が対話を通じて状態を維持し、情報を記憶するためのメカニズムを提供します。これは、メッセージを直接処理するのではなく、情報を保存するための Recorder とそれを呼び出すための Retriever という 2 つの主要なコンポーネントを通じてメモリ操作を管理

モデル

モデルは、大規模言語モデル (LLM) や画像生成プラットフォームなどの外部 AI サービスと対話するための標準化されたインターフェースを提供する、重要な抽象化層として機能する特化した Agent です。モデルは API 通信の複雑さをカプセル化し、開発者が一貫性のある統一された契約を通じて様々な

はじめに

このガイドでは、AIGNE フレームワークを使用して開発環境をセットアップし、最初の AI Agent を実行するために必要な手順を説明します。このプロセスは30分以内に完了するように設計されており、フレームワークの基本的なワークフローを実践的かつハンズオンで紹介します。

事例

AIGNEフレームワークのさまざまな機能とワークフローパターンを実証する実践的な事例集をご覧ください。このセクションでは、インテリジェントな会話、MCPプロトコルの統合、メモリメカニズム、および複雑なAgentワークフローを理解するのに役立つ、ハンズオンで実行可能なデモを提供します。

AFS ローカル FS

このガイドでは、ローカルファイルシステムと対話できるチャットボットを構築する方法を説明します。AIGNE File System (AFS) と SystemFS モジュールを活用することで、AI Agent がマシン上のファイルを検索、読み取り、管理できるようになり、強力なローカルデータエキスパー

チャットボット

このガイドでは、Agentベースのチャットボットの例について包括的に解説します。さまざまなモードでチャットボットを実行する方法、さまざまなAIモデルプロバイダーに接続する方法、そしてAIGNEのオブザーバビリティツールを使用してその実行をデバッグする方法を学びます。この例は、ローカルに何もインストー

MCP Blocklet

このドキュメントでは、AIGNE Framework とモデルコンテキストプロトコル (MCP) を利用して、Blocklet プラットフォームでホストされているアプリケーションと対話する方法について説明します。このサンプルは、ワンショット実行、インタラクティブチャットモード、およびモデルと I/O

MCP DID Spaces

このドキュメントは、モデルコンテキストプロトコル (MCP) を介して DID Spaces と統合されたチャットボットを構築するための包括的なガイドを提供します。これらの指示に従うことで、AIGNE フレームワークの機能を活用し、分散ストレージ環境で安全にファイルにアクセスし管理できる AI A

MCP GitHub

このドキュメントは、AIGNE フレームワークと GitHub MCP (Model Context Protocol) サーバーを使用して GitHub リポジトリと対話する方法を示すサンプルについての包括的なガイドです。サンプルの設定方法と実行方法を学び、AI Agent がリポジトリの検索やフ

MCP Puppeteer

このガイドでは、AIGNE フレームワークを Puppeteer MCP サーバーと組み合わせて自動化された Web スクレイピングを行う方法を、ステップバイステップで解説します。この例を通じて、Web サイトにアクセスしてそのコンテンツを抽出できる AI Agent を構築し、実行する方法を学びま

MCP Server

このガイドでは、AIGNE Framework の Agent をモデルコンテキストプロトコル（MCP）サーバーとして実行する方法について説明します。このドキュメントを読み終える頃には、サーバーを起動し、AI モデルに接続し、Claude Code のような MCP 互換クライアントを使用して Ag

MCP SQLite

このガイドでは、AIGNE フレームワークを活用した AI Agent を使用して SQLite データベースと対話するための包括的なウォークスルーを提供します。これらの手順に従うことで、必要なコンポーネントのセットアップ、サンプルアプリケーションの実行、Agent を使用したテーブル作成やデータク

メモリ

このガイドでは、セッションをまたいで会話履歴を保持するステートフルなチャットボットを構築する方法を説明します。FSMemory プラグインを活用することで、Agent はセッションデータをローカルファイルシステムに永続化でき、以前の対話を思い出すことが可能になります。

DID Spaces メモリ

このガイドでは、DID Spaces を使用して永続的なメモリを持つチャットボットを構築する方法を説明します。AIGNE フレームワークの DIDSpacesMemory プラグインを活用することで、Agent は分散型かつ安全な方法で、複数のセッションにわたって会話履歴を保持できます。

Nano Banana

このガイドでは、画像を生成できるチャットボットを構築して実行する方法を説明します。これらの手順に従うことで、事前に構築された AIGNE のサンプルを実行し、AI モデルに接続し、フレームワークの可観測性ツールを使用してその動作を検査する方法を学びます。

ワークフローのコード実行

AI モデルから動的に生成されたコードを実行することは、セキュリティと信頼性の面で大きな課題をもたらします。このガイドでは、AIGNE フレームワークを使用して安全なコード実行ワークフローを構築するための、構造化されたステップバイステップのプロセスを提供します。コードを生成する Coder Agen

ワークフローの並行処理

タスクを並列実行することで、複雑なワークフローの効率を大幅に向上させることができます。このガイドでは、AIGNE フレームワークを使用して並行ワークフローを構築する方法を示します。このワークフローでは、複数の Agent が同時に同じ入力を処理し、その出力が集約されます。製品を異なる視点から同時に分

ワークフローグループチャット

このガイドでは、AIGNE フレームワークを使用してマルチエージェントグループチャットワークフローを構築し、実行する方法を説明します。マネージャーを含む複数のエージェントを連携させてタスクに取り組ませ、メッセージを共有し、共通の目標を達成するために協力するチーム環境をシミュレートする方法を学びます。

ワークフローのハンドオフ

このガイドでは、ある Agent が別の専門 Agent にシームレスに制御をハンドオフ（引き渡し）するワークフローの構築方法を解説します。最後まで読むと、ユーザーの入力に基づいてタスクを委任し、より複雑で動的な問題解決を可能にするマルチ Agent システムを作成する方法を理解できます。

ワークフローオーケストレーション

このガイドでは、複数の特化した AI Agent をオーケストレーションする高度なワークフローを構築し、実行する方法を解説します。finder、writer、proofreader のような Agent を連携させ、初期調査から最終レポート作成まで、複雑なタスクに共同で取り組む方法を学びます。

ワークフローリフレクション

AI にコンテンツを生成させるだけでなく、自身の成果物を批評し改善させたいと思ったことはありませんか？このガイドでは、ある Agent の出力を別の Agent がレビューして改良する、自己修正ワークフローの構築方法を解説します。これらの手順に従うことで、AIGNE フレームワークを使用してこの強力

ワークフロールーター

ユーザーのクエリをその内容に基づいて、異なる専門ハンドラーに振り分ける必要に迫られたことはありませんか？このガイドでは、リクエストをインテリジェントにルーティングするワークフローを構築するための完全なステップバイステップのウォークスルーを提供します。入力を分析し、製品サポートやフィードバック収集など

ワークフロー逐次実行

このガイドでは、AIGNE フレームワークを使用して逐次ワークフローを構築し、実行する方法を説明します。複数の Agent を連鎖させ、ある Agent の出力が次の Agent の入力となることで、ステップバイステップの処理パイプラインを作成する方法を学びます。このパターンは、一連の明確で順序付け

モデル

AIGNEフレームワークはモデルに依存しないように設計されており、さまざまなサードパーティのAIモデルプロバイダーに接続できます。この柔軟性は、モデルアダプターのシステムによって実現されます。各アダプターは、OpenAI、Anthropic、Google Geminiなどの特定のサービスに対して標準

AIGNE Hub

AIGNE Hub は、複数のプロバイダーが提供する様々な大規模言語モデル（LLM）、画像生成サービス、動画生成サービスにアクセスするための統一されたプロキシレイヤーを提供します。@aigne/aigne-hub パッケージを使用することで、クライアント側のアプリケーションロジックを変更することなく

Anthropic

このガイドでは、@aigne/anthropic パッケージを介して AIGNE フレームワーク内で Anthropic の Claude モデルを設定および使用する方法について説明します。API キーの設定、モデルのインスタンス化、標準応答とストリーミング応答の両方でモデルを呼び出す方法をカバーし

AWS Bedrock

@aigne/bedrock パッケージは、AIGNE フレームワークと Amazon Web Services (AWS) Bedrock との間の直接的で堅牢な統合を提供します。これにより、開発者は AWS のスケーラブルで安全なインフラストラクチャを活用しつつ、一貫したインターフェースを維持し

モデル設定

AIGNE Framework内で様々なAIモデルを統合して利用するには、まず環境変数を介して必要な認証情報を設定する必要があります。これにより、それぞれのサードパーティサービスとの安全かつ適切な認証が保証されます。このガイドでは、サポートされている各モデルプロバイダーに必要な特定の環境変数について

DeepSeek

このガイドでは、@aigne/deepseek パッケージを介して AIGNE Framework 内で DeepSeek モデルを設定し、使用する方法について説明します。API キーの設定、モデルのインスタンス化、および標準応答とストリーミング応答の両方の例を扱います。

Doubao

@aigne/doubao パッケージは、AIGNE フレームワークと Doubao の強力な言語および画像生成モデルとのシームレスな統合を提供します。このガイドでは、AIGNE アプリケーション内で Doubao モデルを構成し、利用するための完全なリファレンスを提供します。

Google Gemini

このガイドでは、@aigne/gemini パッケージを介して AIGNE フレームワーク内で Google の Gemini モデルを設定および使用する方法について説明します。API キーの設定、モデルの選択、およびチャット、画像、動画生成で利用可能な特定の機能について解説します。

Ideogram

このドキュメントは、開発者が AIGNE フレームワーク内で Ideogram の画像生成機能を統合し、利用するための包括的なガイドを提供します。@aigne/ideogram パッケージは Ideogram の API へのシームレスなインターフェースを提供し、テキストプロンプトから高品質な画像を

LMStudio

@aigne/lmstudio パッケージは、LM Studio を介してローカルでホストされる大規模言語モデル (LLM) と AIGNE を統合するためのモデルアダプターを提供します。これにより、開発者は AIGNE フレームワーク内でローカルモデルの能力を活用でき、プライバシー、コントロール、

Ollama

@aigne/ollama パッケージは、AIGNE フレームワークと Ollama を介してローカルでホストされるAIモデルとのシームレスな統合を提供します。これにより、開発者は独自のハードウェア上で実行される多種多様なオープンソース言語モデルを活用でき、プライバシーとAI機能へのオフラインアクセ

OpenRouter

OpenRouterは、OpenAI、Anthropic、Googleなど、さまざまなプロバイダーが提供する多様なAIモデルへの統一されたゲートウェイとして機能します。@aigne/open-router パッケージは、これらのモデルをAIGNEフレームワークに統合するための標準化されたインターフェ

OpenAI

@aigne/openai パッケージは、OpenAI のモデルスイートとのシームレスな統合を提供し、開発者が AIGNE フレームワーク内で直接、チャット補完のための GPT、画像生成のための DALL-E、ビデオ作成のための Sora などのサービスを活用できるようにします。このドキュメントでは

概要

AIGNEフレームワークは、モデル非依存に設計されており、開発者はさまざまなプロバイダーの大規模言語モデル（LLM）や画像生成モデルを幅広く統合できます。これは、各プロバイダー独自のAPIを、一貫したインターフェースの背後で抽象化する、標準化されたアダプターシステムを通じて実現されています。

Poe

ユーザーは D2 ダイアグラムの構文エラーを修正したいと考えています。エラーメッセージ invalid style keyword: "font-family" は、font-family が D2 で有効なスタイルプロパティではないことを示しています。 D2 コード内のこの行を削除または修正する

xAI

このガイドでは、AIGNE フレームワーク内で xAI の言語モデル、具体的には Grok を設定して使用するための手順を説明します。必要なパッケージのインストール、API キーの設定、モデルのインスタンス化、そして標準呼び出しとストリーミング呼び出しの両方の例について解説します。

概要

AIGNE フレームワークは、機能的な AI アプリケーション開発フレームワークであり、スケーラブルなエージェント型 AI アプリケーションの構築プロセスを簡素化および高速化するために設計されています。関数型プログラミングの概念、堅牢な人工知能機能、モジュラー設計を組み合わせ、開発者に構造化された環

ユーザーガイド

AIGNE ユーザーガイドへようこそ。このガイドは、ビジネスリーダー、マネージャー、そしてAIを活用して複雑なタスクを自動化し、ビジネスプロセスを効率化する方法に興味のある方など、技術的な知識を持たない読者を対象としています。読み進めるにあたり、プログラミングの知識は一切必要ありません。

一般的なワークフロー

AIGNE フレームワークでは、単一の Agent が特定のタスクを実行できます。しかし、システムの真価は、複数の Agent が協力してより複雑な問題を解決するときに発揮されます。チームのメンバーのように、Agent は構造化された方法で連携するように組織化できます。これらの協力のパターンは「ワー

意思決定

「マネージャー」Agent がリクエストを分析し、どの特化型 Agent がタスクの処理に最適かを判断するシナリオを示します。

並列タスク

状況によっては、効率を上げるために複数の独立したタスクを同時に実行する必要があります。並列タスクワークフローは、この目的のために設計されています。これにより、複数のAI Agentが同じ初期情報に対して同時に作業でき、個々の結果が最後に収集・結合されます。

順次タスク

順次タスクワークフローは、一連のタスクを特定の所定の順序で処理します。これはデジタル上の組み立てラインのように機能し、あるステップの出力が次のステップの入力となります。このパターンは、各ステップが前のステップの作業を基に構築される多段階のプロセスに最適です。

Agent を理解する

AIGNE フレームワークにおいて、「Agent」は作業を完了するための基本的な構成要素です。Agent を、特定のタスクを実行するために雇われた専門のデジタルワーカーだと考えてください。各 Agent には明確な役割と一連のスキルがあります。現実世界のチームと同様に、単一のタスクを1つの Agen

Agent チーム

単一の特化した Agent は特定のタスクに役立ちますが、1 つの Agent だけで処理するには大きすぎる、または複雑すぎる問題もあります。人間の組織と同様に、タスクに複数のステップや多様なスキルが必要な場合は、チームを編成します。AIGNE では、Agent チームとは、より大きな目標を解決する

基本的な Agent

基本的な Agent とは、役立つチャットボットや集中的なデータ入力担当者のような、専門的なデジタルアシスタントだと考えてください。各 Agent は、特定の種類のタスクを1つだけ実行し、それをうまくこなすように設計されています。明確な指示セットに基づいて動作し、処理するための特定の入力を受け取り、

AIGNE とは？

AIGNE (発音は [ˈei dʒən]、「agent」から「t」を除いたような音) は、AI アプリケーションを開発するための関数型フレームワークです。関数型プログラミング、モジュール設計、そして強力な人工知能の能力を組み合わせることで、スケーラブルでモダンなアプリケーションの構築プロセスを簡素

AIGNE Hub

複数の LLM プロバイダを統一的に扱うアダプタ層。すべての Blocklet の API キー利用状況も管理します。

API リファレンス

このドキュメントは、AIGNE Hub RESTful API の技術仕様を提供します。このガイドに従うことで、チャット補完、画像生成、埋め込みのコアエンドポイントを認証し、対話する方法を理解し、アプリケーションとの堅牢なバックエンド統合を可能にします。

API 認証

AIGNE Hub API へのリクエストを安全に認証することは、プログラムによるアクセスと統合のための重要なステップです。このガイドでは、API キーを使用してアプリケーションを認可するための明確で段階的なプロセスを提供し、すべての対話が安全かつ適切に識別されるようにします。

チャット補完

このドキュメントでは、チャット補完 API エンドポイントの詳細な仕様について説明します。このガイドに従うことで、会話型 AI 応答の生成、ストリーミングの管理、および堅牢なアプリケーションを構築するためのモデル固有のパラメータの利用方法を学ぶことができます。このエンドポイントは、インタラクティブな

Embeddings

このドキュメントでは、AIGNE Hub Embeddings API エンドポイントの詳細な仕様を説明します。このガイドに従うことで、テキストを数値ベクトル表現に変換する方法を学びます。これは、セマンティック検索、テキストクラスタリング、類似性分析などのタスクの基礎となるステップです。

画像生成

このドキュメントは、画像生成エンドポイントの技術仕様を提供します。このガイドに従うことで、リクエストの構造化、モデルとパラメータの指定、および結果の画像データの処理方法を学び、AIを活用した画像作成をアプリケーションに統合できるようになります。

デプロイシナリオ

AIGNE Hub を特定の運用上およびビジネス上の目標に合わせるためには、適切なデプロイモデルを選択することが重要です。このドキュメントでは、利用可能な2つの主要なデプロイシナリオを概説し、アーキテクチャの決定を導くための明確な比較を提供します。各モードは、社内での利用から一般向けの商用サービスま

企業向けセルフホスティング

独自のインフラストラクチャ内に AIGNE Hub をデプロイすることで、組織は AI モデルへのアクセス、データプライバシー、および運用コストを完全に制御できます。このガイドでは、安全な社内エンタープライズ利用のために、セルフホスト型の AIGNE Hub インスタンスを設定・管理するための体系的

サービスプロバイダーモード

独自のマルチテナント AI サービスを提供する準備はできていますか？このガイドでは、AIGNE Hub でサービスプロバイダーモードを有効にする方法について詳しく説明します。クレジットベースの請求システムを有効にし、Payment Kit を統合し、カスタム価格を定義して、ユーザー向けの収益化された

コア機能

このセクションでは、AIGNE Hub の主要な機能について技術的な詳細を解説します。最後まで読むことで、統一された AI モデルの対話やプロバイダー管理から、堅牢なセキュリティ、詳細な分析まで、プラットフォームの主要な機能を理解し、システムを活用するための強固な基盤を築くことができます。

使用状況とコストの分析

AI モデルの消費量を把握することは、コスト管理、パフォーマンス監視、そして公正なリソース割り当てを確実にするために不可欠です。このドキュメントでは、使用統計のクエリ方法、コストの追跡方法、そして AIGNE Hub が分析とレポートに使用するデータモデルの解釈方法について詳しく説明します。

プロバイダー管理

信頼性が高くコスト効率の良い AI ゲートウェイを維持するには、上流の AI プロバイダーの効果的な管理が不可欠です。AIGNE Hub はこのプロセスを一元化し、さまざまな AI サービスの認証情報を接続、設定、管理するための統一されたインターフェースを提供します。このセクションでは、プロバイダー

セキュリティとアクセス

安全で適切に管理されたシステムは、あらゆるエンタープライズグレードのデプロイメントにとって不可欠です。このセクションでは、AIGNE Hubの堅牢なセキュリティアーキテクチャについて詳述し、認証、クレデンシャル管理、アクセス制御、ロギングをカバーして、AI運用の完全性と機密性を確保します。

はじめに

このガイドでは、AIGNE Hub をデプロイして運用するための、タスク指向の直接的な手順を説明します。これらの手順に従うことで、30分以内に機能するインスタンスを設定でき、上流の AI プロバイダや下流のアプリケーションとの即時統合が可能になります。

概要

増え続けるAPIキー、請求システム、さまざまなAIプロバイダーとの統合の管理にお困りではありませんか？このドキュメントでは、この複雑さを簡素化する統合AIゲートウェイであるAIGNE Hubについて包括的に紹介します。そのコア機能、主な利点、システムアーキテクチャについて学び、インフラ管理における価

リリースノート

このドキュメントでは、AIGNE Hub のすべての注目すべき変更、新機能、バグ修正の詳細な記録を提供します。DevOps および SRE チームは、この情報を利用してプラットフォームの進化を追跡し、各アップデートの影響を理解し、それに応じてアップグレードを計画できます。

AIGNE Studio

コードを書かずに LLM のワークフローと AI エージェントを組み立てるためのツール。

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 Framework 上に構築された、AI によるウェブサイト生成ツール。

高度な機能

Web サイトの生成と更新の基本をマスターしたら、AIGNE WebSmith の高度な機能を探求して、よりきめ細かい制御を行い、ユニークで強力なビジュアル要素を追加できます。このセクションでは、コンポーネントライブラリの管理方法と、よりダイナミックで魅力的なページを作成するための特殊なコンポーネン

カスタムコンポーネントライブラリの使用

AIGNE WebSmith によって生成されたウェブサイトは、コンポーネントと呼ばれる事前にデザインされた視覚要素のライブラリから構築されます。WebSmith には標準のコンポーネントセットが含まれていますが、Pages Kit プロジェクトを使用してカスタムコンポーネントライブラリを定義および

特別なコンポーネントを使用する

AIGNE WebSmith には、最小限の設定で強力な視覚的およびインタラクティブな要素をウェブサイトに追加するために設計された、特別なコンポーネントのライブラリが含まれています。これらの事前に構築されたコンポーネントは複雑な機能を処理するため、魅力的なユーザーエクスペリエンスを効率的に作成できま

ターミナルプレイヤー

ターミナルプレイヤーは、インタラクティブな録画済みターミナルセッションをウェブサイトに表示するために使用される特殊なコンポーネントです。このコンポーネントは、コマンドラインの指示をデモンストレーションしたり、ソフトウェアのインストールを紹介したり、明確で再生可能な形式でユーザーを技術的なプロセスを通

はじめに

このガイドを参考に、サイトを最速で立ち上げましょう。AIGNE CLI のインストール、ソース資料の収集、aigne web generate の実行、計画の承認、生成されたページの確認まで、すべてを 1 か所で行えます。

ガイド

ウェブサイトを日常的に管理する必要がありますか？このセクションでは、サイトの作成、更新の公開、翻訳の管理、外観のカスタマイズといった一般的な操作に関するステップバイステップのガイドを提供します。これらのチュートリアルに従って、ウェブサイトをスムーズに運営してください。

ワークスペースのクリーンアップ

このガイドを使用して aigne web clear を安全に実行する方法を学びます。生成されたページを削除したり、キャッシュされたデータをリセットしたり、プロジェクトを引き渡す前に認証トークンを削除したりする場合に役立ちます。

ウェブサイトの作成

このガイドでは、単一のコマンドでソースマテリアルを公開可能なサイトに変換する方法を説明します。利用可能な aigne web generate フラグを確認し、AI が生成したサイトマップを承認し、完成したページがディスク上のどこに保存されるかを理解します。

テーマのカスタマイズ

一貫性のある色、タイポグラフィ、スペースは、サイトをプロフェッショナルな印象にします。このガイドでは、AI の支援を受けて新しい WebSmith テーマを生成し、それを公開サイトに適用するための具体的なコマンドについて説明します。

インタラクティブモード（ベータ）

Note: インタラクティブモードは現在ベータ版です。完全に機能しますが、予期せぬ動作が発生する可能性があります。この体験を改善し続けるため、皆様からのフィードバックをお待ちしております。このガイドを使用して aigne web chat を起動し、自然言語で WebSmith に話しかけ、アシスタ

ウェブサイトのローカライズ

このガイドを使用して aigne web translate を実行し、必要なページと言語を選択し、プライマリサイトと一緒に公開できるローカライズ版を保存します。

環境設定の管理

このガイドでは、aigne web prefs の設定方法について説明します。保存されたルールのリスト表示、有効/無効の切り替え、不要になったエントリの削除方法などが含まれます。

Publish Website

ウェブサイトが生成されたら、最後のステップはオンラインでアクセスできるようにすることです。このガイドでは、AIGNE WebSmith を使用してサイトを公開するためのさまざまな方法について説明し、技術的要件や予算要件に最も適したオプションを選択できるようにします。

既存のウェブサイトへ

このガイドでは、aigne web publish を設定して、URL の入力やサービスの認可など、すでに運用している ArcBlock 上のサイトにデプロイする方法について説明します。

新規専用ウェブサイトへ

このガイドを使用して、有料の aigne web publish パスを実行し、新しいマネージドウェブサイトをプロビジョニングし、支払いをカバーし、進行中のデプロイメントを再開する手順を説明します。

WebSmith Cloud へ

このガイドでは、aigne web publish を使用して、無料の WebSmith Cloud ホスティングオプションに公開する方法を、コマンドの実行から初回認証、ライブ URL の確認まで説明します。

添加页面

使用 AIGNE WebSmith 可以轻松扩展您的网站。本指南介绍了如何使用 aigne web add-page 命令将新页面无缝集成到您的网站结构中，并自动更新内容和内部链接。

ウェブサイトの更新

このガイドを使用して適切な更新ワークフローを選択し、構造またはページレベルの変更に関する詳細なサブガイドに進んでください。

更新履歴の管理

このガイドでは、WebSmithが変更したすべてを監査する方法について説明します。aigne web historyコマンドは、すべての生成または更新アクションを記録するため、何が、いつ、なぜフィードバックが適用されたのかを常に把握できます。

ページの削除

ウェブサイトの構造を整理する必要がありますか？このガイドでは、aigne web remove-page コマンドを使用して安全にページを削除し、これにより生じるリンク切れを自動的に検出し、影響を受けるコンテンツを再生成してサイトの整合性を維持する方法について説明します。

ページの更新

このガイドは、サイトの他の部分を変更せずに、単一のページに対して aigne web update を実行する必要がある場合（セクションの書き換え、新しいモジュールの挿入、ブロックの並べ替え、古いコンテンツの削除など）に使用します。

構造を更新する

このガイドは、aigne web generate を使用してサイトマップを再形成する際、例えばプランを承認する前にページを追加または削除したい場合に役立ちます。

概要

このドキュメントでは、AIGNE WebSmith の概要を説明します。読み終える頃には、その中心的な目的、主要な機能、そして初期計画から最終的な公開までプロフェッショナルなウェブサイトの作成を自動化するために使用する基本的なワークフローを理解できるでしょう。

リファレンス

このセクションでは、AIGNE WebSmith の詳細な技術資料を提供します。コマンド、設定オプション、素材準備、ライセンスに関する具体的で詳細な情報を求めるユーザー向けに設計されています。実践的なステップバイステップのガイドについては、はじめにまたはガイドのセクションを参照してください。

コマンドリファレンス

本リファレンスでは、AIGNE WebSmith CLI で利用可能なすべてのコマンドを、エイリアス、パラメーター、使用例と共に掲載しています。

設定リファレンス

config.yaml ファイルは、ウェブサイト生成の中心的なコントロールパネルです。この設定を理解することで、ページ構造からコンテンツのトーンまで、AI の出力のあらゆる側面をカスタマイズできます。このガイドでは、サイトを正確に変更するための、フィールドごとの完全なリファレンスを提供します。

資料の準備

優れたウェブサイトは、aigne web generate を実行する前から始まります。このガイドでは、WebSmith があなたの要件を反映し、適切な証拠を引用し、修正サイクルを少なくできるページを構築できるよう、ブリーフ、ソースドキュメント、証明資料を収集するための具体的なチェックリストを提供し

トラブルシューティング

このガイドは、AIGNE WebSmith を使用する際の一般的な問題を診断して修正するのに役立ちます。生成、公開、または設定中に問題が発生した場合は、以下のシナリオの解決策を確認してください。

リリース履歴

このドキュメントは、AIGNE WebSmith のすべてのバージョン更新を記録しています。新機能、バグ修正、その他の変更が含まれており、バージョンごとに逆時系列で整理されています。

ARC CLI

ARC のコマンドライン。サイトや Blocklet をターミナルから宣言・ビルド・デプロイ・検査します。

arc afs

arc afs は、AFS ファイルシステム操作のためのコマンドグループです：パスの一覧表示・読み取り・書き込み・削除・検索、action の実行、マウントの管理です。

arc attach

arc attach は、ローカルディレクトリをリモートの arc デーモンへ provider として逆マウントし、shell アクセス権のないマシンからでも AFS 経由でローカルファイルを読めるようにします。

arc blocklet

arc blocklet は、blocklet パッケージとインスタンスのライフサイクルをカバーします：スキャフォールド、ビルド、チェック、一覧表示、単一の blocklet のデプロイ、またはフリート全体のデプロイです。

arc collections

arc collections には blocklet.yaml の collections: 宣言用の作成ツールがあります —— 現時点では content/ をスキャンしてそのフラグメントを生成します。

arc completion

arc completion は、bash、zsh、または fish 用のシェル補完スクリプトを stdout に出力します —— 自分ではファイルを書き込むことはなく、インストールするかどうかはあなたが管理するリダイレクトの一歩です。

arc deploy

arc deploy は blocklet を登録または公開します：開発用にローカルのデーモンへ登録するか、実際の公開のために DID Space（ローカルまたはリモート）へ公開します。

arc did

arc did は、アイデンティティと信頼を管理します：DID アイデンティティの生成、検証可能な資格情報（VC）の発行と検証、そして信頼する発行者の管理を行います。

arc drain

arc drain は、work ledger を監視し、準備が完了した作業の集合が空になるまでそれをアイドル状態の peer に振り分け続ける、長時間稼働のプロセスです。

arc dsl

arc dsl は、pages/layout.aup のようなファイルが書かれている言語である AUP DSL の産物を検証・lint・整形・生成・検視します。

arc mcp

arc mcp は、稼働中の AFS デーモンの MCP エンドポイントへ stdio をブリッジし、Claude Desktop や任意の stdio MCP クライアントが AFS と対話できるようにします。必要な場合はデーモンを自動起動します。

arc network

arc network doctor は、このマシンからプロキシ検出、DNS、HTTPS、WebSocket の接続性を調べ、各チェックをそれぞれ独立した行で報告します。

arc provider

arc provider は provider パッケージの操作を扱い、現時点では provider の AUP リソースツリーを Cloudflare Pages に公開して URL で参照できるようにします。

arc serve

arc serve は HTTP または MCP 経由で AFS サーバーを起動し、他のプロセス（ブラウザ、エージェント、MCP クライアント）が CLI の代わりにネットワーク経由で AFS インスタンスと対話できるようにします。

arc service

arc service は、名前付きの AFS バックグラウンドインスタンスを管理します：list、start、stop、restart、status、delete、gc、url、logs です。

arc skill

ARC に同梱された how-to ブックレット：一覧表示、名前で 1 つを表示、ホストの .agents/.claude skills へインストールします。まだ完全な gh skill 式の管理ツールや AFS の .skills インベントリではありません。

arc space

arc space は、ローカルの DID Space データを管理します：保存されているものの確認、単一の sync コマンドによる 2 つのサブツリー間でのデータ移動、そして folder-backed な space の claim・チェック・修復です。

arc upgrade

arc upgrade は、arc 自体を最新の公開済みバイナリリリースに、または固定したバージョンにアップグレードします。

arc vault

arc vault は暗号化されたシークレットストレージです：vault を init し、group と name で整理されたシークレットを get/set/list/delete します。

終了コード

arc の各コマンドは、結果を終了コードとして報告します —— 成功は 0、それに加えて 7 種類の異なる非ゼロ値があります（うち 1 つは予約されていますがまだ発生しません）—— そのためスクリプトはメッセージを読まずに、どの種類の失敗に当たったかを判別できます。

インストール

公式インストーラーで arc をインストールし、表示されるバージョン行を確認する。

概要

arc は ARC ランタイムインスタンスを操作するためのコマンドラインツールです。AFS ファイルシステム、アイデンティティと信頼、シークレット、デプロイ、AUP DSL は、すべてこれを通して行われます。

ArcBlock 採用情報

ArcBlock の求人情報。

ArcBlock メディアキット

ArcBlock のメディア素材について。

AIGNE Logos

All image resources

ArcSphere Logos

All Brand Assets zip

DID Logos

All image resources

ArcBlock Logos

All image resources

Payment Kit ガイド

Payment Kit の使い方：主要機能の概観。

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

第三者を信頼せずに資産をチェーン間で移動するためのコンポーネント。

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 アーキテクチャ

ARC アーキテクチャの開発者向けドキュメント：AFS、AFS UI、AUP、Web Device、Blocklet、アイデンティティ、データスペース、および製品系譜の境界。

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

ARC における AUP の記述、検証、ランタイム動作の開発者向けドキュメント。

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.

ブロックチェーンガイド

ArcBlock ブロックチェーンの使い方：機能とヘルプ。

ブロックチェーン SDK（Node.js）

@ocap/client はアプリを OCAP Chain に接続するクライアントライブラリ。Node.js とブラウザで動作します。

APIリファレンス

OCAPクライアントAPIリファレンスへようこそ。このセクションでは、利用可能なすべてのクラス、メソッド、およびデータ型に関する包括的で検索可能なリファレンスを提供します。GraphQLメソッドの詳細、トランザクションヘルパーのパラメータ、またはレスポンスオブジェクトの構造を探している場合でも、必要

ヘルパーメソッド

GraphQLClient クラスは、OCAP を利用したブロックチェーンと対話するための主要なインターフェースです。チェーンの状態のクエリ、トランザクションの送信、リアルタイムイベントのサブスクライブのための一連の包括的なメソッドを提供します。Node.js とブラウザ環境の両方でシームレスに動作

データ型

このセクションでは、OCAP Client API全体で使用されるすべてのカスタムデータ構造、入力パラメータ、および応答オブジェクトに関する包括的なリファレンスを提供します。これらの型を理解することは、OCAPブロックチェーンと効果的に対話するために不可欠です。

低レベル API

低レベル API は、トランザクションのライフサイクル全体にわたるきめ細やかな制御を提供します。高レベル API が詳細を抽象化するのとは異なり、これらのメソッドを使用すると、トランザクションを手動で構築、エンコード、署名、送信できます。これは、ブロードキャストされる前に異なる関係者がトランザクショ

クエリとミューテーションのメソッド

OCAP Client は GraphQL を通じてブロックチェーンと対話します。メソッドは主に2つのタイプに分類されます。

高レベルAPI

トランザクションヘルパーは、OCAP Client に組み込まれた高レベル関数であり、一般的なトランザクションの作成と署名の複雑さを抽象化します。トランザクションオブジェクトを手動で構築する代わりに、アセットの作成、トークンの転送、ステーキング、アトミックスワップの実行などのワークフローに、これらの

コアコンセプト

このセクションでは、OCAP Clientライブラリを形成する基本原則とアーキテクチャ上の決定について詳しく説明します。これらのコアコンセプトを理解することで、ライブラリの潜在能力を最大限に活用し、より効率的なコードを記述し、問題をより効果的にトラブルシューティングできるようになります。

クライアントアーキテクチャ

OCAP Client は、さまざまな JavaScript 環境や特定のユースケースに対応するため、モジュラーアーキテクチャで設計されています。画一的なライブラリではなく、Node.js バックエンドやバンドルサイズに敏感なウェブアプリケーションなど、特定のコンテキストに最適化された複数のクライア

イベントサブスクリプション

OCAP Clientは、アプリケーションがオンチェーンアクティビティをリアルタイムでリッスンできるようにする、強力なリアルタイムイベントサブスクリプションシステムを提供します。この機能はWebSocket上に構築されており、ブロックチェーンノードへの永続的な接続を提供し、更新をチェックするための継

ガス代行支払い

ほとんどのブロックチェーンシステムでは、すべてのトランザクションにおいて、開始者が「ガス」として一般的に知られる手数料を支払う必要があります。これは、これらの手数料を支払うためのネイティブ通貨を持っていない可能性のある新規ユーザーにとって、大きな障壁となり得ます。OCAP Clientは、アプリケー

トランザクションのライフサイクル

トークンの転送やアセットの作成など、ブロックチェーンの状態を変更するすべてのアクションは、トランザクションを通じて実行されます。トランザクションのライフサイクルを理解することは、OCAP Client を使用してアプリケーションを構築する上で基本となります。このプロセスには、準備、エンコード、署名、

はじめに

ようこそ！このガイドは、30分以内にOCAP Clientを使い始められるように案内します。クライアントのインストール方法、アプリケーションをOCAP互換のブロックチェーンに接続する方法、そしてセットアップを検証するための最初のAPIコールを行う方法を学びます。

基本的な使い方

このガイドでは、OCAP Clientを使い始めるための基本的な手順を説明します。クライアントの初期化、ArcBlockベータチェーンへの接続、そしてすべてが正しく設定されていることを確認するための基本的なクエリの実行方法を学びます。

インストール

OCAP Client は、アプリケーションを OCAP ブロックチェーンに接続するための JavaScript ライブラリです。Node.js とブラウザ環境の両方で動作します。このガイドでは、パッケージマネージャーを使用してクライアントをインストールする方法を説明します。

ハウツーガイド

このセクションでは、OCAP Client を使用して一般的なタスクを完了するための、実践的でステップバイステップの手順を説明します。各ガイドは、アカウントの管理から複雑なアトミックスワップの実行まで、特定の目標を達成するのに役立つ自己完結型のレシピとして設計されています。

権限の委任

権限の委任は、あるアカウント（委任者）が別のアカウント（受任者）に対し、自身に代わって特定の種類のトランザクションを送信することを許可する強力な機能です。これは、ユーザーの主要な秘密鍵に直接アクセスすることなく、ユーザーのためにアクションを実行する必要があるアプリケーションにとって特に便利です。例え

アカウントの管理

OCAP を利用したブロックチェーンにおいて、アカウントとは基本的に、暗号キーのペア（公開キーと秘密キー）によって制御される、アドレスに関連付けられた状態のことです。理解すべき重要な概念は、アカウントが暗黙的に作成されるということです。アカウントは、トークンやアセットの転送など、最初の着信トランザク

アセット（NFT）の管理

このガイドでは、OCAP クライアントを使用して、アセットとしても知られる非代替性トークン（NFT）のライフサイクル全体を管理するための包括的なウォークスルーを提供します。新しいアセットをゼロから作成し、そのプロパティを更新し、標準化されたミントのためのアセットファクトリーを設立し、そのファクトリー

トークンの管理

このガイドでは、OCAP Client を使用してファンジブルトークンを管理するための手順を詳しく説明します。トークンの設計図として機能するトークンファクトリーを設定し、それを使用してミント（新しいトークンの作成）およびバーン（既存のトークンの破棄）を行う方法を学びます。これらの操作は、アプリケーシ

トークンとアセットのステーク

ステーキングとは、特定の受取人に対してトークンやアセット（NFT）をロックアップするプロセスであり、多くの場合、ネットワークのセキュリティを確保したり、ガバナンスに参加したり、報酬を得るために行われます。このガイドでは、OCAP Client を使用したステーキングのライフサイクル全体を段階的に説明

トークンとNFTの転送

このガイドでは、OCAP Clientを使用して、アカウント間でファンジブルトークン（ネイティブおよびカスタム）とノンファンジブルトークン（NFTまたはアセット）を転送するためのステップバイステップのウォークスルーを提供します。すべての転送の主要なメソッドはclient.transfer()です。

概要

OCAP Clientは、アプリケーションをOCAPベースのブロックチェーンに接続するために設計された、強力で多機能なJavaScriptライブラリです。データの読み書き、デジタル資産の管理、オンチェーンイベントの監視を行うための、効率的で開発者に優しいインターフェースを提供します。このクライアント

ブロックチェーンユーティリティ

ウォレット、大きな数値、DID を扱うためのユーティリティライブラリ。

@arcblock/did

このパッケージは、ArcBlockの分散型アイデンティティ（DID）プロトコルを扱うためのJavaScriptライブラリを提供します。これにより、OCAPプラットフォーム上でアプリケーションを構築するための基本となるDIDの作成、管理、検証が可能になります。このセクションでは、ライブラリの基本的な機

APIリファレンス

このセクションでは、@arcblock/did ライブラリ内のすべての公開関数と型に関する包括的なAPIリファレンスを提供します。これには、分散型ID（DID）の作成、検証、検査などの一般的なタスクに対応する、すぐにコピー＆ペーストして使用できる実用的なコードスニペットが含まれています。

コアコンセプト

このセクションでは、ArcBlockの分散型ID（DID）の背後にある基本概念について説明します。ArcBlockエコシステムにおけるDIDは、単なる識別子ではなく、独自の暗号学的プロパティを埋め込んだ自己完結型の自己記述的エンティティです。この設計により、多用途で相互運用可能なIDシステムが可能に

はじめに

このガイドでは、ocap-libs を使い始めるための簡単なステップバイステップのウォークスルーを提供します。わずか数分で、必要なパッケージをインストールし、最初の分散型 ID (DID) を作成し、互換性のある暗号ウォレットを生成し、いくつかの便利なユーティリティの使用方法を学びます。

概要

OCAP ライブラリの公式ドキュメントへようこそ。これは、分散型 ID を使用したアプリケーションを構築するための包括的なスイートです。このガイドでは、強力な自己主権型 ID 機能をアプリケーションに統合するために必要なすべてを提供します。中心となるのは、@arcblock/did、@ocap/wa

@ocap/util

@ocap/util パッケージは、複数の OCAP JS ライブラリで共有される重要なヘルパー関数のコレクションを提供する基盤ライブラリです。アイソモーフィックに設計されており、Node.js とブラウザの両方の環境でシームレスに動作します。このモジュールは、データ型変換、エンコーディング/デコー

APIリファレンス

これは、@ocap/util パッケージで利用可能なすべてのユーティリティ関数の包括的なリファレンスです。データ変換、大きな数値の算術、UUIDの生成、ボンディングカーブの計算に関する実用的な例を提供します。

@ocap/wallet

このパッケージは、OCAP互換の暗号ウォレットを作成および使用するためのユーティリティ関数を提供します。生成されたウォレットは、ArcBlockの分散型アイデンティティ（DID）システムとも互換性があり、暗号鍵の管理、メッセージへの署名、署名の検証をシームレスに行うことができます。

APIリファレンス

このセクションでは、Walletオブジェクトとそのファクトリ関数の詳細なドキュメントを提供します。各関数の説明、パラメータ、戻り値、およびウォレットの作成、メッセージの署名、署名の検証などの一般的な操作のための実用的なコード例を見つけることができます。

コアコンセプト

このセクションでは、@ocap/wallet パッケージの背後にある基本的な概念を紹介します。Wallet オブジェクトとは何か、その構造、作成するさまざまな方法、そして分散型アイデンティティ (DID) との重要な関係について学びます。

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

@blocklet/cli の開発者向けガイド。インストールと各機能を扱います。

高度なトピック

「高度なトピック」セクションへようこそ。コアワークフローでは日常的な開発とサーバー管理を扱いますが、このセクションでは、blockletの微調整とメンテナンスを行うための、より専門的なコマンドについて掘り下げていきます。これらのユーティリティは、blockletの分散型IDを管理し、特定のクリーンア

Blocklet のクリーンアップ

blocklet cleanup コマンドは、Blocklet Server にインストールされている特定の blocklet のメンテナンスタスクを実行するためのユーティリティです。これにより、blocklet の専用キャッシュをクリアしたり、自動バックアップ設定を無効にしたりできます。

DIDドキュメント管理

各blockletは分散型識別子（DID）によって識別され、DIDドキュメントに関連付けられています。このドキュメントには、公開鍵やサービスエンドポイントなどの重要なメタデータが含まれており、他のサービスがあなたのblockletを安全に発見し、やり取りすることを可能にします。通常、Blocklet

Blocklet ワークフロー

Blocklet CLIは、初期のプロジェクト作成から最終的な配布まで、blockletのライフサイクル全体をサポートするための包括的なコマンド群を提供します。これらのワークフローは開発を効率化し、アプリケーションの構築、テスト、デプロイのプロセスをスムーズかつ効率的に進めるために設計されています。

コンポーネント管理

Blockletは他のBlockletで構成でき、それらはコンポーネントと呼ばれます。この強力な機能により、より小さく、再利用可能な部品を組み立てることで、複雑なアプリケーションを構築できます。Blocklet CLIは、プロジェクトのblocklet.ymlファイル内でこれらのコンポーネント依存関

コンポーネントの追加

blocklet add コマンドは、新しいコンポーネントをブロックレットの依存関係として追加します。blocklet.yml ファイルの components セクションを必要な設定で自動的に更新します。

コンポーネントの削除

blocklet remove コマンドは、blocklet の blocklet.yml メタデータファイルからコンポーネントの依存関係を簡単に削除する方法を提供します。この操作により、プロジェクトの設定が更新され、そのコンポーネントが依存関係でなくなったことが反映されます。

Component Studio CLI

blocklet component コマンドは、@blocklet/component-studio-cli パッケージのコマンドを実行するための便利なプロキシとして機能します。これにより、パッケージをグローバルにインストールしたり、バージョンを手動で管理したりすることなく、ターミナルから直接 C

配布

Blocklet の開発とバンドルが完了したら、次のステップは他の人がインストールして使用できるようにすることです。Blocklet CLI には、配布のための2つの主要な方法があります。Blocklet Server に直接デプロイするか、公開して見つけられるように Blocklet Store

ストアに接続

BlockletをBlocklet Storeにアップロードする前に、まずローカルCLIをストアに接続する必要があります。blocklet connectコマンドは、マシンを特定のストアで認証する一回限りのセットアッププロセスを容易にし、blocklet uploadのような将来のコマンドのために必

Blocklet のデプロイ

blocklet deploy コマンドは、ローカル開発環境から実行中の Blocklet Server インスタンスに blocklet を直接プッシュするためのものです。これは、ステージング環境でのテストや本番環境への直接デプロイに不可欠です。このコマンドは、プロジェクトのバンドル、バージョニン

ストアにアップロード

Blocklet のバンドルに成功したら、配布の次のステップは Blocklet Store にアップロードすることです。blocklet upload コマンドは、Blocklet バンドルを指定されたストアに送信し、他の人が見つけてインストールできるようにします。これは、公開配布の主要な方法です

ローカル開発

ブロックレットをローカルで開発およびテストすることは、ワークフローの重要な部分です。Blocklet CLIは、ローカルのBlocklet Serverに接続されたライブリロード環境でブロックレットを実行し、一度限りのスクリプトを実行し、アプリケーションを簡単にデバッグするための強力なツールセットを

Blockletのデバッグ

blocklet debugコマンドは、開発者が実行中のBlockletに環境変数を設定するためのユーティリティで、主に再ビルドや再デプロイを必要とせずに詳細なロギングやその他のデバッグ機能を有効にするために使用されます。

開発モード

blocklet dev コマンドは、ローカル開発にとって極めて重要なツールです。実行中の Blocklet Server インスタンスに接続し、ライブリローディング開発モードで blocklet を実行します。これにより、一時的なコンポーネントとして blocklet のインストール、起動、ログス

スクリプトの実行

blocklet exec コマンドは、インストールされた blocklet のライブコンテキスト内でスクリプトを実行するための強力なユーティリティです。これは、データベースの移行、データのシード、または blocklet のランタイム環境変数へのアクセスが必要な一回限りのスクリプトなどのタスクにと

パッケージングとバージョニング

blockletの開発とテストが完了したら、次のステップは配布の準備です。これには、リリースに一意の識別子を割り当てるためのバージョニングと、すべてのコードとアセットを単一のデプロイ可能な成果物にパッケージ化するためのバンドルという2つの重要なプロセスが含まれます。Blocklet CLIは、このワ

Blocklet のバンドル

blocklet bundleコマンドは、開発ライフサイクルにおける重要なステップです。Blockletのソースコード、アセット、メタデータを標準化された.blockletディレクトリにパッケージ化し、デプロイや配布の準備を整えます。

バージョンの管理

blocklet version コマンドは、blocklet.yml ファイル内のblockletのバージョン番号を更新するための便利なユーティリティです。セマンティックバージョニング（semver）のルールに従い、一貫性のある予測可能なバージョン増分を保証します。これは、blockletの新しい

プロジェクトのセットアップ

新しい blocklet プロジェクトを立ち上げるのは簡単です。Blocklet CLI には、ゼロから始めるか、既存のプロジェクトを変換するかに応じて、開発環境をブートストラップするための2つの主要なコマンドが用意されています。これらのコマンドは、blocklet.yml などの必要なメタデータフ

プロジェクトの作成

blocklet create コマンドは、新しい Blocklet プロジェクトを始めるための最速の方法です。これは create-blocklet という対話型のスキャフォールディングツールを使用しており、さまざまな公式スターターテンプレートから選択できます。このコマンドは、新しいアプリケーショ

プロジェクトの初期化

blocklet init コマンドは、既存のディレクトリ内に新しい blocklet の基本構造を作成するのに役立つ対話型ユーティリティです。コアとなる blocklet.yml メタデータファイルやその他の基本的なボイラープレートを生成し、現在のフォルダを機能的な blocklet プロジェクト

コマンドリファレンス

Blocklet CLIは、Blocklet Serverインスタンスと個々のblockletプロジェクトの両方を管理するための包括的なコマンドセットを提供します。このリファレンスは2つの主要なカテゴリに分かれており、特定のタスクに必要なコマンドを素早く見つけるのに役立ちます。

blocklet

blockletコマンドは、Blockletプロジェクトのライフサイクル全体を管理するための主要なインターフェースです。blockletとそのコンポーネントの初期化、開発、バンドル、デプロイ、管理のための包括的なサブコマンド群を提供します。

blocklet server

blocklet server コマンドは、Blocklet Server インスタンスのライフサイクルと設定を管理するための主要なツールです。サーバーとそれに実行されているすべての blocklet の初期化、起動、停止、監視を可能にします。これらのコマンドは、Blocklet Server を自

設定

Blocklet Serverインスタンスの実行や、Blocklet CLIを使用したサーバーや他のサービスとの対話には、適切な設定が不可欠です。このガイドでは、開発者がBlocklet Storesに接続し、開発環境を管理するために使用するローカルCLI設定に焦点を当てます。これらの設定はbloc

環境変数

環境変数は、Blocklet Serverとそれが実行するブロックレットを構成するための強力な方法を提供します。これらはデフォルト設定や構成ファイルからの値を上書きするため、開発、ステージング、本番などの異なる環境に合わせてセットアップを調整するのに理想的です。

はじめに

このガイドでは、最初のBlocklet Serverインスタンスをセットアップして実行するための基本的な手順を説明します。わずか数分で、インストールから完全に機能するサーバーの起動までを完了できます。

概要

Blocklet CLIは、Blocklet Serverの管理とblocklet開発のための主要なツールです。ローカルでの開発やテストから、アプリケーションのパッケージング、デプロイまで、あらゆる作業に対応する包括的なコマンドセットを提供します。

サーバー管理

blocklet server コマンドは、Blocklet Server インスタンスのライフサイクルを管理するための主要なツールです。設定の初期化、サーバーデーモンの起動と停止、ステータスの確認、さまざまなメンテナンスタスクの実行が可能です。この一連のコマンドにより、コマンドラインから直接サーバ

サーバーのクリーンアップ

blocklet server cleanup コマンドは、さまざまなサーバーレベルのメンテナンス作業を実行するためのユーティリティツールです。サーバー全体を停止させることなく、キャッシュのクリア、状態のリセット、またはネットワーク設定の管理によって問題を解決するのに役立ちます。

サーバー情報の取得

blocklet server info コマンドは、Blocklet Server の環境に関する包括的な概要を収集して表示するために設計された重要な診断ツールです。ハードウェアや OS の詳細からソフトウェアのバージョン、サーバーの設定まで、あらゆる情報を収集するため、デバッグやサポートのための

サーバーの初期化

blocklet server init コマンドは、現在の作業ディレクトリに専用の設定ディレクトリ .blocklet-server を作成することで、新しい Blocklet Server インスタンスを初期化します。このディレクトリには、サーバーを実行するために必要な config.yml フ

ログの表示

blocklet server logs コマンドは、トラブルシューティングとモニタリングに不可欠なユーティリティです。ログの内容を直接表示するのではなく、Blocklet Server デーモンおよびインストールされているすべての blocklet に関連するすべてのログの正確なファイルパスを提供

データベースの移行

blocklet server migrate コマンドは、Blocklet Server インスタンスをスケーリングするための重要なユーティリティです。このコマンドは、サーバーの基盤となるデータベースを、開発やシンプルなセットアップに最適なデフォルトの SQLite から、本番環境向けの Post

サーバーの起動

blocklet server start コマンドは、Blocklet Server インスタンスを起動するための主要な方法です。必要なすべてのコンポーネントをバックグラウンドのデーモンプロセスとして初期化して実行し、サーバーとその Blocklet にアクセスできるようにします。

ステータスを確認

blocklet server status コマンドは、Blocklet Server インスタンスと、その中で実行されているすべての Blocklet の健全性を監視するための重要なツールです。コアサーバープロセスから個々の Blocklet の状態まで、システム全体のスナップショットを迅速かつ

サーバーの停止

blocklet server stop コマンドは、実行中の Blocklet Server インスタンスを正常にシャットダウンします。このプロセスには、実行中のすべての blocklet、ルーティングエンジン、コアサーバープロセス、および関連する Docker コンテナの停止が含まれます。

サーバーのアップグレード

このドキュメントでは、Blocklet Server コマンドラインインターフェース（CLI）を利用可能な最新バージョンにアップグレードする手順を説明します。

Blocklet プラットフォーム

Blocklet プラットフォームを理解し、その上で開発するためのガイド。

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（ブラウザ）

@blocklet/js-sdk は Blocklet のクライアントサイド JavaScript SDK です。

SDK クライアント

SDK クライアントは、@blocklet/js-sdk と対話するための主要なエントリーポイントを提供します。利用可能なすべてのサービスをバンドルしたメインの BlockletSDK クラスと、便利なアクセスとインスタンス化のためのいくつかのファクトリ関数 (getBlockletSDK, cre

APIリファレンス

@blocklet/js-sdkのAPIリファレンスへようこそ。このセクションでは、SDKが公開するすべてのクラス、メソッド、関数、および型に関する詳細な技術ドキュメントを提供します。SDKのコンポーネントとその機能を正確に理解する必要がある開発者を対象としています。

AuthService

AuthServiceは、ユーザーアカウントのあらゆる側面を管理するための包括的なAPIを提供します。ユーザープロファイル、プライバシーと通知設定、他のユーザーをフォローするなどのソーシャルインタラクション、ログアウトやアカウント削除などの重要な認証アクションを処理します。SDKインスタンスのsdk

BlockletService

BlockletServiceは、ブロックレットのメタデータにアクセスするためのメソッドを提供します。Blockletオブジェクトで表されるこのメタデータには、アプリケーション名、URLプレフィックス、バージョン、コンポーネントのマウントポイントなどの重要な情報が含まれています。

ComponentService

ComponentServiceは、メインアプリケーション内にマウントされているコンポーネントBlockletと対話するための便利なAPIを提供します。これにより、これらのコンポーネントに関するメタデータを取得し、そのページやAPIエンドポイントへの絶対URLを構築できます。

サービス

@blocklet/js-sdkは、いくつかのサービスクラスに編成されており、それぞれが特定の機能ドメインを担当しています。これらのサービスは、さまざまなBlocklet APIエンドポイントの専用クライアントとして機能し、プラットフォームの機能と対話するための構造化された直感的な方法を提供します。

FederatedService

FederatedServiceは、統一ログインサイト群の設定を操作するためのAPIを提供します。これにより、ログインセッションを制御する「マスター」アプリケーションと、ユーザーが操作している「現在」のアプリケーションに関する情報を取得できます。これは、統一されたアプリケーションスイッチャーのような

TokenService

TokenServiceは、セッショントークンとリフレッシュトークンを直接操作するための低レベルAPIを提供します。セッショントークンはCookie、リフレッシュトークンはlocalStorageという、それぞれのブラウザストレージの場所からこれらのトークンを保存・取得するロジックを処理します。

UserSessionService

UserSessionServiceは、さまざまなデバイスやアプリケーションにわたるユーザーのログインセッションを取得および管理するためのAPIを提供します。このサービスは、ユーザーがアクティブなログイン場所を表示したり、どのアカウントにどのデバイスがアクセスしたかを確認したり、それらのセッションを

型

このセクションでは、@blocklet/js-sdk によってエクスポートされるコア TypeScript の型とインターフェースの詳細なリファレンスを提供します。プロジェクトでこれらの型を使用すると、TypeScript の静的分析と自動補完を活用して、より良い開発体験を得ることができます。

はじめに

このガイドでは、@blocklet/js-sdk をインストールし、最初の API コールを行うための基本的な手順を説明します。ほんの数分で使い始められるようにすることが目標です。

認証

@blocklet/js-sdk は、トークンベースのセキュリティの複雑さを自動的に処理することで、認証をシームレスにするように設計されています。セッショントークンとリフレッシュトークンをバックグラウンドで管理するため、アプリケーションの機能構築に集中できます。

ガイド

@blocklet/js-sdkの実践的なガイドへようこそ。このセクションは、一般的なタスクを迅速に開始し、実行できるように設計されています。各ガイドでは、安全なAPI呼び出しの実行、ユーザー認証の処理、Blockletアプリケーションでのセッション管理といった主要な機能を統合するための、ステップバ

APIリクエストの作成

@blocklet/js-sdkは、BlockletサービスへのAPIリクエストを行うための、強力で事前設定済みのヘルパーを提供します。これらのヘルパーであるcreateAxiosとcreateFetchは、認証とセッション管理の複雑さを自動的に処理するように設計されているため、アプリケーションの機

ユーザーセッションの管理

@blocklet/js-sdkはUserSessionServiceを提供し、異なるデバイス間でのユーザーのログインセッションの取得と管理を支援します。これは、「セキュリティ」や「デバイス」ページのような機能を構築する際に特に便利で、ユーザーはすべてのアクティブなセッションを確認し、自分のアカウン

概要

@blocklet/js-sdk は、Blockletサービスとのインタラクションを効率化するために設計された包括的なJavaScriptライブラリです。フロントエンドアプリケーションを構築している場合でも、バックエンドサービスを構築している場合でも、このSDKは認証、セッション管理、API通信を処

Blocklet SDK（Node.js）

@blocklet/sdk は Node.js でアプリを開発し、システム機能を統合するための SDK です。

APIリファレンス

Blocklet SDK APIリファレンスへようこそ。このセクションでは、SDKによってエクスポートされるすべてのモジュール、クラス、関数、およびユーティリティの詳細な内訳を提供します。ユーザーの管理、通知の送信、またはアプリケーションのセキュリティ保護など、必要な詳細がここで見つかります。

型定義

Blocklet SDKは、より堅牢で保守性の高いコードを書くのに役立つように、厳密に型付けされています。このセクションでは、ユーザーセッション、通知、イベント、ブロックレット設定を扱う際によく遭遇する最も一般的なTypeScriptの型とインターフェースのリファレンスを提供します。これらの型を理解

認可ミドルウェア

authミドルウェアは、blocklet のルートに認可レイヤーを追加するための強力なツールです。セッションミドルウェアと連携して動作し、ユーザーのロール、特定の権限、KYC (本人確認) ステータス、および使用された認証方式を検証することでエンドポイントを保護します。これにより、認可されたユーザー

認証

現代のウェブアプリケーションにおいて、堅牢な認証と認可はセキュリティとユーザー管理にとって不可欠です。Blocklet SDKは、分散型アイデンティティ（DID）を活用し、安全でユーザー中心のエクスペリエンスを実現しながら、これらの機能をシームレスに実装するための包括的なツールスイートを提供します。

DID Connect

Blocklet SDKは、DID Connectを使用して、分散型アイデンティティをアプリケーションに統合するための効率的な方法を提供します。これにより、ユーザーはDID Walletを使用して安全にログインし、データを管理できるようになり、パスワードレスでユーザー中心の認証体験が実現します。この

セッションミドルウェア

sessionミドルウェアは、Blocklet SDKの認証システムの中核をなすコンポーネントです。Express.jsのルートに対するゲートキーパーとして機能し、リクエスターの身元を検証し、認証が成功するとreq.userプロパティにSessionUserオブジェクトをアタッチします。これにより、

コアコンセプト

Blocklet SDKは、構築するあらゆるアプリケーションのバックボーンとなる、いくつかの基本概念に基づいて構築されています。これらのコアピラーである設定、ウォレット管理、セキュリティを理解することは、SDKの全能力を活用して、堅牢で安全、かつスケーラブルなBlockletを作成するために不可欠で

設定と環境

Blocklet SDKは、アプリケーションの設定と環境変数を管理するための堅牢で統一された方法を提供します。複数のソースからの設定を単一の使いやすいインターフェースに集約し、Blockletが必要なすべての情報（アプリケーションのメタデータからコンポーネント固有の設定まで）にアクセスできるようにし

セキュリティユーティリティ

Blocklet SDK には、アプリケーションのデータと通信を保護するために設計された堅牢なセキュリティユーティリティのセットが含まれています。これらのツールは、機密情報の取り扱い、API コールの整合性の確保、クロスサイトリクエストフォージェリ（CSRF）などの一般的な Web の脆弱性の防止に

ウォレット管理

Blocklet SDKでは、ウォレットはアプリケーションのアイデンティティを表す基本的な暗号オブジェクトです。データの署名、リクエストの認証、ブロックチェーンネットワークとの対話に不可欠です。SDKは、アプリケーションの環境変数から直接ウォレットインスタンスを作成および管理するための強力で便利なユ

はじめに

このガイドでは、Blocklet SDK をインストールし、最小限のアプリケーションを起動して実行するための基本的な手順を説明します。私たちの目標は、わずか数分でゼロから実用的な例を構築できるようお手伝いすることです。

ガイド

Blocklet SDK ガイドへようこそ。このセクションでは、Webアプリケーションにおける一般的な課題を解決し、主要な機能を実装するのに役立つ、実践的なステップバイステップのチュートリアルを提供します。

コンポーネント間通信

複数のコンポーネントで構成される Blocklet アプリケーションでは、コンポーネント同士が安全かつ確実に通信できることが不可欠です。Blocklet SDK は、この目的のために特別に設計された高レベルのユーティリティ component.call を提供します。このメソッドは、サービスディスカ

Webサーバーミドルウェアの使用

Blocklet SDKには、Express.js用の強力ですぐに使えるミドルウェア群がバンドルされています。これらのツールは、セキュリティ、SEO、シングルページアプリケーション（SPA）ルーティングといった一般的なWeb開発の課題に対処するために設計されており、より少ない定型コードで、より堅牢で

概要

Blocklet SDK (@blocklet/sdk) は、ArcBlock プラットフォーム上でアプリケーションを構築するための必須ツールキットです。Blocklet のコア機能を処理するユーティリティ、サービス、ミドルウェアの包括的なセットを提供することで開発を簡素化し、アプリケーション独自の

Blocklet Service

BlockletServiceは、Blockletが基盤となるABT Nodeサービスと対話するための主要なインターフェースとして機能する強力なクライアントです。複雑なGraphQLクエリとHTTPリクエストを、クリーンでPromiseベースのJavaScript APIにラップすることで、ユーザー

サービス

Blocklet SDKは、強力なサービスクライアントのスイートを提供することで、直接的なAPI呼び出しの複雑さを抽象化します。これらのクライアントは、ユーザー管理、リアルタイム通知、コンポーネント間のイベント処理など、Blockletのコア機能と対話するためのクリーンでプログラム的なインターフェー

イベントバス

イベントバスは、強力なパブリッシュ/サブスクライブメカニズムを提供します。これにより、Blocklet内のさまざまなコンポーネントや、異なるBlocklet間（同じABT Nodeインスタンス内）であっても、疎結合な方法で相互に通信できます。これは、コンポーネント同士が直接的な依存関係を持つことなく

通知サービス

通知サービスはBlocklet SDKのコアコンポーネントであり、アプリケーションがさまざまな種類の通知をユーザーに送信したり、リアルタイムイベントを購読したりできるようにします。このサービスは、基盤となるABT Nodeの通知機能へのインターフェースとして機能し、単純なユーザーメッセージから、DI

Blocklet Server SDK（Node.js）

@blocklet/server-js は Web アプリを Blocklet Server に接続する公式 JS ライブラリです。

高度な使用法

このセクションでは、標準のクライアントメソッドを超える必要がある、または問題をトラブルシューティングする必要がある開発者向けに、高度なトピックについて説明します。ここでは、Blocklet Server APIに対して直接生のGraphQLクエリを実行する方法や、基盤となるリクエストとレスポンスを検

デバッグ

@blocklet/server-js を使用してアプリケーションを構築する際、APIリクエスト、認証、またはデータ取得に関する問題が発生することがあります。これらの問題のトラブルシューティングを支援するために、クライアントは詳細なデバッグログを提供します。これにより、送信される生のGraphQLク

Raw クエリとサブスクリプション

@blocklet/server-js ライブラリは、ほとんどの一般的な GraphQL 操作に便利なヘルパーメソッドを提供していますが、SDK を通じてまだ公開されていない機能へのアクセスや、より高い柔軟性が必要な状況があります。これらの高度なユースケースのために、このライブラリでは生の Grap

APIリファレンス

@blocklet/server-jsの完全なAPIリファレンスへようこそ。このセクションでは、Blocklet Server Clientを通じて利用可能なすべてのGraphQLクエリ、ミューテーション、およびタイプの詳細なドキュメントを提供します。データの取得、サーバー状態の変更、または扱ってい

ミューテーション

ミューテーションは、Blocklet Server上のデータを作成、更新、または削除するために使用されるGraphQL操作です。@blocklet/server-js ライブラリは、これらのミューテーションをラップする便利なメソッドのセットを提供し、アプリケーションから書き込み操作を簡単に行えるよう

データとオペレーション

このセクションでは、Blocklet Server内のデータ管理および運用タスクに関するミューテーションについて詳しく説明します。主にバックアップの作成と管理、データ構造の移行に焦点を当てています。これらの操作は、データの整合性、更新、および災害復旧にとって重要です。

ネットワークとサービス

このセクションでは、Blocklet Server上のネットワークとサービスを管理するために利用可能なミューテーションについて詳しく説明します。ルーティングルールの設定、SSL/TLS証明書の管理、Webhookのセットアップ、通知の処理などのアクションを実行できます。ネットワークとサービスのデータ

ノードと Blocklet の管理

このセクションでは、Blocklet Server ノードおよびその上で実行されている Blocklet のライフサイクルと設定の管理に関連するミューテーションについて詳しく説明します。これらの操作により、個々の Blocklet とノード自体の両方をプログラムでインストール、開始、停止、設定、アッ

公開とプロジェクト

このセクションでは、Blockletプロジェクトのライフサイクル全体を管理するためのミューテーションについて詳しく説明します。作成やリリース管理から、Blockletストアへの接続、作業の公開までを扱います。これらのミューテーションにより、プロジェクトの開発、バージョン管理、配布方法をプログラムで制

ユーザーとアクセスの管理

このセクションでは、Blocklet内でユーザー、ロール、権限、招待、およびアクセスキーを管理するためのミューテーションに関する詳細なリファレンスを提供します。これらの操作は、アプリケーションでのアクセス制御とID管理に不可欠です。

クエリ

クエリは、Blocklet Serverからデータを取得するために使用されます。@blocklet/server-jsライブラリは、利用可能なGraphQLクエリに対応する一連のメソッドを提供しており、生のGraphQLを記述することなく簡単に情報を取得できます。

データとオペレーション

このセクションでは、Blocklet Serverから運用データを取得するために使用されるGraphQLクエリの詳細なリファレンスを提供します。これらのクエリは、システムの健全性の監視、バックアップの管理、アクティビティの監査、およびトラフィックパターンの洞察を得るために不可欠です。データとオペレー

ネットワーキングとサービス

このセクションでは、Blocklet Server上のネットワーキングとサービスに関連するすべてのGraphQLクエリの詳細なリファレンスを提供します。これらのメソッドを使用すると、ルーティング、ドメイン、証明書、Webhook、および通知のデータと設定を取得できます。これらの設定を変更する操作につ

ノード & Blocklet 管理

このセクションでは、Blocklet Server ノードとそれが実行する blocklet の情報を管理および取得するために使用される GraphQL クエリの詳細なリファレンスを提供します。これらのクエリを使用すると、ステータスの監視、設定の取得、ライフサイクル情報へのアクセスが可能です。

パブリッシング & プロジェクト

このセクションでは、パブリッシングプロジェクト、リリース、および関連リソースを管理するために使用されるGraphQLクエリの詳細なリファレンスを提供します。これらのクエリを使用すると、blockletのパブリッシングライフサイクルに関する情報を取得できます。プロジェクトやリリースの作成や更新など、こ

ユーザーとアクセスの管理

このセクションでは、Blocklet Server内でユーザー、ロール、権限、セッション、およびアクセスキーの管理に関連するクエリの詳細なリファレンスを提供します。これらのクエリを使用すると、アプリケーションのユーザーとそのアクセスレベルに関する情報を取得できます。

型

Blocklet Server Client APIは、クエリとミューテーションのデータを構造化するために、さまざまなGraphQL型を利用します。このセクションでは、API全体で使用されるすべてのデータ型、入力オブジェクト、Enum、およびスカラーに関する包括的なリファレンスを提供します。これらの

認証

@blocklet/server-js ライブラリは、APIリクエストを認証するための2つの主要な方法を提供します：認証トークンとアクセスキーです。適切な方法は、アプリケーションの環境とセキュリティ要件によって異なります。認証トークンは通常、ブラウザのようなユーザー向けのアプリケーションで使用され、

はじめに

このガイドでは、@blocklet/server-js ライブラリを使い始めるためのステップバイステップのウォークスルーを提供します。クライアントのインストール方法、Blocklet Server への接続方法、そして最初の API コールを行う方法を学びます。

概要

@blocklet/server-jsライブラリは、Blocklet Server GraphQL APIと対話するための公式JavaScriptクライアントです。Node.jsとブラウザベースのアプリケーションの両方がBlocklet Serverインスタンスと通信するための便利で強力なインターフ

Blocklet Service

Blocklet 向けの再利用可能なサービス群。認証や通知などを含みます。

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 は Blocklet のメタデータ形式を定め、解析と検証のツールを提供します。

APIリファレンス

@blocklet/meta ライブラリは、blocklet.yml メタデータとプログラムで対話するための包括的なユーティリティ関数スイートを提供します。これらのヘルパーは、解析、検証、データ操作、セキュリティ操作などの一般的なタスクを効率化します。開発ツール、カスタムBlockletランタイム、

コンポーネントと状態のユーティリティ

@blocklet/metaライブラリは、BlockletStateオブジェクトとの対話を簡素化するために設計された、包括的なユーティリティ関数のスイートを提供します。Blocklet、特に複合Blockletは、コンポーネントのツリーとして表現されます。これらのユーティリティは、このツリーを走査し

DIDとウォレットユーティリティ

このセクションでは、分散型識別子（DID）および暗号ウォレットに関連するユーティリティ関数の詳細なリファレンスを提供します。これらのヘルパーは、Blockletのアイデンティティを管理し、アプリケーション固有のウォレットを生成し、ユーザーセッションからアイデンティティ情報を抽出するために不可欠です。

ファイルユーティリティ

このモジュールは、ファイルシステム上の blocklet.yml ファイルと対話するための低レベル関数のセットを提供します。これには、メタデータファイルの検索、読み取り、書き込みのためのユーティリティ、およびファイルパスとDIDのバリデーションを効率化するためのカスタム Joi 拡張機能が含まれてい

メタデータヘルパー

これらのユーティリティ関数は、リモートソースからBlockletメタデータを取得、処理、検証するためのツールキットです。ストアURLやローカルファイルパスからBlockletを解決する場合でも、これらのヘルパーは、ランチャー、開発ツール、レジストリサービスなど、ローカルで利用できないBlocklet

その他のユーティリティ

このセクションでは、@blocklet/meta が提供する特殊なヘルパー関数のコレクションについて説明します。これらのユーティリティは、通信チャネル文字列の解析と作成、アドレスからユニークで視覚的に識別可能なアイコン（Blockies）の生成などのタスクを処理します。

ナビゲーションユーティリティ

これらの関数は、Blockletベースのアプリケーションで動的なユーザーインターフェースを構築するためのエンジンです。これらは、blockletのメタデータ（blocklet.yml）とその現在の状態からnavigationプロパティを解析および処理し、メインのblockletとそのすべての子コンポ

パースと検証

このセクションでは、blocklet.yml ファイルの読み取り、パース、検証に使用される関数の詳細なリファレンスを提供します。これらのユーティリティは、Blocklet Specification を扱うためのプログラム的なインターフェースであり、Blockletのメタデータが正しく、完全で、Bl

セキュリティユーティリティ

@blocklet/metaライブラリは、暗号操作を処理するための一連のセキュリティユーティリティを提供します。これらの関数は、特にBlockletメタデータとAPIレスポンスの署名および検証において、データの完全性と信頼性を確保するために不可欠です。これらはBlockletエコシステム内の信頼の基

URL & パスユーティリティ

このセクションでは、URLフレンドリーな文字列を作成し、URLパスを検証するための一連のヘルパー関数を提供します。これらのユーティリティは、blockletアプリケーション内でクリーンで有効、かつ一貫性のあるルートとリンクを生成するために不可欠です。

はじめに

このガイドでは、@blocklet/meta ライブラリの使用方法を簡単に紹介します。パッケージのインストール方法と、最も一般的なタスクである blocklet.yml ファイルの解析方法を学び、アプリケーション内でそのメタデータにアクセスできるようになります。

概要

@blocklet/meta はBlockletエコシステム内の基礎ライブラリであり、Blockletメタデータを管理するための決定的なツールキットとして機能します。これは blocklet.yml マニフェストファイルの正式な仕様を確立し、このメタデータをプログラムで解析、検証、修正、および操作す

Blocklet 仕様 (blocklet.yml)

blocklet.ymlファイルは、すべてのBlockletの中心です。これは、アプリケーションに関するすべての重要なメタデータを定義するYAMLマニフェストであり、Blocklet Serverやエコシステム内の他のツールにとっての信頼できる唯一の情報源として機能します。

構成 (コンポーネント)

Blocklet の構成は、より小さく独立した Blocklet を組み立てることで、複雑でモジュール化されたアプリケーションを構築できる強力な機能です。このアプローチは、再利用性、関心の分離、およびメンテナンスの容易さを促進します。blocklet.yml ファイルの components プロパ

コアメタデータ

コアメタデータフィールドは、Blockletの基本的なアイデンティティを確立します。これらは、Blockletエコシステム内での識別、バージョニング、および発見可能性のための、一目でわかる必須情報を提供します。すべての blocklet.yml ファイルは、有効と見なされるためにこれらの基本的なプロ

配布とリンク

このセクションでは、blocklet.yml内のフィールドについて説明します。これらのフィールドは、blockletが配布用にパッケージ化される方法を定義し、ソースコード、ホームページ、ドキュメント、その他のリソースへの重要なリンクを提供します。これらのフィールドを適切に設定することは、発見可能性、

実行と環境

blocklet.yml 内の実行と環境の設定は、Blocklet がどのように実行されるかの設計図です。それは、必要なランタイムを指定し、システム要件を定義し、ユーザーに設定オプションを公開し、Blocklet のライフサイクルにフックします。このセクションを正しく設定することは、ポータブルで、堅

インターフェースとサービス

Blockletはインターフェースを介して外部と対話し、サービスを介して強力で再利用可能な機能で強化されます。blocklet.ymlのinterfacesプロパティは、アプリケーションのウェブページ、API、およびその他のエンドポイントを公開するための基礎です。組み込みの認証サービスなどのサービス

収益化

Blocklet 開発者は、OCAP (Open Capability Access Protocol) と NFT を利用した組み込みの支払いシステムを通じて、自身の作品を収益化できます。ユーザーが Blocklet を購入すると、所有権の証明として一意の NFT (BlockletPurchas

人物と所有権

健全なオープンソースエコシステムにとって、作者の帰属を正しく示し、貢献とメンテナンスの役割を定義することは極めて重要です。blocklet.ymlでは、author、contributors、maintainersという3つの異なるフィールドを使用して、プロジェクトに関わる人物を指定できます。これら

セキュリティとリソース

セキュリティとリソース管理は、信頼性が高く相互運用可能なBlockletを作成するために不可欠です。blocklet.yml仕様は、この目的のために2つの主要なフィールドを提供します。signaturesはメタデータの完全性と真正性を保証し、resourceは他のBlockletと構成するための共有

UIとテーマ設定

このセクションでは、blocklet.yml ファイル内の navigation と theme プロパティについて詳しく説明します。これらのプロパティは、ブロックレットがユーザーインターフェースにどのように貢献するかを定義し、メニューでの表示方法を制御し、一貫性のあるユーザーエクスペリエンスを確保

Blocklet Store

Blocklet アプリを公開・入手するためのプラットフォーム。

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 は Blocklet 開発でよく使う UI コンポーネントを提供します。

コンポーネント

このセクションでは、Blocklet UI React ライブラリで利用可能なすべてのUIコンポーネントに関する包括的なリファレンスを提供します。各コンポーネントには、アプリケーションへのスムーズな統合を保証するために、そのプロパティ（props）、実践的な使用例、およびベストプラクティスが記載され

コンポーネント管理

コンポーネント管理は、実行中のアプリケーション内でブロックレットコンポーネントを動的にインストール、公開、管理するための一連のツールを提供します。この機能により、アプリケーションはモジュール式で拡張可能になり、管理者や開発者はコアアプリケーションの完全な再デプロイを必要とせずに機能を追加または更新で

BlockletStudio

BlockletStudioコンポーネントは、ブロックレットリソースの公開と管理のための、効率的で埋め込み可能なユーザーインターフェースを提供します。これは、指定されたブロックレットサービスから専用の公開インターフェースを読み込むフルページのiframeをレンダリングすることで動作します。これにより

ComponentInstaller

ComponentInstaller は、他の Blocklet に依存する機能のゲートキーパーとして機能するユーティリティコンポーネントです。指定されたコンポーネントの依存関係がインストールされているかどうかを検証します。インストールされていない場合、管理者（デフォルトでは owner または a

レイアウト

レイアウトコンポーネントは、blocklet アプリケーションのユーザーインターフェースを構築するための基礎となるビルディングブロックです。これらは、メインヘッダー、フッター、コンテンツエリアを含む、一貫性のある予測可能なフレームワークを提供します。これらのコンポーネントを活用することで、block

Dashboard

Dashboard コンポーネントは、blocklet アプリケーション向けに、レスポンシブなレイアウトを事前に構築して提供します。これは通常、管理インターフェースやユーザー中心のビューに使用されます。blocklet のメタデータを解釈することで、サイドバー、ヘッダー、およびメインコンテンツエリア

Footer

Footer コンポーネントは、アプリケーションに標準化されたレスポンシブなフッターを提供します。blocklet のメタデータを読み取ることで、ブランディング、ナビゲーションリンク、ソーシャルメディアアイコン、著作権情報などのコンテンツを自動的に入力します。このデータ駆動型のアプローチにより、一貫

Header

Header コンポーネントは、Blocklet アプリケーション向けにレスポンシブでカスタマイズ可能なヘッダーを提供します。Blocklet の設定 (blocklet.yml) から直接メタデータを読み取ることで、ナビゲーションリンク、アプリケーションのロゴ、およびユーザーセッションコントロール

通知

このセクションでは、リアルタイムのユーザー通知システムを実装するために利用可能なコンポーネントとユーティリティに関する詳細なガイドを提供します。このシステムは、専用のUIコンポーネントとトーストメッセージを通じて、ユーザーにタイムリーな更新を配信するように設計されています。

ユーザー管理

ユーザー管理スイートは、ユーザー関連の重要な機能を取り扱うために設計された、事前構築済みのReactコンポーネントのコレクションを提供します。これらのコンポーネントは、アプリケーション内でのユーザープロファイル、セッション管理、組織切り替えの実装を簡素化し、一貫性のある信頼性の高いユーザーエクスペリ

UserCenter

UserCenterコンポーネントは、完全なユーザープロファイルと設定管理ページを提供する、包括的な構築済みインターフェースです。ユーザー情報の表示、パスポート管理、プライバシー制御、通知設定、DIDストレージ管理など、さまざまな機能を統合し、ユーザーに一元化されたハブを提供します。

UserSessions

UserSessions コンポーネントは、ユーザーのログインセッションを表示および管理するための包括的なデータテーブルをレンダリングします。さまざまなデバイスにわたるすべてのアクティブ、期限切れ、オフラインのセッションの明確な概要を提供し、ユーザーがアカウントのセキュリティを管理できるようにします

ユーティリティ

このセクションでは、ヘルパーコンポーネント、高階コンポーネント (HOC)、およびユーティリティ関数のコレクションに関するドキュメントを提供します。これらのツールは、一般的な開発タスクを簡素化し、アプリケーションのテーマを管理し、複雑なデータ構造を処理するように設計されています。

Icon

Icon コンポーネントは、Material-UI の Avatar コンポーネントを基に構築された柔軟なユーティリティです。Iconify のアイコン文字列、画像 URL、文字ベースの「レターアバター」など、複数のソースからアイコンをレンダリングするように設計されています。この汎用性により、アプリ

コアコンセプト

このドキュメントでは、Blocklet UI React ライブラリの基本原則について説明します。中心的な設計思想はメタデータ駆動アプローチであり、Header、Footer、Dashboard などの UI コンポーネントは、blocklet のメタデータに基づいて自動的に設定・レンダリングされま

はじめに

このガイドでは、@blocklet/ui-react ライブラリをインストールし、最初のコンポーネントをレンダリングするための手順をステップバイステップで説明します。目標は、最小限の時間でアプリケーション内に機能する Header と Footer を実装することです。

Hooks API

このセクションでは、ライブラリ内で利用可能なカスタム React Hook の詳細なリファレンスを提供します。これらのフックは、ステートフルなロジックをカプセル化して再利用するように設計されており、Blocklet 環境内での一般的なタスクやインタラクションを簡素化します。

操作ガイド

このセクションでは、ライブラリのコンポーネントを使用して一般的なタスクを完了したり、特定のワークフローを実装したりするための、実践的なステップバイステップガイドを提供します。各ガイドは、特定の結果を効率的に達成できるよう、自己完結型の説明書として設計されています。

概要

@blocklet/ui-reactライブラリは、Blockletと呼ばれるアプリケーションの開発を加速するために設計された、必須のReactコンポーネントのコレクションを提供します。これは、Blockletのメタデータをインテリジェントに使用することで、一般的なユーザーインターフェース要素の作成を

Blocklets

Blocklet パッケージ、ローカルファーストの受け入れ、記述の境界、ライフサイクルの証跡に関する ARC 開発者向けドキュメント。

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

コマンド一つで Blocklet プロジェクトの雛形を生成するコマンドラインツール。

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

コンテンツ制作者向けのツール。

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 ガイド

ユーザーとアプリをつなぐオープンプロトコルと開発キット。

DID Connect UI（React）

@arcblock/did-connect-react は DID Connect の UI コンポーネントとセッション管理を提供します。

高度なトピック

SessionProviderやDidConnectのようなコアコンポーネントに慣れたら、@arcblock/did-connect-reactライブラリのより強力で柔軟な機能を探索する準備が整います。このセクションでは、より洗練され、堅牢で、ユーザーフレンドリーな分散型アイデンティティアプリケーシ

認証方法

DID Walletは主要かつ最も安全な認証方法ですが、@arcblock/did-connect-reactは、柔軟性を提供し、多様なユーザーの好みに応えるために、いくつかの代替ログイン方法を強力にサポートしています。このセクションでは、OAuth（ソーシャルログイン）、パスキー（パスワードレス認

ユーティリティ

@arcblock/did-connect-reactライブラリは、認証フロー、データ処理、API通信に関連する一般的なタスクを簡素化するために設計されたユーティリティ関数のコレクションをエクスポートします。コアコンポーネントとフックがほとんどのユースケースを処理しますが、これらのユーティリティは高

APIリファレンス

このセクションでは、@arcblock/did-connect-react ライブラリ全体で使用される主要なTypeScript型すべてに関する包括的なリファレンスを提供します。これらのデータ構造を理解することは、SessionProviderのようなコンポーネントやuseConnectのようなフッ

コアコンポーネント

@arcblock/did-connect-react ライブラリは、分散型アイデンティティをアプリケーションに統合するための基盤を提供するいくつかの重要なコンポーネントを中心に構築されています。これらのコンポーネントは、セッション管理とユーザー向けの接続インターフェースを処理します。

接続 UI (DidConnect)

DidConnect コンポーネントは、さまざまな分散型 ID (DID) 接続フローを処理するための、事前構築済みの包括的な UI ソリューションです。ログイン、認証、プロファイル要求などのアクションのための使いやすいインターフェースを提供し、複数の接続方法を標準でサポートします。

セッション管理 (SessionProvider)

SessionProviderは@arcblock/did-connect-reactライブラリの礎です。これは、セッション関連のすべてのロジック、状態、アクションをカプセル化するReact Context Providerです。アプリケーションをSessionProviderでラップすることにより

はじめに

このガイドでは、@arcblock/did-connect-react を使用して、Reactアプリケーションに分散型ID（DID）認証を統合するための基本的な手順を説明します。わずか数分で、完全に機能するログインおよびログアウトフローを実装できます。

フック

@arcblock/did-connect-react ライブラリは、プログラムによる制御と柔軟なデータアクセスを提供する強力なReactフックのセットを提供します。SessionProvider は便利なコンテキストベースのアプローチを提供しますが、フックは複雑なUIや高度なユースケースに必要なき

useConnect

useConnectフックは、DidConnect UIモーダルをプログラムで開閉・管理するための強力な方法を提供します。宣言的なButtonコンポーネントが提供するものよりも接続フローをより詳細に制御する必要がある場合、例えばカスタムUI要素、メニュー項目、またはアプリケーションイベントに応じてモ

useDid

useDidフックは、session.userオブジェクトから特定のDID関連情報を簡単に抽出して操作するための便利なユーティリティです。手動での処理なしに、永続DID、ウォレット情報、接続済みアカウントなどの一般的に必要なデータを取得するためにユーザーオブジェクトの解析を簡素化します。

useOAuth & usePasskey

DidConnect コンポーネントと useConnect フックは、すべての認証方法に対応する包括的なビルド済み UI を提供しますが、カスタムの認証フローを構築する必要がある場合もあります。useOAuth フックと usePasskey フックは、ソーシャルログイン (OAuth) とパスワ

概要

@arcblock/did-connect-reactライブラリは、分散型アイデンティティ（DID）機能をウェブアプリケーションにシームレスに統合するために設計された、包括的なReactコンポーネントとフックのセットを提供します。ArcBlockのDID Walletを使用したユーザー認証とセッショ

UIコンポーネント

@arcblock/did-connect-reactライブラリには、DID関連情報を一貫性があり、美しく表示するのに役立つように設計された、事前にスタイル設定された補助的なUIコンポーネントのセットが含まれています。これらのコンポーネントは、コア接続フローとシームレスに連携し、堅牢な@arcblo

Address

Addressコンポーネントは、分散型識別子（DID）アドレスをクリーンで読みやすく、ユーザーフレンドリーな形式で表示するために設計された特殊なUI要素です。DIDに典型的な長い文字列を、短縮や簡単なコピーのオプションを提供することで賢く処理し、全体的なユーザーエクスペリエンスを向上させます。

Avatar

Avatarコンポーネントは、ユーザーのプロフィール画像を表示するためのシンプルで便利な方法です。ユーザーの分散型識別子（DID）に基づいてユニークなアバターを自動生成したり、指定されたURLから画像を表示したりできます。

Button

ConnectButtonコンポーネントは、DID Connect認証プロセスを開始するための、事前にスタイル設定された認識しやすいボタンを提供します。これにより、アプリケーションのログインフローに一貫したユーザーエクスペリエンスを簡単に作成できます。このボタンは、ロゴやカラースキームを含む公式のD

ロゴ

Logoコンポーネントは、アプリケーション内に公式のDID Connectロゴをシンプルかつ一貫して表示する方法を提供します。これはブランド表現のために設計された単純なビジュアルコンポーネントであり、ユーザーがおなじみの分散型ID接続方法を認識できるようにします。

DID Connect SDK（Node.js）

@arcblock/did-connect-js は Node.js アプリに DID Connect の認証を組み込みます。

APIリファレンス

このセクションでは、DID Connect SDKで利用可能なコアクラス、コンストラクタ、メソッド、およびオプションの詳細なドキュメントを提供します。これらのコンポーネントを理解することは、アプリケーションのために堅牢で安全な認証フローを構築する鍵となります。

WalletAuthenticator

WalletAuthenticatorは、DID Connectセッションにおけるサーバーサイドロジックのコアクラスです。認証リクエストの作成、レスポンスへの署名、ユーザーのウォレットから返されたデータの検証を担当します。特定のWebフレームワークから独立して動作し、すべての暗号化操作とJWT管理を

WalletHandlers

WalletHandlers クラスは、DID Connect ワークフローを Express.js または同様のサーバーサイドフレームワークにシームレスに統合するために設計された高レベルのユーティリティです。指定されたアクションに必要なすべての API エンドポイントの設定を自動化し、アプリケーシ

同意クレーム

同意クレームは、利用規約、プライバシーポリシー、その他の正式な合意書などの文書に対するユーザーの明確な同意を得るための強力なツールです。このクレームは、単純なチェックボックスの代わりに、ユーザーが文書のハッシュ（ダイジェスト）に暗号署名することを要求し、検証可能で否認不可能な同意の記録を作成します。

アセットクレーム

アセットクレームは、非代替性トークン（NFT）などの特定のオンチェーンデジタルアセットの所有権証明をユーザーに要求するために使用されます。これは、特定のアセットの所有者にサービスやコンテンツへのアクセスを制限する、NFTゲートアクセスのようなシナリオで特に役立ちます。

アセットまたはVCクレーム

assetOrVC クレームは、ユーザーに、指定された一連の基準を満たすオンチェーンアセット（NFTなど）または検証可能なクレデンシャル（VC）のいずれかの所有証明を提示するよう要求する柔軟な方法を提供します。これは、複数の資格形式が受け入れられる、柔軟なアクセス制御を要するシナリオで特に役立ちます

Auth Principal クレーム

authPrincipalクレームは、あらゆるDID Connectセッションの基盤です。これは最も基本的で一般的に使用されるクレームであり、ユーザーにウォレットを接続し、アプリケーションと対話するための分散型識別子（DID）を選択するよう求めるように設計されています。この最初のステップで安全なセッ

クレームリファレンス

DID Connectを使用すると、アプリケーションはユーザーのデジタルウォレットから特定の情報やアクションを要求できます。これらの要求は「クレーム」と呼ばれます。各クレームタイプは、単純な身元確認から、トランザクション署名やデジタルクレデンシャルの提示などの複雑なマルチステップワークフローまで、そ

暗号化キー要求

encryptionKey 要求は、アプリケーションがユーザーのウォレットから秘密の暗号化キーを要求できるようにする強力な機能です。このキーは、ウォレットのマスターシークレットと、あなたが提供する salt から決定論的に導出されます。これにより、アプリケーションはユーザーのプライマリプライベートキ

キーペアクレーム

キーペアクレームは、アプリケーションがユーザーのウォレットに新しい暗号キーペアの生成を要求できるようにする強力な機能です。これは、ユーザーのウォレットによって安全に管理されながら、あなたのサービスとの対話専用の新しいアプリケーション固有のアカウントやアイデンティティを作成するのに特に役立ちます。

トランザクション準備クレーム

prepareTx クレームは、特に支払いと資産移転のシナリオで、ユーザーにトランザクションの完了と署名を必要とするdAppsにとって強力なツールです。トランザクション全体が事前に定義されている標準的な signature クレームとは異なり、prepareTx は部分的に構築されたトランザクション

プロファイルクレーム

プロファイルクレームは、ユーザーのDIDウォレットから個人情報を要求するために使用されます。これは多くのアプリケーションにとって基本的なステップであり、ユーザーの明確な同意を得てユーザーデータを安全に取得することにより、ユーザー登録、パーソナライズされた体験、コミュニケーションなどの機能を可能にしま

Signature Claim

Signature Claimは、ユーザーにDIDに関連付けられた秘密鍵を使用して任意のデータに署名するよう要求するための多目的なツールです。この暗号署名は、ユーザーがデータを見て承認したことの否定できない証明として機能し、デジタルアイデンティティの制御を効果的に示します。一般的な使用例には、メッセ

検証可能な資格情報クレーム

検証可能な資格情報（VC）は、保有者に関する何かを証明するために使用できる、改ざん防止のデジタル資格情報です。検証可能な資格情報クレームにより、アプリケーションはユーザーにDIDウォレットから特定のVCを提示してもらい、属性、資格、または権利を証明するよう要求できます。

使用例

使用例セクションへようこそ。ここでは、DID Connectのさまざまな機能を素早く理解し、実装するのに役立つ、実践的でエンドツーエンドの使用例を集めています。各使用例では、プロセスをガイドするための実行可能なコードスニペットと共に、現実世界のシナリオを提供します。

マルチチェーン接続

DID Connect は相互運用性を念頭に設計されており、その機能は ArcBlock エコシステムを超えて拡張されています。イーサリアムやソラナなどの他の主要なブロックチェーンとシームレスにやり取りするように設定できます。この例では、イーサリアムネットワーク上でアクションを要求する DID Co

マルチステップセッション

多くの実世界のアプリケーションでは、単一のインタラクションではタスクを完了できません。プロファイルの登録、資産の所有権の確認、そして最後にユーザー契約への署名など、一連のステップを通じてユーザーをガイドする必要があるかもしれません。DID Connectライブラリは、複数のセッションを連結して単一の

NFT の提示

この例では、特定の非代替性トークン (NFT) またはオンチェーンアセットを所有するユーザーに、アプリケーションの特定のコンテンツや機能へのアクセスを制限する方法を示します。これは、限定メンバーシップ、イベントチケット、または特別なデジタルアイテムに使用される一般的な Web3 パターンです。

シンプルなログイン

この例では、DID Connect を使用して基本的なユーザーログインシステムを実装するためのステップバイステップガイドを提供します。目標は、ユーザーをDIDウォレットで認証し、名前やメールアドレスなどの基本プロファイル情報を取得することです。これは、このライブラリの最も一般的なユースケースの1つで

トランザクション決済

この例では、DID Connect の一般的で強力なユースケースである、ユーザーにオンチェーントランザクションへの署名と送信を要求して支払いを行う方法を示します。このパターンは、Eコマースのチェックアウト、サービスのサブスクリプション、コンテンツの購入など、トークンや資産の転送を必要とするあらゆる

はじめに

このガイドでは、Node.js アプリケーションで基本的な DID Connect セッションをセットアップするための、最小限のステップバイステップの例を提供します。このチュートリアルを終える頃には、DID ウォレットを介してユーザーのプロフィール情報を要求できるサーバーが動作するようになります。

ガイド

DID Connect ガイドへようこそ。このセクションでは、一般的なユースケースを実装し、ライブラリの高度な機能を活用するための実践的でステップバイステップの手順を説明します。初めての DID Connect セッションを設定する場合でも、複雑なマルチステップのワークフローを構築する場合でも、これ

ワークフローの連鎖

DID Connect を使用すると、複数の個別の認証セッションをリンクさせ、単一の初回インタラクションからユーザーのためのシームレスなマルチステッププロセスを作成できます。これは、ユーザー登録後のKYC、またはログイン後の取引確認のような複雑なシナリオに最適です。

デリゲート接続

デリゲート接続は、アプリケーションが一時的または低権限の「agent」DIDを使用してDID Connect操作を実行できるようにすることでセキュリティを強化する高度な機能です。これにより、エンドユーザーには主要で公式なDIDを提示し続けることができます。これは、アプリケーションのメインの秘密鍵が、

ウォレットの応答の処理

クレームのリクエストガイドで示したようにDID Connectセッションのクレームを定義した後、次の重要なステップは、ユーザーのDIDウォレットからの応答を処理することです。@arcblock/did-connect-jsライブラリは、ユーザーが承認、拒否、またはセッションがタイムアウトした場合など

クレームのリクエスト

DID Connectセッションにおいて、「クレーム」とは、ユーザーのウォレットに対してリクエストする特定の情報やアクションのことです。これには、氏名やメールアドレスから、資産の所有権を証明する暗号署名まで、あらゆるものが含まれます。このガイドでは、ユーザーにクレームをリクエストするさまざまな方法に

DID Connectワークフロー

DID Connectセッションは、ユーザーがDID Walletを使用して分散型アプリケーション（DApp）と対話することを可能にする、安全で分散型の認証プロセスです。このガイドでは、最初のQRコードスキャンからユーザーの応答の最終的な処理まで、エンドツーエンドのプロセスを解説します。

概要

DID Connect へようこそ。これは、分散型識別子（DID）を使用したシームレスで安全な認証のために設計されたプロトコルです。このライブラリ @arcblock/did-connect-js は、DID Connect を Node.js アプリケーションに統合するために必要なツールを提供しま

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

NFT と検証可能な資格情報にもとづくネーミングサービス。

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 は Node.js から DID Space をプログラム的に操作します。

APIリファレンス

DID Space Client SDKの完全なAPIリファレンスへようこそ。このセクションでは、利用可能なすべてのクラス、メソッド、およびコマンドに関する詳細なドキュメントを提供します。特定の情報を迅速に見つけ、SDKの全機能を理解するのに役立つ包括的なリソースとなるように設計されています。

NFT コマンド

NFT 関連のアセットとそれに関連する DID ドキュメントを処理するための専門コマンドです。これらのコマンドは、非代替性トークン（NFT）として表現されるデジタルアセットを DID スペースに保存するプロセスを効率化します。

PutNftObjectCommand

PutNftObjectCommand は、デジタルアセット（画像、ビデオ、オーディオファイルなど）をアップロードすると同時に、関連する DID ドキュメントを作成または更新するために設計された特殊なコマンドです。このプロセスは、分散型識別子（DID）を特定のデータ片に効果的にリンクさせます。これは

オブジェクトコマンド

オブジェクトコマンドは、DID Space 内の個々のファイル（または「オブジェクト」）を操作するためのコアツールです。これらは、すべての CRUD（作成、読み取り、更新、削除）操作の基本的な構成要素を提供し、プログラムによるファイルのアップロード、ダウンロード、一覧表示、削除を可能にします。

DeleteObjectCommand

DeleteObjectCommand は、DID Space からオブジェクトを永久に削除するために使用されます。この操作は元に戻すことはできません。

GetObjectCommand

GetObjectCommand は、DID Space からオブジェクトを取得またはダウンロードするために使用されます。オブジェクトのコンテンツは読み取り可能なストリームとして返されるため、メモリを過剰に消費することなく、あらゆるサイズのファイルを効率的に処理できます。

ListObjectsCommand

ListObjectsCommand は、DID Space内の指定されたパスからオブジェクト（ファイルまたはディレクトリ）のリストを取得するために使用されます。フラットな（直下の子のみをリストアップ）ディレクトリトラバーサルと、再帰的な（すべてのネストされたアイテムをリストアップ）ディレクトリトラ

PutObjectCommand

PutObjectCommand は、DID Space に新しいオブジェクトをアップロードしたり、既存のオブジェクトを更新したりするために使用されます。このコマンドは多機能で、ファイル、文字列、バッファなど、さまざまなデータ型を扱うことができるため、スペースにコンテンツを追加する主要な方法となりま

SpaceClient

SpaceClient は、DID Space API と対話するための主要なインターフェースです。SDK のメインエントリポイントであり、設定、認証、および DID Space へのコマンドのディスパッチを担当します。

同期コマンド

DID Space 内のローカルフォルダとリモートディレクトリの状態を同期するための高レベルのコマンドです。これらのコマンドは、差分を自動的に検出し、必要な操作を実行することで、ディレクトリの同期を維持する複雑なプロセスを簡素化します。

SyncFolderPullCommand

SyncFolderPullCommandは、DID Spaceからローカルフォルダにリモートディレクトリを同期するために設計された高レベルのコマンドです。リモートのソースとローカルのターゲット間のファイルをインテリジェントに比較し、新しいファイルまたは更新されたファイルのみをダウンロードします。こ

SyncFolderPushCommand

SyncFolderPushCommand は、ローカルディレクトリを DID Space 内のリモートディレクトリと効率的に同期するために設計された高レベルのコマンドです。ローカルとリモートの状態をインテリジェントに比較し、新規または変更されたファイルをアップロードし、オプションでローカルに存在し

クライアントの初期化と認証

SpaceClient は、DID Space ネットワークとやり取りするための主要なインターフェースです。ファイルをアップロードしたり、データを管理したりする前に、まず正しい設定と認証情報でクライアントのインスタンスを作成する必要があります。このガイドでは、SpaceClient を初期化し、認証

コアコンセプト

このセクションでは、@blocklet/did-space-js SDKを支える基本原則とアーキテクチャパターンについて詳しく解説します。これらのコンセプトを理解することで、ライブラリをより効果的に使用し、自信を持って問題をトラブルシューティングできるようになります。このSDKは、堅牢なコマンドパタ

リクエスト署名

DID Spaceとのすべてのインタラクションのセキュリティと完全性を確保するため、すべてのAPIリクエストは堅牢な暗号署名メカニズムによって保護されています。このプロセスにより、リクエストが本物であること（主張されたアイデンティティによって送信されたこと）、そして転送中に改ざんされていないことが保

はじめに

DID Space Client SDK へようこそ！このガイドでは、SDK のインストール、設定、そして最初のファイルアップロードを実行するための基本的な手順を説明します。ほんの数分で準備が整います。

ガイド

ガイドセクションへようこそ。ここでは、DID Space Client SDK を使用して一般的なタスクを実行したり、特定の機能を実装したりするのに役立つ、実践的なステップバイステップのチュートリアルを紹介します。各ガイドは、現実世界のワークフローに焦点を当て、完全なコード例とベストプラクティスを提

フォルダプレビューの管理

DID Spaceでは、任意のフォルダにカスタムプレビューを設定できます。この機能により、アプリケーションでフォルダがどのように表示されるかを定義でき、単純なファイルリストを、ギャラリー、ドキュメントプレビュー、あるいはミニアプリケーションのようなリッチでインタラクティブな体験に変えることができます

フォルダーの同期

ローカルディレクトリと DID Space 内のリモートディレクトリを同期させることは、静的ウェブサイトのホスティング、データバックアップ、共同アセット管理などのアプリケーションで一般的な要件です。DID Space Client SDK は、SyncFolderPushCommand と Sync

概要

JavaScript 用 DID Space Client SDK へようこそ！これは Node.js 環境向けに設計された、強力でモダンなライブラリで、DID Space とのシームレスな対話を可能にします。ユーザーが自身のデータを真に所有し、管理するアプリケーションを構築しているなら、ここは最適

ユーティリティ

@blocklet/did-space-js ライブラリは、アプリケーションの構築中に遭遇する一般的なタスクを簡素化するために設計されたユーティリティ関数のコレクションをエクスポートします。これらのヘルパーは、DID のフォーマット、URL の正規化、エンコーディング、エラー解析などの操作を処理する

DID Spaces ガイド

DID Spaces の使い方：機能、特性、サポート窓口。

DID Spaces UI（React）

@blocklet/did-space-react は DID Spaces への接続と利用のための React コンポーネント集。

APIリファレンス

このセクションでは、DIDSpaceConnectおよびDIDSpaceConnectionコンポーネントでpropsとして使用される主要なTypeScriptの型とインターフェースについて解説します。これらのデータ構造を理解することは、開発者がライブラリの能力を最大限に活用し、型の安全性を確保し、

型

このセクションでは、DID Space コンポーネントライブラリ全体で使用されるコア TypeScript の型とインターフェースの詳細なリファレンスを提供します。これらのデータ構造を理解することは、コンポーネントのプロパティを正しく型付けし、アプリケーションの状態を管理するために不可欠です。

コンポーネント

DID Space Reactライブラリは、DID Spacesへの接続と対話のプロセスを効率化するための一連のコアコンポーネントを提供します。これらのコンポーネントは、認証、ステータスチェック、データ表示のための複雑なロジックをカプセル化しており、機能豊富なアプリケーションを簡単に構築できます。

DIDSpaceConnect

DIDSpaceConnectコンポーネントは、DID Spaceへの接続を開始するための多機能なボタンを提供します。初回接続や再接続を含むさまざまな認証フローを簡素化し、永続的なストレージのためにユーザーセッションと統合することができます。

DIDSpaceConnection

DIDSpaceConnection コンポーネントは、接続されたDID Spaceに関する主要情報を表示するために設計された多目的なUIカードです。NFTアバター、名前、DID、現在の接続ステータスなど、スペースの詳細を明確かつインタラクティブに表示する方法を提供します。

はじめに

このガイドでは、DID Spaceの機能をReactアプリケーションに統合するための基本的な手順を説明します。必要なパッケージのインストール方法と、ユーザーがDID Spaceに接続してその詳細を表示できる基本的なコンポーネントの実装方法を学びます。

概要

@blocklet/did-space-reactのドキュメントへようこそ。このライブラリは、DID Spaceをアプリケーションに統合するプロセスを簡素化するために設計されたReactコンポーネントのセットを提供します。これらのツールを使用すると、ユーザーがDID Spaceに接続して関連情報を表

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 ガイド

DID Wallet の使い方：複数のチェーンに対応し、アイデンティティと資産をまとめて管理します。

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 Framework 上に構築されたドキュメント生成ツール。ソースコードから構造化された多言語ドキュメントを直接生成します。

設定リファレンス

config.yamlファイルは、ドキュメント生成のコアコントロールパネルです。その設定を調整することで、ドキュメントの構造、コンテンツのスタイル、言語サポートなど、AIがドキュメントを生成する方法を制御できます。このガイドでは、プロジェクトのニーズに合わせて微調整できるよう、各設定フィールドについ

初期設定

このガイドでは、AIGNE DocSmith の対話式セットアッププロセスをステップバイステップで説明します。この手順は aigne doc create を初めて実行する際に自動的に実行されますが、手動で開始することも可能です。目的は、ドキュメント生成のための設定を保存する config.yaml

設定の管理

AI アシスタントに指示を記憶させたいと思ったことはありませんか？このガイドでは、ドキュメント作成用に保存された設定を表示、削除、切り替える方法を説明し、AI の出力を細かく制御して、プロジェクト固有のスタイルに一貫して従うようにします。

トラブルシューティング

このガイドは、AIGNE DocSmith を使用する際の一般的な問題を診断し、修正するのに役立ちます。生成、公開、または設定中に問題が発生した場合は、以下のシナリオの解決策を確認してください。

はじめに

このガイドでは、AIGNE DocSmith をインストールし、最初のドキュメントセットを生成するための直接的なステップバイステップの手順を説明します。このプロセスは数分で完了するように設計されており、最小限のセットアップでプロジェクトファイルからドキュメントを生成できます。

ガイド

このセクションでは、AIGNE DocSmith を使用して一般的なドキュメント作成タスクを実行するための、構造化されたステップバイステップの手順を説明します。各ガイドは、最初の生成から最終的な公開まで、特定のワークフローを順を追って説明するように設計されています。

ドキュメントの追加

ドキュメントに抜けがあることに気づいたことはありますか？aigne doc add-document コマンドは、既存のドキュメント構造に新しいトピックを導入するための、わかりやすくインタラクティブな方法を提供し、プロジェクトと共にコンテンツが成長することを保証します。

クリーンアップ

プロジェクトのリセットや機密データの削除が必要ですか？このガイドでは、aigne doc clear コマンドを使用して、生成されたファイル、設定、キャッシュ情報を安全に削除する方法を説明します。これにより、クリーンで整理されたワークスペースを維持できます。

ドキュメントの評価

ドキュメントが目標を達成しているか気になりますか？このガイドでは、ドキュメントの品質と完全性を体系的に評価し、改善を導くための明確で実行可能なレポートを提供する強力なツールであるevaluateコマンドを紹介します。評価の実行方法とその結果の解釈方法を学びます。

ドキュメント生成

このガイドでは、単一のコマンドを使用して、プロジェクトのソースファイルから完全なドキュメントセットを作成する方法を順を追って説明します。このプロセスは、初期分析から最終的なコンテンツ生成まで、対話的なレビュー手順を挟んで、出力が必要な構造に正確に合致するように設計されています。

インタラクティブモード

コマンドラインのオプションに圧倒されていませんか？このガイドでは、ドキュメント作成プロセスのあらゆるステップを簡素化する対話型インターフェース、インタラクティブモードの使い方を説明します。このガイドを読み終える頃には、シンプルで自然な言語の指示を使って、ドキュメントの生成、更新、翻訳、公開ができるよ

履歴の管理

ドキュメントにいつ、どのような変更が加えられたか気になったことはありませんか？AIGNE DocSmith は、すべての更新の詳細なログを保持します。このガイドでは、この履歴にアクセスして読む方法を説明し、ドキュメントの変遷を簡単に追跡できるようにします。

ドキュメント公開

ドキュメントが生成されたら、最後のステップはそれをオンラインで利用可能にすることです。このドキュメントでは、aigne doc publish コマンドを使用してドキュメントを公開し、読者がアクセスできるようにする手順を段階的に説明します。

ドキュメントの削除

ドキュメントを正確に保つには、コンテンツを追加するだけでなく、整理することも重要です。このガイドでは、aigne doc remove-document コマンドを使用してプロジェクトからドキュメントを安全に削除し、ドキュメントセットをクリーンで関連性の高い状態に保つ方法について詳しく説明します。

ドキュメントのローカライズ

ドキュメントを多言語で利用できるようにすることは、グローバルなオーディエンスにリーチするために不可欠です。このガイドでは、aigne doc localize コマンドを使用してコンテンツをサポートされている12言語のいずれかにローカライズするためのステップバイステップのプロセスを提供し、世界中のユ

コンテンツの更新

このガイドでは、update コマンドを使用して既存のドキュメントを修正する方法について説明します。ドキュメントのコンテンツを更新したり、図を追加または更新したり、フィードバックを通じて図を削除したりできます。

ドキュメントの更新

プロジェクトの進化に伴い、ドキュメントもそれに追随する必要があります。このセクションでは、ドキュメントセットの変更に関連するすべてのタスクを一元的に管理し、その正確性と関連性を維持するための中心的なハブを提供します。ここでは、既存のコンテンツの変更、新しいドキュメントの追加、古いファイルの削除に関す

概要

AIGNE DocSmith は、AI を使用してプロジェクトのソースコードを分析し、ドキュメントを自動的に生成するドキュメンテーションツールです。AIGNE Framework 上に構築されており、コードベースと同期した構造化された多言語ドキュメントを生成します。このプロセスは、時間がかかり、古く

リリースノート

AIGNE DocSmith の最新の開発状況を常に把握できます。このページでは、ツールの各バージョンにおける新機能、パフォーマンス改善、バグ修正の履歴を時系列で提供します。

DIF Hackathon ガイド（2024）

2024 年 DIF Hackathon の要点。

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

アイデンティティとデータスペース

ARC の呼び出し元コンテキスト、DID 単位のストレージ、セッションデータのビュー、およびそれらの検証済みの境界について。

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 をより早く立ち上げるための ArcBlock のホスティングサービス。

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

メディア素材をアップロード・ホスティングする Blocklet。ドラッグ＆ドロップ、画像タグ、CDN 連携に対応。

API リファレンス

Blocklet Uploader パッケージの API リファレンスへようこそ。このセクションでは、フロントエンドとバックエンドの両ライブラリでエクスポートされるすべてのコンポーネント、関数、プロップ、および設定オプションに関する包括的な詳細を提供します。これは、詳細な技術情報を得るための頼りにな

コンポーネントの Props

フロントエンド: @blocklet/uploader

@blocklet/uploader パッケージは、Blockletエコシステム内でファイルアップロードを処理するための、強力で高度にカスタマイズ可能なReactコンポーネントを提供します。洗練されたモジュール式のオープンソースファイルアップローダーである Uppy をベースに構築されており、堅牢で

利用可能なプラグイン

@blocklet/uploaderは、コアのUppyライブラリを、いくつかの強力なカスタムビルドプラグインで拡張します。これらのプラグインは、Blockletエコシステム、特にMedia Kitとシームレスに統合され、AI画像生成、以前にアップロードされたファイルの閲覧、共有リソースへのアクセスな

とフック

より高度なユースケースでは、アプリケーションの別の部分からUploaderをトリガーしたり、プログラムでその動作を制御したりする必要があるかもしれません。UploaderProvider コンポーネントとそれに関連するフックは、ReactのContext APIを使用して、UploaderのUIをそ

initCompanion(options)

initCompanion 関数は、Uppy Companion ミドルウェアを初期化して設定します。これは、ユーザーが Unsplash、Google Drive、Instagram、または直接 URL などのリモートソースからファイルをインポートできるようにするために不可欠です。この関数は、bl

initDynamicResourceMiddleware(options)

initDynamicResourceMiddlewareは、指定された1つ以上のディレクトリからファイルを動的に提供するために設計された強力なExpressミドルウェアです。initStaticResourceMiddlewareとは異なり、ファイルシステムの変更（追加、削除、変更）をリアルタイム

バックエンド: @blocklet/uploader-server

@blocklet/uploader-server パッケージは、ブロックレットのバックエンドで様々なファイル処理タスクを扱うために設計された Express.js ミドルウェアのスイートを提供します。これは、@blocklet/uploader フロントエンドコンポーネントのサーバーサイド対応部分

initLocalStorageServer(options)

initLocalStorageServer 関数は、ユーザーのデバイスから Blocklet のローカルストレージへ直接ファイルをアップロードする処理を行うための中核となるミドルウェアです。堅牢な Tus resumable upload protocol を利用しており、信頼性の高いアップロード

initStaticResourceMiddleware(options)

initStaticResourceMiddlewareは、インストール済みの他のblockletから静的アセットを配信するために設計された、強力なExpressミドルウェアです。これにより、アプリケーションは、ファイルシステム上の正確な場所を知らなくても、依存するコンポーネントから画像、スタイルシ

ユーティリティ関数

@blocklet/uploader/utils モジュールは、ファイルの処理、URL の操作、Uppy インスタンスのカスタマイズ、およびネットワーク設定に関連する一般的なタスクを簡素化するために設計されたヘルパー関数のコレクションをエクスポートします。これらのユーティリティは、Uploader

コンセプト

@blocklet/uploader パッケージは、強力で統合しやすいように設計されています。最大限に活用するためには、その機能を支えるコアコンセプトと主要な統合を理解することが役立ちます。このセクションでは、アップローダーの背後にある基盤技術と設計原則について説明します。

国際化 (i18n)

@blocklet/uploader コンポーネントは、世界中のユーザーを念頭に置いて設計されており、多言語とテキストのカスタマイズを強力にサポートします。これにより、ユーザーの場所に関係なく、ネイティブに感じられるシームレスなユーザーエクスペリエンスを作成できます。

Media Kitとの連携

@blocklet/uploaderパッケージは、Media Kit blockletとのシームレスでゼロコンフィギュレーションの連携を実現するために設計されています。Media Kitは、メディアの保存、管理、処理のための一元化されたサービスを提供します。Uploaderコンポーネントが同じ環境に

Uppyとの統合

@blocklet/uploader パッケージは、ウェブ向けの洗練されたモジュール式のオープンソースファイルアップローダーである Uppy の上に直接構築されています。ファイルアップローダーをゼロから構築する代わりに、私たちは Uppy の強力なコアエンジン、豊富なプラグインエコシステム、洗練され

バックエンドのセットアップ (@blocklet/uploader-server)

このガイドでは、Express.jsベースのブロックレットに @blocklet/uploader-server パッケージをセットアップする方法を説明します。このパッケージは、@blocklet/uploader フロントエンドコンポーネントによって開始されるファイルアップロードを処理するために必

はじめに

このガイドでは、強力なファイルアップローダーをあなたのblockletに統合するための基本的な手順を説明します。フロントエンドUIコンポーネントと、オプションのバックエンドサーバー設定の両方について説明し、迅速に使い始められるようにします。

フロントエンドの設定 (@blocklet/uploader)

このガイドでは、@blocklet/uploader React コンポーネントを Blocklet にインストールして統合するプロセスを説明します。このコンポーネントは、堅牢で拡張性の高い Uppy ファイルアップローダーを基盤に構築された、機能豊富なファイルアップロード用ユーザーインターフェース

プラグインの設定

@blocklet/uploader コンポーネントは、柔軟で強力な Uppy ファイルアップローダーを基盤に構築されています。このアーキテクチャにより、プラグインベースのシステムを通じて広範なカスタマイズが可能です。Uploaderには、いくつかの必須プラグインが標準で事前設定されているほか、Bl

カスタムプラグインの作成

@blocklet/uploaderは拡張性を考慮して設計されています。いくつかの強力な組み込みプラグインが付属していますが、独自のカスタムタブを簡単に追加して、ユニークなワークフローを統合したり、プロプライエタリなサービスに接続したり、特化したユーザーインターフェースを提供したりすることができます

ガイド

ガイドセクションへようこそ。ここでは、アップローダーの一般的な機能やカスタマイズを実装するための、実践的でタスク指向のウォークスルーを提供します。これらのガイドは、はじめにセクションで紹介された概念に基づいており、実際のシナリオに沿ったステップバイステップの手順を説明します。

アップロードの処理

ファイルが正常にアップロードされた後、クライアントとサーバーの両方でアクションを実行する必要がよくあります。このガイドでは、@blocklet/uploader フロントエンドコンポーネントと @blocklet/uploader-server ミドルウェアの両方で onUploadFinish コ

リモートソースの統合 (Companion)

ユーザーが直接のURLやUnsplashのようなサービスなどの外部ソースからファイルをインポートできるようにするには、バックエンドにUppyのCompanionサービスをセットアップする必要があります。@blocklet/uploader-server パッケージは、このプロセスを簡素化する便利な

概要

Blocklet Uploaderは、blocklet向けに設計された包括的なファイルアップロードソリューションで、堅牢で拡張性の高いUppyファイルアップローダーを基盤に構築されています。これは、ブラウザのユーザーインターフェースからサーバーでのファイル処理まで、シームレスな体験を提供するために連

NFT Studio

デジタル制作者が制作の全工程を自分で握るためのツール。

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 は Blocklet の決済まわりの UI を構成する React ライブラリです。

コンポーネント

@blocklet/payment-react ライブラリは、支払い、サブスクリプション、寄付機能の開発を加速するために設計された、事前に構築されたReactコンポーネントの包括的なスイートを提供します。これらのコンポーネントは、完全なドロップインソリューションが必要な場合でも、カスタムエクスペリエ

ビジネスロジックコンポーネント

ビジネスロジックコンポーネントは、サブスクリプションと請求書管理に関連する複雑でステートフルな操作を処理するために設計された、特殊なReactコンポーネントです。これらのコンポーネントは、延滞請求書の支払いやキャンセルされたサブスクリプションの再開など、ユーザーフロー全体をカプセル化し、最小限のセッ

自動チャージコンポーネント

自動チャージ機能は、ユーザーのクレジット残高が指定されたしきい値を下回った場合に自動的にチャージすることで、サービスの中断を防ぎます。これは主に2つのコンポーネントで管理されます：現在の設定を表示するAutoTopupと、設定用のインターフェースを提供するAutoTopupModalです。

OverdueInvoicePayment

OverdueInvoicePaymentコンポーネントは、特定の顧客またはサブスクリプションの支払い期限を過ぎた請求書の支払いを処理するために設計された専門ツールです。期限切れの請求書を自動的に取得し、ユーザーに未払いの支払いを清算するための明確なインターフェースを提供することで、プロセスを簡素化

ResumeSubscription

ResumeSubscription コンポーネントは、キャンセルされたサブスクリプションをユーザーが再開するための、分かりやすいUIを提供します。ユーザーを確認プロセスに沿って案内するダイアログをレンダリングし、サブスクリプションで必要な場合には再ステーキングのような複雑なシナリオも自動的に処理し

チェックアウトコンポーネント

@blocklet/payment-react ライブラリは、さまざまな支払いシナリオに対応する、すぐに使える完全なエントリーポイントとして設計された、高レベルのチェックアウトコンポーネントのセットを提供します。これらのコンポーネントは、製品の選択から支払いの完了まで、ユーザーフロー全体をカプセル化

CheckoutDonate

CheckoutDonateコンポーネントは、アプリケーションに寄付機能を追加するための、柔軟で統合しやすいソリューションを提供します。チェックアウトダイアログを開くシンプルなボタンから、完全に制御可能なカスタムUIまで、さまざまな表示モードをサポートしています。

CheckoutForm

CheckoutFormコンポーネントは、支払いリンクとチェックアウトセッションを処理するための主要なエントリーポイントです。提供されたIDに基づいて必要なすべてのデータを取得し、適切な支払いまたは寄付インターフェースをレンダリングする高レベルのラッパーとして機能します。このコンポーネントは、完全な

CheckoutTable

CheckoutTableコンポーネントは、サブスクリプションのチェックアウトのための、すぐに使える完全なソリューションを提供します。価格表を取得してレンダリングし、ユーザーがプランを選択できるようにし、その後シームレスに支払いフォームに移行して購入を完了させます。この高レベルコンポーネントは、プラ

履歴コンポーネント

@blocklet/payment-reactライブラリは、ユーザーが過去のアクティビティを明確かつ詳細に確認できるように設計された一連の履歴コンポーネントを提供します。これらのコンポーネントは、ユーザーが請求、支払い、クレジットの使用状況を追跡する必要がある顧客ポータル、アカウントダッシュボード、

CreditGrantsList

CreditGrantsListコンポーネントは、顧客のクレジット付与を表示するページ分割されたテーブルを描画します。各付与のステータス、残高、範囲、および有効期間の明確な概要を提供します。

CreditTransactionsList

CreditTransactionsListコンポーネントは、すべてのクレジット取引の詳細なページ分割テーブルを描画し、クレジットの使用状況と調整の明確なログを提供します。顧客ポータルや管理ダッシュボードで、クレジットの付与と消費を追跡するのに最適です。

CustomerInvoiceList

CustomerInvoiceList コンポーネントは、顧客の請求履歴をレンダリングするために設計されています。支払いサービスから請求書データを取得して表示し、2つの異なるレイアウトを提供します：無限スクロールを備えた日付でグループ化されたシンプルなリストと、詳細なページ分割テーブルです。このコン

CustomerPaymentList

CustomerPaymentListコンポーネントは、顧客の支払い履歴の詳細をレンダリングします。データの取得、無限スクロールによるページネーション、日付ごとの支払いのグループ化を自動的に処理し、ユーザーの取引履歴を明確かつ整理されたビューで提供します。

UIコンポーネント

@blocklet/payment-react ライブラリは、支払いおよびチェックアウトインターフェースを構築する際に最大限の柔軟性を提供するために設計された、一連のきめ細かいUIコンポーネントを提供します。フロー全体をカプセル化する高レベルのチェックアウトコンポーネントとは異なり、これらのコンポー

フォーム要素

@blocklet/payment-react ライブラリは、カスタムの支払いフォームと連絡先情報フォームの作成を簡素化するために設計された、粒度の細かい入力コンポーネントのコレクションを提供します。これらの要素は、検証とユーザーエクスペリエンスを念頭に置いて構築されており、react-hook-f

AddressForm

AddressFormコンポーネントは、請求先住所情報を収集するための構築済みUIを提供します。react-hook-formとシームレスに統合されており、郵便番号などのフィールドに対して国別の組み込みバリデーションが含まれています。

CountrySelect

CountrySelectコンポーネントは、国を選択するための使いやすいドロップダウンを提供します。検索可能なリスト、国旗の表示、デスクトップとモバイルの両方のビューポートに適応するレスポンシブデザインが特徴です。react-hook-formで管理されるフォーム内での使用を想定して設計されています

CurrencySelector

CurrencySelectorコンポーネントは、利用可能なオプションのリストから支払い通貨を選択するための、使いやすいインターフェースを提供します。各通貨をロゴ、シンボル、関連する支払い方法とともに表示し、ユーザーが簡単に選択できるようにします。このコンポーネントは通常、より大きな支払いフォームや

PhoneInput

PhoneInputコンポーネントは、ユーザーフレンドリーな国際電話番号入力フィールドを提供します。react-hook-formとシームレスに統合され、国旗と国番号付きの検索可能な国選択機能、自動番号フォーマット、およびgoogle-libphonenumberによる強力な検証機能を備えています。

PaymentSummary

PaymentSummaryコンポーネントは、あらゆるチェックアウトプロセスにとって重要なUI要素です。すべての品目、トライアル期間情報、ステーキング要件、および最終的な合計金額を含む、注文の詳細な内訳を提供します。レスポンシブデザインになっており、モバイルデバイス向けにレイアウトを調整します。

PricingTable

PricingTable コンポーネントは、サブスクリプションプランと価格オプションを構造化されたレスポンシブなテーブルに表示するために設計された、柔軟な UI 要素です。ユーザーは請求サイクル（例：月次、年次）の切り替え、希望通貨の選択、そしてプランの選択を行って次に進むことができます。

はじめに

このガイドでは、@blocklet/payment-reactをインストールし、基本的で機能的な支払いフォームをアプリケーションに統合するための重要な手順を説明します。わずか数分で、動作するチェックアウト体験を構築できます。

ガイド

ガイドセクションへようこそ。ここでは、個々のコンポーネントの使用法を超えた高度なトピックに関する詳細な記事をご紹介します。これらのガイドは、ライブラリの外観をカスタマイズし、強力なユーティリティ関数を活用して、より高度な決済ソリューションを構築するために設計されています。

テーマ設定

組み込みのテーマプロバイダーとMaterial-UIのテーマオプションを使用して、支払いコンポーネントの外観をカスタマイズする方法を学びます。@blocklet/payment-reactライブラリはMaterial-UIを基盤に構築されており、支払いフローのルックアンドフィールを広範囲にわたって制

ユーティリティ

@blocklet/payment-react ライブラリは、APIリクエストの作成、キャッシュの管理、日付の処理、価格のフォーマット、国際化の設定といった一般的なタスクを簡素化するために設計された一連のユーティリティ関数とクラスをエクスポートします。これらのツールは、ライブラリのコンポーネントやプ

フック

@blocklet/payment-react ライブラリは、リアルタイムイベントの処理やさまざまな画面サイズへの適応など、一般的なロジックをカプセル化して簡素化するための一連のカスタムReactフックを提供します。これらのフックを使用すると、最小限の定型コードで高度な機能をコンポーネントに簡単に統

useMobile

useMobile フックは、アプリケーションがモバイルサイズのデバイスで表示されているかどうかを検出するための便利なユーティリティです。Material-UIのブレークポイントシステムを活用することで、Reactロジック内で直接レスポンシブなレイアウトやコンポーネントを作成するのに役立ちます。

useSubscription

useSubscription フックは、WebSocket を使用して決済サービスからのリアルタイムイベントを購読する簡単な方法を提供します。接続、サブスクリプション、クリーンアップロジックを処理するため、開発者は invoice.paid のようなイベントに対するアプリケーションの反応に集中でき

概要

@blocklet/payment-react は、支払いフロー、サブスクリプション、および寄付システムの blocklet への統合を効率化するために設計された、包括的な React コンポーネントライブラリです。Payment Kit を基盤として構築されており、事前に構築済みでカスタマイズ可能

プロバイダー

Context Provider は @blocklet/payment-react の中心的な概念です。これらはアプリケーションの一部をラップする役割を果たし、React の Context API を使用して、ネストされたすべてのコンポーネントに重要なデータと機能を渡します。これにより、コンポー

DonateProvider

DonateProviderは、アプリケーション内のすべての寄付関連コンポーネントの状態と設定を管理する、極めて重要なコンテキストプロバイダーです。バックエンドから設定を取得し、パフォーマンス向上のためにキャッシュし、CheckoutDonateなどのコンポーネントに提供する役割を担います。

PaymentProvider

PaymentProviderは、@blocklet/payment-reactライブラリの基盤です。これはコンテキストプロバイダーとして機能し、アプリケーションまたは関連する支払いコンポーネントをラップする必要があります。重要な設定の取得、アプリケーションの状態管理、ヘルパー関数とAPIクライアン

Payment Kit SDK（Node.js）

@blocklet/payment-js は Payment Kit の API を呼び出すための SDK です。

APIリファレンス

APIリファレンスは、PaymentKit Node.js SDKで利用可能なすべてのリソースとメソッドに関する詳細なドキュメントを提供します。各リソースには、そのメソッド、パラメータ、戻り値、および使用例に関する包括的な情報が記載された専用ページがあります。

チェックアウトセッション

チェックアウトセッションは、顧客が支払いを行う際のセッションを表します。これは、一回限りの支払いやサブスクリプションを作成するための支払い情報を収集する主要な仕組みです。セッションを作成すると、顧客は安全なホスト型支払いページにリダイレクトされます。支払いが完了すると、顧客はあなたのアプリケーション

クーポン

クーポンは、製品やサービスに割引を提供するための強力なツールです。クーポンオブジェクトには、割引率や固定割引額など、特定の割引に関する情報が含まれています。クーポンを利用可能にするには、1つ以上のプロモーションコードに関連付ける必要があります。このAPIを使用すると、クーポンの作成、管理、および使用

クレジット付与

クレジット付与オブジェクトは、顧客にクレジットを発行するために使用されます。これらのクレジットは、特に使用量ベースまたはクレジットベースの請求モデルにおいて、将来の請求書に適用できます。各付与は、総額、残高、ステータス、および特定の適用可能性ルールを追跡します。

クレジットトランザクション

クレジットトランザクションオブジェクトは、顧客のクレジット残高のすべての変更を記録します。これには、付与、消費、調整、失効が含まれます。このAPIを使用して、顧客のクレジット活動の詳細な履歴を取得できます。

顧客

顧客オブジェクトを使用すると、ビジネスがサービスを提供する顧客を作成および管理できます。連絡先の詳細、住所、請求履歴などの重要な情報を保存し、これらはサブスクリプションの作成や支払いの処理に不可欠です。

インボイス

インボイス API を使用すると、インボイスの作成、管理、確定ができます。この API は、1 回限りの支払い、定期的なサブスクリプション、クレジットベースの請求など、さまざまな請求シナリオを処理するための包括的な機能を提供します。詳細なインボイス情報の取得、割引の適用、ステーキング操作の管理、履歴

メーターイベント

メーターイベントは、特定のMeterに報告する使用状況の記録です。各イベントは、顧客によって実行された定量化可能なアクションを表し、使用量ベースまたはクレジット請求モデルで残高からクレジットを差し引くために使用できます。イベントを報告する前に、まずメーターを作成する必要があります。

メーター

メーターは、クレジットベースの請求のための使用量を定義し、追跡するために使用されます。APIコール、データストレージ、計算時間など、課金対象となる特定の機能やリソースを表します。各メーターは、送信された使用量イベントを集計します。

支払通貨

支払通貨APIを使用すると、支払いに使用できる通貨を管理できます。これには、標準的なブロックチェーンベースのトークン（ERC-20やArcBlockネイティブトークンなど）や、クレジットベースの請求システムを実装するために使用されるカスタムクレジット通貨が含まれます。

Payment Intent

Payment Intentは、顧客から支払いを受け取る意図を表し、支払いプロセスのライフサイクルを追跡するオブジェクトです。これはPaymentKit APIの中心的なオブジェクトであり、顧客からあなたへの資金の流れを制御します。Payment Intentは、ユーザー向けの支払いフローのためにC

支払いリンク

支払いリンクは、製品やサービスを販売するための共有可能で再利用可能なページです。特定の製品と価格のセットに対してリンクを作成し、さまざまなチャネルを通じて複数の顧客と共有できます。これにより、完全なチェックアウトフローを構築することなく、迅速かつ簡単に支払いを回収できます。

支払い方法

支払い方法オブジェクトは、Stripe（クレジットカード、銀行口座）や様々な暗号通貨ネットワークを通じて顧客が支払うことができるさまざまな方法を表します。このAPIを使用すると、顧客が利用できる支払い方法を設定、管理、一覧表示できます。

価格

Price オブジェクトは、特定の製品に対していくら、どのくらいの頻度で課金するかを定義します。これは、価格の金額と通貨を製品に関連付けます。例えば、1つの製品に複数の価格を設定でき、それぞれ異なる通貨や請求間隔を持つことができます。

製品

製品オブジェクトは、顧客に提供する商品、サービス、またはデジタルクレジットを表します。これらはカタログ内のアイテムと考えることができます。各製品には1つ以上の価格を関連付けることができます。

プロモーションコード

プロモーションコードは、顧客がチェックアウト時に割引を受けるために入力する、ユーザー向けの特定のコードです。各プロモーションコードは親のクーポンにリンクされており、これが実際の割引（例：20%オフ、$10オフ）を定義します。この2層構造により、同じ基礎となる割引を指す複数のユニークなコードを作成でき

返金

返金オブジェクトは、以前の請求に対する顧客への資金の返還を表します。新しい返金を作成したり、既存の返金の詳細を取得したり、会計目的ですべての返金をリストしたりできます。返金が作成されると、最初は「保留中」の状態になり、非同期で処理されます。

設定

Settings APIを使用すると、PaymentKit内のさまざまな設定を管理できます。例えば、寄付ウィジェットの作成や通知ハンドラーの設定などです。各設定は、そのtypeとmountLocationによって識別される設定可能なリソースです。

サブスクリプションアイテム

サブスクリプションアイテムは、顧客がサブスクライブしている特定の製品と価格を表します。これらはサブスクリプションのコンポーネントであり、特に従量制の使用量を持つプランの継続請求を管理するために不可欠です。

サブスクリプション

サブスクリプションは、顧客の定期支払いプランを管理するために使用されます。サブスクリプション API を使用すると、これらの定期的な請求契約の作成、取得、更新、キャンセル、およびライフサイクルの管理ができます。

Webhook エンドポイント

Webhook エンドポイントを使用すると、PaymentKit はサーバーに非同期のイベント通知を送信できます。これは、支払いの成功、サブスクリプションの更新、請求の失敗などのイベントを処理するために不可欠です。Webhook エンドポイントを作成および管理することで、アプリケーションが支払いと顧

コアコンセプト

PaymentKit Node.js SDKは、さまざまな請求シナリオを処理するように設計されています。このセクションでは、最も一般的な支払いワークフローを実装するための実践的なガイドを提供します。簡単な一回限りの請求の設定、定期的なサブスクリプションの管理、または高度なクレジットベースのシステムの

クレジットベースの請求

クレジットベースの請求は、APIコール、データストレージ、計算時間など、使用量が変動するサービスに最適な、柔軟な従量課金モデルです。顧客は、固定の定期料金の代わりに、購入または付与されたクレジットを消費します。

クレジットチャージ

PaymentKitのクレジットベースの課金システムでは、顧客はチャージによってクレジット残高を補充できます。クレジット通貨をチャージ可能に設定することで、手動による1回限りのチャージと、残高が設定したしきい値を下回った場合の自動リチャージの両方が可能になります。

割引

PaymentKitは、クーポンとプロモーションコードを使用した柔軟な割引システムを提供します。これにより、パーセンテージ割引、定額割引、期間限定オファーなど、さまざまな種類の割引を顧客に提供できます。

1回限りの支払い

PaymentKitは、商品やサービスに対する1回限りの請求を処理するための、いくつかの柔軟な方法を提供しています。このガイドでは、Node.js SDKで利用可能な3つの主要な方法を説明し、特定のニーズに最適なアプローチを選択するお手伝いをします。

サブスクリプション

サブスクリプションは定期的な収益の基盤であり、顧客に製品やサービスを繰り返しスケジュールで請求することができます。PaymentKitでは、顧客が定期的な価格の製品を購入するとサブスクリプションが作成されます。

Webhook

Webhookは、PaymentKitとの信頼性が高くスケーラブルな統合を構築するための重要なメカニズムです。ステータスの変更をAPIに常にポーリングする代わりに、Webhookエンドポイントを設定できます。そうすると、アカウントで特定のイベントが発生するたびに、PaymentKitが指定したURL

環境

PaymentKit SDKは、実際の取引を処理するためのLive Modeと、開発およびテスト用のTest Modeという2つの異なるモードで動作します。すべてのAPIリクエストは、これらの環境のいずれかで実行されます。デフォルトでは、SDKはLive Modeで初期化されます。開発中はTest

はじめに

このガイドでは、PaymentKit Node.js SDKをプロジェクトに導入し、実行するための基本的な手順を説明します。わずか数分でSDKをインストールし、テスト環境向けに設定を行い、最初のAPI呼び出しを実行できます。

概要

PaymentKit Node.js SDKは、PaymentKit REST APIの便利なラッパーを提供し、Node.jsアプリケーション内で直接、強力で柔軟な決済体験を構築できます。一回限りの購入の処理、定期的なサブスクリプションの管理、または洗練されたクレジットベースの請求モデルの実装など、

SDKの構造

PaymentKit Node.js SDKは、モジュール式のリソース指向アーキテクチャに基づいて構築されています。この設計により、PaymentKit APIのさまざまな部分とのやり取りが、一貫性があり、予測可能で、堅牢であることが保証されます。その中核として、SDKは中央ユーティリティを使用して

Web Device

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.

Bookmark and note (save capability)

Declare page bookmark and selection notes on blocklet.yaml save:. Default on, hidden until login, floating chrome or page buttons.

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

Web3 アプリケーションを構築するための既製モジュール群。

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 ホワイトペーパー V1

ArcBlock 技術ホワイトペーパー：プラットフォームのアーキテクチャと主要コンポーネント。

ArcBlock Technical White Paper

Version 1.0 (2017.12)