Publishing

This section covers the configuration fields in blocklet.yml that are used by a Blocklet Store for listing, distributing, and monetizing your Blocklet. While you can set some of these fields, many are automatically generated and populated by the blocklet publish command to ensure integrity and provide store-related metadata.

Media#

To make your Blocklet's store page more appealing and informative, you can add screenshots and promotional videos.

Key	Type	Description
screenshots	string[]	An array of URLs pointing to screenshots of your Blocklet.
videos	string[]	An array of up to 3 URLs for promotional videos. Must be valid YouTube or Vimeo links.

Example:

Monetization#

You can monetize your Blocklet by setting a purchase price and defining how the revenue is shared. When a user purchases your Blocklet, an NFT representing the license is minted and transferred to them.

Key	Type	Description
nftFactory	string	The DID of the asset factory used to mint the purchase NFT. This is usually created and maintained by the blocklet publish command.
payment	object	An object containing pricing and revenue sharing rules.

The payment Object#

The payment object contains the following fields:

Key	Type	Description
price	object[]	An array that defines the price. Currently, only one price entry is supported. Each object contains value (number) and address (the DID of the token to be used for payment).
share	object[]	An array of up to 4 beneficiaries who will share the revenue. The total of all value fields in the array must equal 1. Each object contains name (string), address (beneficiary's DID), and value (a number between 0 and 1 representing the share).
componentPrice	object[]	Defines pricing for components, which can be fixed or a percentage based on the parent Blocklet's price range.

Example:

This example sets a price of 99.99 of a specific token and splits the revenue 80/20 between the developer and the marketplace.

Distribution and Provenance#

The following fields are crucial for package integrity and store statistics. They are automatically added or updated during the publishing process. You should not set them manually in your blocklet.yml source file.

Key	Type	Description
dist	object	Contains information about the distributable tarball, including its tarball URL, integrity hash, and size.
stats	object	Contains store statistics like downloads, star count, and purchases.
signatures	object[]	An array of cryptographic signatures from the publisher and the Blocklet Store to prove authenticity and integrity.
lastPublishedAt	string	An ISO date string indicating when the version was last published.
logoUrl	string	A CDN-hosted or optimized URL for the Blocklet's logo, managed by the store.

Example (For Reference Only)

The following snippet illustrates how these fields might appear in a metadata file after it has been published. It is shown here for informational purposes only.

You have now reviewed all the major configuration areas of blocklet.yml. With a complete configuration, you are ready to bundle and publish your Blocklet. For a complete picture, you may want to revisit the Overview.