Using TypeScript

8min
You can use the framework to create web applications of your choice, for example Express.
This section is being reviewed and expanded.
Express.js provides simplicity and complete control over how you configure your server. It's ideal for creating lightweight APIs.
Initial Setup
Create a new Node.js project and install Express:
bash
mkdir mini-app-metadata
cd mini-app-metadata
npm init -y
npm install express cors
mkdir mini-app-metadata
cd mini-app-metadata
npm init -y
npm install express cors
﻿
Install the SDK
npm
yarn
npm install @sherrylinks/sdk
npm install @sherrylinks/sdk
﻿
Create a file named server.js in the root directory.
Creating the Endpoint
Add the following code to server.js
TypeScript
import { Request, Response } from 'express';
import { Metadata, BlockchainActionMetadata, Abi, createMetadata, ValidatedMetadata } from "@sherrylinks/sdk"

export function miniApp(req: Request, res: Response) {
    try {
        const abi: Abi = [
            {
                "inputs": [
                    {
                        "internalType": "string",
                        "name": "_greeting",
                        "type": "string"
                    }
                ],
                "name": "setGreeting",
                "outputs": [],
                "stateMutability": "nonpayable",
                "type": "function"
            }
        ] as const

        const action: BlockchainActionMetadata = {
            label: "Click",
            contractAddress: "0x1234567890123456789012345678901234567890",
            contractABI: abi,
            functionName: "setGreeting",
            chainId: "avalanche",
        }

        const metadata: Metadata = {
            type: "action",
            icon: "https://your-domain.com/api/mini-app-image",
            title: "Hello, World!",
            description: "This is a mini app that greets the world.",
            actions: [action]
        };

        const metadataResponse: ValidatedMetadata = createMetadata(metadata);
        res.status(200).json(metadataResponse);
    } catch (error) {
        res.status(500).json(error);
    }
}
import { Request, Response } from 'express';
import { Metadata, BlockchainActionMetadata, Abi, createMetadata, ValidatedMetadata } from "@sherrylinks/sdk"

export function miniApp(req: Request, res: Response) {
    try {
        const abi: Abi = [
            {
                "inputs": [
                    {
                        "internalType": "string",
                        "name": "_greeting",
                        "type": "string"
                    }
                ],
                "name": "setGreeting",
                "outputs": [],
                "stateMutability": "nonpayable",
                "type": "function"
            }
        ] as const

        const action: BlockchainActionMetadata = {
            label: "Click",
            contractAddress: "0x1234567890123456789012345678901234567890",
            contractABI: abi,
            functionName: "setGreeting",
            chainId: "avalanche",
        }

        const metadata: Metadata = {
            type: "action",
            icon: "https://your-domain.com/api/mini-app-image",
            title: "Hello, World!",
            description: "This is a mini app that greets the world.",
            actions: [action]
        };

        const metadataResponse: ValidatedMetadata = createMetadata(metadata);
        res.status(200).json(metadataResponse);
    } catch (error) {
        res.status(500).json(error);
    }
}
﻿
Start the server
Bash
node server.js
node server.js
﻿
Access the endpoint locally:
 http://localhost:3000/metadata
Deploy to Production
You can deploy your Express app on platforms like:
﻿Railway: Easy-to-use deployment platform.
﻿Render: Offers a balance of simplicity and advanced features.
﻿
Updated 30 Nov 2024
Did this page help you?
Using JavaScript
NextJS