Quick Start
Introduction

3min
Our SDK and documentation are still under development, we are working hard to have everything as good as possible. Any feedback is very helpful, you can contact us on Discord﻿
Learn how to develop your mini-app with TypeScript 
Prerequisites
To follow this guide you will need to have installed
Code editor as VSCode﻿
﻿NodeJS 
Install the SDK
The SDK is published, but it may cause some errors when validating your metadata. Although the main structure will be the same. We are implementing abitype for a more exhaustive validation.
1
Install
Install the Sherry SDK using your preferred packe manager
npm
yarn
npm install @sherrylinks/sdk
npm install @sherrylinks/sdk
﻿
2
Import
Import the Metadata interface from the SDK
TypeScript
import { Metadata } from "@sherrylinks/sdk"
import { Metadata } from "@sherrylinks/sdk"
﻿
3
Utilize
Use the Metadata interface to start defining your miniapp
metadata.ts
example-abi.ts
const metadata: Metadata = {
  type: "action",
  icon: "icon",
  title: "title",
  description: "description",
  actions: [
      {
          label: "Test Action 1",
          contractAddress: "0x1234567890abcdef1234567890abcdef12345678",
          contractABI: exampleAbi,
          functionName: "safeTransferFrom",
          chainId: "fuji"
      },
    ]
  };
const metadata: Metadata = {
  type: "action",
  icon: "icon",
  title: "title",
  description: "description",
  actions: [
      {
          label: "Test Action 1",
          contractAddress: "0x1234567890abcdef1234567890abcdef12345678",
          contractABI: exampleAbi,
          functionName: "safeTransferFrom",
          chainId: "fuji"
      },
    ]
  };
﻿
4
Finally
Finally your file will look as follows
metadata.ts
example-abi.ts
import { Metadata } from "@sherrylinks/sdk"
import { exampleAbi } from "./example-abi.ts"
  
const metadata: Metadata = {
  type: "action",
  icon: "icon",
  title: "title",
  description: "description",
  actions: [
      {
          label: "Test Action 1",
          contractAddress: "0x1234567890abcdef1234567890abcdef12345678",
          contractABI: exampleAbi,
          functionName: "safeTransferFrom",
          chainId: "fuji"
      },
    ]
  };
import { Metadata } from "@sherrylinks/sdk"
import { exampleAbi } from "./example-abi.ts"
  
const metadata: Metadata = {
  type: "action",
  icon: "icon",
  title: "title",
  description: "description",
  actions: [
      {
          label: "Test Action 1",
          contractAddress: "0x1234567890abcdef1234567890abcdef12345678",
          contractABI: exampleAbi,
          functionName: "safeTransferFrom",
          chainId: "fuji"
      },
    ]
  };
﻿
5
Validate
Validate your Metadata using the createMetadata function. This function will check the definition and return the validated metadata of your mini-app. The type returned will be ValidatedMetadata
TypeScript
import { createMetadata, ValidatedMetadata } from "@sherrylinks/sdk"

const finalMetadata: ValidatedMetadata = await createMetadata(metadata);
import { createMetadata, ValidatedMetadata } from "@sherrylinks/sdk"

const finalMetadata: ValidatedMetadata = await createMetadata(metadata);
﻿
6
Result
Once your metadata is validated, this is the metadata that will be returned by your application, and will be consumed by Sherry.
TypeScript
Metadata: {
  "type": "action",
  "icon": "icon",
  "title": "title",
  "description": "description",
  "actions": [
    {
      "label": "Test Action 1",
      "contractAddress": "0x1234567890abcdef1234567890abcdef12345678",
      "contractABI": [ ... ],
      "functionName": "safeTransferFrom",
      "functionParamsLabel": [
        "From"
      ],
      "chainId": "fuji",
      "transactionParameters": [
        {
          "name": "From",
          "type": "address"
        },
        {
          "name": "to",
          "type": "address"
        },
        {
          "name": "tokenId",
          "type": "uint256"
        }
      ],
      "blockchainActionType": "nonpayable"
    }
  ]
}
Metadata: {
  "type": "action",
  "icon": "icon",
  "title": "title",
  "description": "description",
  "actions": [
    {
      "label": "Test Action 1",
      "contractAddress": "0x1234567890abcdef1234567890abcdef12345678",
      "contractABI": [ ... ],
      "functionName": "safeTransferFrom",
      "functionParamsLabel": [
        "From"
      ],
      "chainId": "fuji",
      "transactionParameters": [
        {
          "name": "From",
          "type": "address"
        },
        {
          "name": "to",
          "type": "address"
        },
        {
          "name": "tokenId",
          "type": "uint256"
        }
      ],
      "blockchainActionType": "nonpayable"
    }
  ]
}
﻿
7
Deploy your Sherry Link
Publish your application according to your preferences. The metadata must be exposed through an endpoint that must be accessed through a GET request so that the client applications can render the mini-app. More details in Guides﻿ .
﻿
﻿
﻿
Updated 28 Nov 2024
Did this page help you?
Introduction
Metadata