Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 1.8 KB

README.md

File metadata and controls

71 lines (48 loc) · 1.8 KB

Hyperbridge SDK

CI License: MIT

Hyperbridge SDK is a comprehensive solution for cross-chain message indexing and retrieval. This monorepo contains two main packages:

  • @hyperbridge/indexer: A SubQuery-based indexer for tracking cross-chain messages
  • @hyperbridge/sdk: A JavaScript/TypeScript SDK for interacting with the indexed data

Packages

Package Description
@hyperbridge/indexer The indexer service that processes and stores cross-chain messages
@hyperbridge/sdk SDK for developers to query and monitor cross-chain messages

Getting Started

Prerequisites

  • Node.js 22+
  • pnpm 7+

Installation

# Clone the repository
git clone https://github.com/polytope-labs/hyperbridge-sdk.git
cd hyperbridge-sdk

# Install dependencies
pnpm install

# Build all packages
pnpm build

Development

# Run tests
pnpm test

# Lint code
pnpm lint

# Format code
pnpm format

Contributing

Create a changeset when making changes:

pnpm changeset

Commit your changes along with the changeset:

git add .
git commit -m "feat: your feature description"
git push

License

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

Acknowledgments