The IBC SDK is a powerful NodeJS package designed to streamline cross-chain dapp (xdapp) development using the Inter-Blockchain Communication (IBC) protocol.

• Polymer protocol
• Quickstart tutorials
• Supported dev environments
• ibctl CLI tool

Prerequisites:

• Have Node.js (including npm) installed
• Have Docker installed

To quickly get started with the IBC SDK, follow these steps:

1. Obtain a GitHub token to access the necessary containers.

Create a GitHub personal access token to authenticate to the Container registry, please refer to the GitHub docs for more info.

Make sure to select at least the read:packages scope when creating the token.

# Store your access token in an environment variable:
export GITHUB_TOKEN=<YOUR_TOKEN>

# Authenticate to the container registry
echo "$GITHUB_TOKEN" | docker login ghcr.io/polymerdao -u '< your-github-username >' --password-stdin

2. Make sure that your Node version >= 16.x

node -v

3. Run the npm install command in your terminal:

npm config set @open-ibc:registry=https://npm.pkg.github.com
npm config set //npm.pkg.github.com/:_authToken=$GITHUB_TOKEN
npm install -g @open-ibc/ibc-sdk

Note that if you use sudo for any of the above commands, you need to do it for all of them.

If you prefer to install from source, use the command make and execute it from the root of your workspace.

Note: Windows is not explicitly supported at the moment, although we will gladly accept feedback from brave explorers!

You're all set to go! But maybe you want an example run to showcase a testing workflow? Then go the quickstart tutorials page...

The IBC SDK simplifies the development process for xdapps by automating various tasks and providing essential functionalities in only a few API/CLI calls.

Here's an overview of what the package offers:

• Chain Setup Management: Launches multiple chains (dev target chains, e.g. Ethereum, wasmd + the Polymer hub) in separate Docker containers based on a simple configuration.
• Account Funding: Automatically funds developer accounts for testing and relaying purposes.
• Off-chain Relayers: Starts off-chain relayer processes to facilitate cross-chain communication and have them monitor the right channels.
• IBC Connectivity: Establishes IBC clients and connections (configurable) to prepare for cross-chain communication between xdapps.
• Virtual IBC integration: Deploys the required smart contracts on vitual chains to establish quick and easy IBC integration.

🚧 The following feature is currently still being developed, updates will follow in a future release... 🚧

• Starting from snapshots: support for bootstrapping from chain snapshots, allowing dapp developers to test their application logic locally against existing state and applications that exist on mainnet.

• CLI Commands: easy-to-use CLI tool ibctl to cover most use cases, and the ability to exec into the docker containers for more granular control
• Providing API endpoints: interact with the IBC SDK from your client environment

🚧 The following feature is currently still being developed, updates will follow in a future release... 🚧

• Status Queries: Provides convenient queries for monitoring the status of xdapp ports and messages.

🔋 The guiding principle through all of this? Batteries included, customization optional! 🔋

The IBC SDK is designed to cater to two primary user groups:

1. xDapp Developers: Developers who utilize the IBC SDK to test their xdapps before releasing them on public testnets or mainnets.
2. Polymer Developers: Developers working on the Polymer Protocol who rely on the IBC SDK to ensure compliance with specifications.

By leveraging the IBC SDK, developers can overcome several pain points associated with xdapp development and IBC integration. Take a seat and relax while IBC SDK does all the hard set up for you! 🏖️

Here are some of the key benefits:

As a xdapp developer, you often face multiple prerequisites when testing xdapps. These include launching supported chains, setting up the hub (Polymer chain), funding developer accounts, deploying smart contracts, configuring and launching off-chain relayers, and ensuring the correct monitoring of smart contracts and IBC clients.

The IBC SDK simplifies this cumbersome and error-prone process into a single API call, allowing you to quickly set up the necessary environment for xdapp testing.

🚧 This feature is currently still being developed, updates will follow in a future release... 🚧

Tracking the status changes of IBC ports, channels, and xdapp smart contracts typically involves querying multiple processes across different chains and relayers. The IBC SDK offers a unified query entrypoint that consolidates the status information from all relevant sources. This saves time and effort by providing a single interface to monitor and analyze the status of your xdapp components.

The IBC SDK is not only valuable during development and testing but also offers essential features for production environments. xdapp developers can continue to utilize the SDK's query API to monitor the status of their smart contracts and IBC packages.

🚧 This feature is currently still being developed, updates will follow in a future release... 🚧

Furthermore, IBC developers can leverage the IBC SDK's query API to gather high-level data related to the Polymer Protocol, IBC, and vIBC that's running under the hood. This aggregated data can be visualized in a dashboard, providing valuable insights into the traffic and performance of your cross-chain communication.

To contribute, report issues, or explore the source code, visit the IBC SDK GitHub repository.

Join our vibrant community on Discord 🐱‍💻