@tea-fi/contracts-types

TeaSwap Types Generator

Welcome to the TeaSwap Types Generator repository. This tool is designed to generate TypeScript types for the TeaSwap project.

Table of Contents

• Introduction
• Installation
• Usage
• Contributing
• License

Introduction

The TeaSwap Types Generator is a utility that helps developers create TypeScript types based on the TeaSwap API specifications. This ensures type safety and improves the development experience.

Installation

To install the dependencies, run:

yarn install

Usage

To generate the types, use the following command:

yarn run generate

This will create the necessary TypeScript type definitions in the src/types directory.

Artifacts

Up-to-date artifacts from the Tea-Fi smart contracts should be stored in the artifacts directory. This ensures that the latest contract ABIs and other relevant files are easily accessible for type generation and other development tasks.

Contributing

We welcome contributions! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

License

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