@ton-community/contract-verifier-sdk v1.3.1

TON Contract Verifier SDK

TL;DR

TON verifier data fetcher and code viewer with FunC code highlighting

Related repositories

This repo is a part of the following:

1. contract-verifier-contracts - Sources registry contracts which stores an on-chain proof per code cell hash.
2. contract-verifier-backend - Backend for compiling FunC and returning a signature over a message containing the resulting code cell hash.
3. contract-verifier-sdk (this repo) - A UI component to fetch and display sources from TON blockchain and IPFS, including FunC code highlighting.
4. contract-verifier - A UI app to interact with the backend, contracts and publish an on-chain proof.

⭐️ Features

• Queries the Sources Registry for the existence of a Source Item contract
• Fetches contract source code from IPFS via a sources.json url
• Displays a code navigator with code highlighting for FunC, FIFT, based on highlight.js plugin
• Customizable data fetching (IPFS GW, TON API endpoint, verifier id)

📦 Getting Started

Step 1: Prepare DOM

Add this to your HTML structure

<div id="myVerifierContainer">
    <div id="myVerifierFiles">
    </div>
    <div id="myVerifierContent">
    </div>
</div>

Installation

NPM

npm install @ton-community/contract-verifier-sdk

Web CDN

<script src="https://cdn.jsdelivr.net/gh/ton-community/contract-verifier-sdk@1.1.0/dist/index.min.js"></script>

Usage

Node

import { ContractVerifier } from "@ton-community/contract-verifier-sdk";

const ipfsLink = await ContractVerifier.getSourcesJsonUrl(
    "45cE5NYJuT5l2bJ+HfRI0hUhR3LsBI6wER6yralqPyY=",
    {
        testnet: false
    }
  );

const src = await ContractVerifier.getSourcesData(ipfsLink!, {testnet: false});

// use contract data

Browser

<script>
    document.addEventListener("DOMContentLoaded", async function () {
        const codeCellHash = "/rX/aCDi/w2Ug+fg1iyBfYRniftK5YDIeIZtlZ2r1cA=";
        
        const ipfslink = await ContractVerifier.getSourcesJsonUrl(codeCellHash);

        // means there exists a verified source for this contract
        if (ipfslink) {
            // By default, it's best to leave the default IPFS gateway as it has all verified source code pinned and ready
            const sourcesData = await ContractVerifier.getSourcesData(ipfslink);
            const theme = window.matchMedia && window.matchMedia("(prefers-color-scheme: dark)").matches ? "dark" : "light";

            ContractVerifierUI.loadSourcesData(sourcesData, {
                containerSelector: "#myVerifierContainer",
                fileListSelector: "#myVerifierFiles",
                contentSelector: "#myVerifierContent",
                theme
            });
        }
    });
</script>

ℹ️ Interface

ContractVerifier

interface GetSourcesOptions {
  verifier?: string, // Defaults to "orbs.com"
  httpApiEndpointV4?: string, // Defaults to an Orbs L3 TON Gateway
  testnet?: boolean
}

// Returns an `ipfs://` prefixed URL if the given code cell hash has a corresponding source verifier contract 
async ContractVerifier.getSourcesJsonUrl(codeCellHash: string, options?: GetSourcesOptions): Promise<string | null>;


interface SourcesData {
  files: { name: string; content: string }[];
  commandLine: string;
  compiler: string;
  version: string;
  verificationDate: Date;
}
type IpfsUrlConverterFunc (ipfsUrl: string) => string;

// Returns file names and their source code content
async ContractVerifier.getSourcesData(sourcesJsonUrl: string, options?: {
    ipfsConverter?: IpfsUrlConverterFunc;
    testnet?: boolean;
}): Promise<SourcesData>;

ContractVerifierUI

ContractVerifierUI.loadSourcesData(sourcesData: SourcesData, opts: {
    containerSelector: string; // main container
    fileListSelector?: string; // if omitted, the file list will not be populated and the setCode function can be used instead to switch between files
    contentSelector: string; // code container
    theme: Theme; // "light" or "dark"
});

// To be used usually only if the file list is manually built
ContractVerifierUI.setCode(contentSelector: string, content: string);

👀 Demo

1. Clone this repo
2. Run npm install
3. Run npm run build

Web - Minimal

1. Navigate to example/vanilla-minimal
2. Open index.html

Web - Vanilla

1. Navigate to example/vanilla-vite
2. Run npm install
3. Run npm link ../../
4. Run npm run dev

Node.js

1. Navigate to example/node
2. Run npm install
3. Run npm link ../../
4. Run ts-node index.ts

💎 Customization

CSS

The widget will attach the following classnames to its components:

contract-verifier-container
contract-verifier-files
contract-verifier-file
contract-verifier-code

Which can be customized according to your needs.

📔 License

MIT