Sherry SDK

Welcome to the Sherry SDK! This SDK allows you to create mini-apps that interact with any function of any smart contract.

Features

• Smart Contract Interaction: Easily interact with any function of any smart contract.
• Mini-App Creation: Build mini-apps quickly and efficiently.
• Flexible and Extensible: Designed to be flexible and easily extensible to meet your needs.

Installation

To install the Sherry SDK, use the following command:

npm install @sherrylinks/sdk

yarn add @sherrylinks/sdk

Usage

Here is a basic example of how to use the Sherry SDK:

Abi

  const exampleAbi = [
    {
      name: 'balanceOf',
      type: 'function',
      stateMutability: 'view',
      inputs: [{ name: 'owner', type: 'address' }],
      outputs: [{ name: 'balance', type: 'uint256' }],
    },
    {
      name: 'safeTransferFrom',
      type: 'function',
      stateMutability: 'nonpayable',
      inputs: [
        { name: 'from', type: 'address' },
        { name: 'to', type: 'address' },
        { name: 'tokenId', type: 'uint256' },
      ],
      outputs: [],
    },
  ] as const

Metadata definition

  const metadata: Metadata<"action", typeof exampleAbi> = {
    type: "action",
    icon: "icon",
    title: "title",
    description: "description",
    actions: [
      {
        label: "Test Action",
        contractAddress: "0x1234567890abcdef1234567890abcdef12345678",
        contractABI: exampleAbi,
        functionName: "safeTransferFrom",
        chainId: "ethereum"
      }
    ]
  };

More details in ours docs

Documentation

For detailed documentation and API reference, please visit our official documentation.

Contributing

We welcome contributions! Please read our contributing guidelines to get started.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

If you have any questions or need further assistance, feel free to reach out to our support team at [email protected].

Happy coding with Sherry SDK!