JSPM

@routerprotocol/router-crosstalk

0.1.8
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8
  • Score
    100M100P100Q37118F
  • License MIT

Router Crosstalk SDK to develop cross chain Smart contracts

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@routerprotocol/router-crosstalk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    babel

    Router Crosstalk

    Enabling crosschain contracts

    npm Downloads undefined undefined

    undefined undefined

    undefined undefined

    Router Crosstalk Library

    Router's CrossTalk library is an extensible cross-chain framework that enables seamless state transitions across multiple chains akin to IBC for Cosmos. In simple terms, this library leverages Router's infrastructure to allow contracts on one chain to communicate with contracts deployed on some other chain. The library is structured in a way that it can be integrated seamlessly into your development environment to allow for cross-chain message passing without disturbing other parts of your product.

    Installation

    This is a Node.js module available through the npm registry.

    Before installing, download and install Node.js.

    $ npm install --save-dev @routerprotocol/router-crosstalk

    Features

    • State-of-the-art cross-chain smart contract infrastructure.
    • Focus on trustless system.
    • Super-high test coverage.
    • Developer-friendly library.

    Detailed Documentation

    Detailed documentation of router crosstalk can be found at dev.routerprotocol.com/crosstalk-library

    Quick Start

    The quickest way to get started is to create a project using truffle or hardhat and installing the Crosstalk library using the command: 

    $ npm install @routerprotocol/router-crosstalk

    While creating a new contract, make sure to import and inherit the Crosstalk Contract file from the library and initialize it using the generic handler address while initializing the contract.

    After the contracts have been developed, four tasks remain!

    • Setting the linker address.
    • Setting the fee token address.
    • Approving fees to be spent by generic handler from the contract using approveFees function.
    • Mapping the contracts on different chains using the generic handler.

    Use the documentation to find out how these tasks can be accomplished.

    Sample Repository

    We have also created a sample repository which contains a hardhat project with a Cross-chain Greeter contract and tasks created to set the variables such as linker address and fee token address as well as approving fees and mapping contracts.

    Clone the repository at https://github.com/router-protocol/router-crosstalk-sample and install the dependencies using the following commands:

    $ git clone https://github.com/router-protocol/router-crosstalk-sample.git
$ npm install

    This will automatically install the Router Crosstalk Library along with other dependencies. Read the Readme.md file for steps to use this repository.