Used to check for browser translation.
用于检测浏览器翻译。
ブラウザの翻訳を検出する

Blocklet Specification (blocklet.yml)

The blocklet.yml file is the central manifest for any Blocklet. It is a YAML file that declares essential metadata, configuration, dependencies, and capabilities required to run the Blocklet. This file serves as the single source of truth for both the ABT Node and other tools in the Blocklet ecosystem.

This specification provides a comprehensive, field-by-field reference for blocklet.yml, acting as the formal guide for developers. All fields are validated against a set of rigorous schemas, ensuring consistency and reliability across the platform.

Structure Overview#

The blocklet.yml file is organized into several logical groups of properties. The diagram below illustrates the high-level structure and the key top-level fields you will be working with.


Specification Details#

This documentation is divided into sections, each focusing on a specific aspect of the blocklet.yml file. Explore the following pages for detailed information on each field, including data types, validation rules, and usage examples.

Core Metadata

Details the fundamental properties of a blocklet, such as its name, unique identifier (DID), version, title, description, and group.

People & Ownership

Explains how to specify the author, contributors, and maintainers of the blocklet using the person schema.

Distribution & Links

Covers fields related to the blocklet's distribution package (`dist`), source code repository, and associated web links like homepage and documentation.

Execution & Environment

Describes how to configure the blocklet's execution environment, including the engine, runtime requirements, environment variables, startup scripts, and timeouts.

Interfaces & Services

Details the `interfaces` property for exposing web pages, services, and other endpoints. Also covers the configuration of built-in services like authentication.

Composition (Components)

Explains how to compose a blocklet from other blocklets using the `components` property, enabling complex, modular applications.

UI & Theming

Covers the `navigation` and `theme` properties for defining a blocklet's contribution to the user interface and overall look and feel.

Monetization

Details the `payment` and `nftFactory` fields, explaining how to configure pricing, revenue sharing, and NFT-based purchases for a blocklet.

Security & Resources

Explains the `signatures` field for ensuring metadata integrity and the `resource` field for defining and bundling shared assets.


A correctly configured blocklet.yml is crucial for your blocklet to function properly within the ArcBlock ecosystem. To get started, we recommend reading the Core Metadata section first. If you plan to interact with metadata programmatically, proceed to the API Reference.

previous
Getting Started
next
Core Metadata