Guides
Validating Metadata

6min
How and Why
Validating metadata is a critical step in defining your mini-app effectively. To assist with this process, we have developed various functions that enable you to validate either specific parts or the entirety of the metadata in a modular manner. To ensure clarity and provide actionable feedback, we have categorized the possible validation errors into distinct types. These error types can be integrated into your code as needed to deliver detailed and meaningful insights during the validation process.
Handling Errors
Error Classes are available for instanceof operations that you can use during your validation and/or testing process. As a developer, you have complete freedom to define the metadata as you see fit; however, this metadata will be validated before each rendering-publishing. To ensure the proper functioning of the mini-app you have defined, we have made these classes available, allowing you to get the highest level of detail in case any errors occur during the metadata definition or validation process.
Example
TypeScript
metadata.ts
example-abi.ts
import exampleAbi from "./exmaple-abi.ts"
import { Metadata } from "@sherrylinks/sdk"

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 exampleAbi from "./exmaple-abi.ts"
import { Metadata } from "@sherrylinks/sdk"

const metadata: Metadata = {
  type: "action",
  icon: "icon",
  title: "title",
  description: "description",
  actions: [
      {
          label: "Test Action 1",
          contractAddress: "0x1234567890abcdef1234567890abcdef12345678",
          contractABI: exampleAbi,
          functionName: "safeTransferFrom",
          chainId: "fuji"
      },
    ]
  };
﻿
FunctionNotFoundError
FunctionNotFoundError is thrown when 
TypeScript
import { FunctionNotFoundError } from "@sherrylinks/sdk"

try {
  // Your code ...
} catch(err) {
  if(err instanceof FunctionNotFoundError){
    // do something ...
  }
}
import { FunctionNotFoundError } from "@sherrylinks/sdk"

try {
  // Your code ...
} catch(err) {
  if(err instanceof FunctionNotFoundError){
    // do something ...
  }
}
﻿
NoActionDefinedError
NoActionDefinedError is thrown when there is no declaration of a Blockchain Action in the metadata.
TypeScript
import { NoActionDefinedError } from "@sherrylinks/sdk"
import { NoActionDefinedError } from "@sherrylinks/sdk"
﻿
InvalidAddress
InvalidAddress is thrown when the address of the contract to be executed in the Blockchain Action is invalid.
TypeScript
import { InvalidAddress } from "@sherrylinks/sdk"
import { InvalidAddress } from "@sherrylinks/sdk"
﻿
ActionsNumberError
ActionsNumberErros is thrown when the number of Blockchain Actions to be executed is greater than four (4).
TypeScript
import { ActionsNumberError } from "@sherrylinks/sdk"
import { ActionsNumberError } from "@sherrylinks/sdk"
﻿
﻿
Updated 24 Nov 2024
Did this page help you?
Cloudflare Workers
Verification