# Vara Network token list

## Creating a Merge Request

1. **Verify Functionality**:
   - Before creating a merge request, ensure that everything works correctly by running the following command:
     ```sh
     npm run check
     ```
   - Make sure there are no errors and all functionalities are working as expected.

2. **Submit Merge Request**:
   - Once you have verified that everything is working correctly, you can proceed to create a merge request.

## Merge Request Requirements

### Overview

This document outlines the requirements for submitting a merge request related to the `Vara Network token list` project.
Ensure that all changes adhere to the specified guidelines to maintain consistency and integrity in the token data and
related assets.

### File Naming and Uniqueness

- **File Names**: All files must have unique names within their respective directories. File names are case-insensitive.

### JSON File Requirements (`data` Directory)

1. **File Naming**:
    - The JSON file name must match the `contractAddress` property of the token and be in lowercase.

2. **File Extension**:
    - The file extension must be `.json`.

3. **Schema Validation**:
    - The JSON file must conform to the schema defined in `scripts/token-schema.json`.

### PNG File Requirements (`icons` Directory)

1. **File Naming**:
    - The PNG file name must match the `contractAddress` property of the token and be in lowercase.

2. **File Extension**:
    - The file extension must be `.png`.

3. **File Usage**:
    - Each PNG file should be used in exactly one JSON file. However, it must be used in at least one JSON file.

4. **File Dimensions**:
    - The PNG file must be square and have dimensions of at least 128x128 pixels (but no more than 1024x1024 pixels).

5. **File Format**:
    - The file must be in PNG format.