Relay

Relay is the Fastest and Cheapest Way to Bridge and Transact Across Chains.

This SDK facilitates interacting with Reservoir's Relay infrastructure. Learn more about Relay by checking out the docs. Head over to the sdk docs to learn more about configuring and using the SDK in your application.

Contributing

Your contributions are what make the community great. We encourage you to be a part of it. Here are some important notes for contributors:

Preperaing Changes

We use changesets to manage versioning and changelog generation.

When contributing, please run pnpm package:change to create a changeset for your modifications. Be sure to include a descriptive summary for your changes; it helps us understand your contribution and makes the release process smoother.

Learn more about changesets here.

Getting Started

Before you start, make sure to familiarize yourself with the SDK's architecture and design principles by reading the SDK documentation. This will help you make meaningful contributions that align with the project's goals.

Pull Requests

When you're ready to contribute, submit a pull request with your changes. Our team will review your submission as soon as possible.