WoC Plugins
It is our goal to make it easier for anyone to provide metadata or showcase the on-chain data. We believe that by empowering the community, we will continue to unlock another aspect of the boundless potential of the Bitcoin blockchain.
To facilitate this, we have provided the ability to create and publish plugins. The plugins feature allows anyone to add more context or provide a different view/UI for transactions, blocks, addresses, OP_RETURN data, or user's searched terms.
To create a new plugin or see the existing plugins, navigate to the WhatsOnChain.com "Tools" Menu and click on "Manage Plugins"
On the Manage Plugins page, click on the "Lab" tab and fill in the required plugin details.
Below is the list and purpose of different plugin types. And here you can find a GitHub repo of example plugins.
Data: You can create this Plugin type to decode and display the OP_RETURN output. The response provided by the plugin's webhook will be rendered when a user tries to decode the OP_RETURN data on the transactions page.
Block: This type of plugin can be used to share any metadata/stats for a given block. Appears as a new tab on the block page with the data provided by the plugin's webhook.
Address: This type of plugin can be used to share any metadata/stats for a given address. Appears as a new tab on the address page with the data provided by the plugin's webhook.
Transaction: This type of plugin can be used to share any metadata/stats for a given transaction. Appears as a new tab on the transaction page with the data provided by the plugin's webhook.
Script: This type of plugin can be used to share any metadata/stats for a given scripthash. Appears as a new tab on the scripthash page with the data provided by the plugin's webhook.
Search engine: If you are interested in sharing data from your specialized indexer, use this plugin type to help users search your indexed data when they search anything on whatsonchain.com via the search bar.
Don't forget to press "Save" after providing the required plugin details.
To Edit, Delete or Publish a plugin, click on the menu option next to the plugin name.
When a new plugin is created or is in the development phase, it is listed in the "Lab" tab. Plugins listed in the "Lab" are not available publicly and the plugin data is saved locally in the browser's local storage.
All the published plugins are listed under the "Plugins" section.
If you have any questions, please free free to ask via the WoC devs telegram channel.
Last updated
