Documentation

Learn how to use the Blinch protocol for interactive Bitcoin Cash actions.

Quick Start

Blinch enables interactive Bitcoin Cash actions through covenant-based smart contracts. Every transaction includes a mandatory OP_RETURN output with the protocol identifier.

Protocol Identifier (OP_RETURN):

464c4f5701 (FLOW\x01)

Try an Action

Visit the example action to see Blinch in action.

Architecture

🔒

Smart Contracts

CashScript covenants enforce protocol compliance with native introspection

⚡

Backend API

Express server serving BCH-Action JSON Schema for action metadata

🎨

Frontend

Next.js 16 app with beautiful glassmorphic UI

BCH-Action JSON Schema

Actions are represented using the BCH-Action JSON Schema v1.1.0:

{
  "version": "1.1.0",
  "type": "action",
  "icon": "/icon-lg.png",
  "title": "Interactive Blinch Action",
  "description": "Metadata for a Bitcoin Cash interactive link.",
  "links": {
    "actions": [{
      "label": "Execute",
      "href": "bitcoincash:addr?amount=0.01&op_return=464c4f5701[action_type]",
      "parameters": [
        { "name": "note", "label": "Public Note", "type": "text" }
      ]
    }]
  },
  "metadata": {
    "protocol": "Blinch",
    "identifier": "FLOW\\x01",
    "hex_prefix": "464c4f5701"
  }
}

Creating Actions

Blinch makes it easy to create interactive Bitcoin Cash actions. You can create actions through the web interface or programmatically via the API.

Method 1: Web Interface (Recommended)

Step 1: Navigate to Create

Click the "Create Your Blinch" button on the home page, or visit /create directly.

Step 2: Basic Information

Enter a title and description for your action. Choose an icon from the presets. The title should be short and descriptive (max 100 characters).

Step 3: Fund Details

Enter the Bitcoin Cash address that will receive payments. Choose a default amount or enter a custom value. This is where funds will be sent when users execute your action.

Step 4: Customize (Optional)

Add an action type identifier or custom parameters for user input. You can also add your BCH address as a creator to enable future edits/deletions.

Step 5: Generate & Share

Review your action and click "Create Action". You'll get a unique URL that you can share with others. The action will include the Blinch protocol identifier in all transactions.

Tip: Every transaction includes 464c4f5701in the OP_RETURN to ensure protocol compliance.

Method 2: API

Create actions programmatically using the REST API:

curl -X POST http://localhost:3001/api/action \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Coffee Tip Jar",
    "description": "Tips for my coffee content!",
    "recipientAddress": "bitcoincash:qrqglczyxh4yvdnkkenk3k9ltq3e2j2dnqjvulv4rk",
    "amount": "0.01",
    "creatorAddress": "bitcoincash:qrqglczyxh4yvdnkkenk3k9ltq3e2j2dnqjvulv4rk"
  }'

Response:

{
  "id": "a1B2c3D4e5",
  "version": "1.1.0",
  "type": "action",
  "title": "Coffee Tip Jar",
  ...
}

Managing Actions

Visit the Dashboard to manage your created actions.

Dashboard Features

✓
View All Actions
See all actions you've created with their details
✓
Search & Filter
Quickly find actions by title or description
✓
Share Actions
Copy action links with one click
✓
Delete Actions
Remove actions you no longer need (requires creator address)
✓
View Stats
See overview of your actions (total, with parameters, custom types)

Sharing & Embedding Actions

Share Your Action

Direct Link

Share the action URL: https://blinch.network/action/[id]

QR Code

Generate a QR code for mobile wallet scanning. Users can scan and execute the action directly.

Embed on Website

Use an iframe to embed the action on your website:

<iframe
  src="https://blinch.network/action/[id]"
  width="400"
  height="300"
  frameborder="0">
</iframe>

Bitcoin Cash URI

Direct wallet integration using BCH URIs:

bitcoincash:address?amount=0.01&op_return=464c4f5701[action_type]

Frequently Asked Questions

What is the creator address?

The creator address is your BCH address that proves ownership of an action. It allows you to edit or delete the action later. Without it, anyone can delete the action and you won't be able to make changes.

What are custom parameters?

Custom parameters allow users to input additional data when executing your action. For example, you could ask for a note, a message, or any other text input. Parameters can be text, number, boolean, or date fields.

How do I test my action?

After creating an action, click "View Action" to see how it looks. You can test the Bitcoin Cash URI with any BCH wallet that supports URI protocols. On Chipnet testnet, you can use testnet funds to test without real money.

Can I edit an action after creating it?

Currently, editing is not fully supported. However, if you set a creator address, you can delete and recreate the action with changes. Full edit functionality is planned for a future release.

Where are actions stored?

Actions are stored both in the backend server (file-based persistence) and in your browser's localStorage. This ensures your actions are available even if the server restarts, and provides fast access to your dashboard.

What happens to the funds?

When a user executes your action, funds are sent directly to the recipient address you specified. Blinch doesn't hold or intermediate funds - it's a direct peer-to-peer transaction secured by the Bitcoin Cash blockchain.

Blinch