synapsecns/sanguine

View on GitHub
packages/synapse-constants/README.md

Summary

Maintainability
Test Coverage
# Synapse Constants

[![npm](https://img.shields.io/npm/v/synapse-constants?style=flat-square)](https://www.npmjs.com/package/synapse-constants)

This package contains the Synapse Protocol Token and Chain Constants

## Installation

With Yarn:

```bash
yarn add @synapsecns/synapse-constants
```

## Build

The following command will build the package locally

```
yarn build
```

## Usage

Importing supported tokens and chains:

```js
import { BRIDGABLE_TOKENS, CHAINS } from '@synapsecns/synapse-constants'
```

Importing a specific token:

```js
import { USDC } from '@synapsecns/synapse-constants'
```

## TODO

- [ ] Instructions on adding new chains
- [ ] Instructions on adding new tokens
- [ ] Instructions on generating new token route map