Quickstart

Get started with Kai-Sign in 15 minutes by creating your first ERC7730 metadata for clear signing.

Overview

Kai-Sign enables developers to create human-readable transaction descriptions for smart contracts. The process involves three main steps:

1. Build Metadata - Create ERC7730 specifications using our visual builder

2. Verify Metadata - Submit to Reality.eth for community verification

3. Deploy & Use - Integrate verified metadata

Prerequisites

• Basic understanding of smart contracts and ABIs

• Contract address or ABI for the contract you want to support

• Ethereum testnet ETH (for verification submission)

Step 1: Build Your Metadata

Access the Builder

1. Navigate to the Kai-Sign Builder at beta.kaisign.xyz

2. Choose your starting point:

   • New Metadata: Start from a contract address or ABI

   • Existing File: Upload a previously created ERC7730 file

Create Metadata

1. Select Network: Choose the blockchain (Ethereum Mainnet, Sepolia, etc.)

2. Input Contract Details:

   • Paste your contract address (e.g., 0x1234567890123456789012345678901234567890)

   • Or upload the complete ABI JSON file

   • Click Submit to analyze the contract

3. Choose Operations: Select which functions you want to support for clear signing

   • Click on functions in the left panel to add them

4. Define Display Fields: For each operation, configure:

   • Intent: Human-readable operation name (e.g., "Transfer Tokens")

   • Fields: Map function parameters to display labels

   • Formatting: Choose appropriate formats (address, token amount, etc.)

Example: ERC20 Transfer

{
  "intent": "Transfer Tokens",
  "fields": [
    {
      "path": "#.to",
      "label": "Recipient",
      "format": "addressName"
    },
    {
      "path": "#.value", 
      "label": "Amount",
      "format": "tokenAmount"
    }
  ]
}

Preview & Test

1. Click Review to see how your metadata looks on a hardware wallet

2. Use the simulated Ledger device to navigate through transaction screens

3. Verify all information displays correctly and makes sense to users

Step 2: Verify Your Metadata

Download Metadata

1. Click Download to save your ERC7730 JSON file

2. Review the file to ensure accuracy

3. Note the metadata hash for tracking

Submit for Verification

1. Visit the verification interface: Link to verification page

2. Upload your metadata file

3. Submit to Reality.eth oracle:

   • Pay the required bond (typically 0.01 ETH)

   • Set challenge period (recommended: 7 days)

   • Add supporting documentation if needed

Track Verification

Monitor your submission status:

• Pending: Awaiting community review

• Challenged: Dispute in progress, may go to Kleros

• Verified: Accepted by the community

• Rejected: Failed verification

Step 3: Integration & Usage

Access Verified Metadata

Once verified, your metadata becomes available:

• Blob Hash: Transient storage address

• Registry Entry: Listed in the Kai-Sign registry

• Hardware Support: Automatically available to supported wallets

Test Integration

1. Hardware Wallet: Test with a real Ledger device

2. DApp Integration: Use the metadata in your application

3. User Testing: Verify the clear signing experience

Share & Deploy

• Add metadata references to your documentation

• Update your DApp to reference the verified metadata

• Inform users about the improved transaction experience