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-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
CrossTalkUtils Library
Router's CrossTalk library is an extensible cross-chain framework that enables seamless state transitions across multiple chains. 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.
To make it easy to integrate Router CrossTalk in your contracts, we have created a CrossTalkUtils plug-and-play library. It gives you the following functionalities:
- Sending a single payload to a contract on the destination chain without an acknowledgement.
- Sending a single payload to a contract on the destination chain while also handling an acknowledgement on the source chain.
- Sending multiple payloads to different contracts on the destination chain without an acknowledgement.
- Sending multiple payloads to different contracts on the destination chain while also handling an acknowledgement on the source chain.
- Functions to convert type address to type bytes and vice-versa.
- If your calls were atomic, either all the calls will execute or none will execute on the destination chain. In this case, when you receive the acknowledgement, you can use a function (
getTxStatusForAtomicCall) in the library to know whether the calls were executed on the destination chain. If, in case, your calls were not successful, you can call a function (getTheIndexOfCallFailure) in the library to know the index of call which failed on the destination chain.
The documentation for this library can be found here: router-crosstalk-utils docs