From 6a15678a125b4969f72d2de676e758804af66d4c Mon Sep 17 00:00:00 2001 From: AntonAndell Date: Thu, 10 Aug 2023 12:44:50 +0200 Subject: [PATCH] feat: Update readme to include important links and topics --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9488d37c..ea915b76 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ [rust-cov-badge]: https://codecov.io/gh/icon-project/xCall/branch/main/graph/badge.svg?token=KWDB59JITE&flag=rust # XCall +XCall is a cross chain messaging service built to mimic regular transaction flows across any interoperable solution. + +For full xCall specification see [XCall Spec](./docs/adr/xcall.md). + +## Building with xCall +For building dapps with xCall see official developer [docs](https://www.xcall.dev/). ### Project Structure | Directory | Description | @@ -18,4 +24,17 @@ | [/contracts/evm](./contracts/evm) | Includes contracts for evm based chains | | [/contracts/javascore](./contracts/javascore) | Includes contracts for ICON chain | | [/docs](./docs) | Documentation | -| [/scripts](./scripts) | Scripts to automate task in project, for example build scripts, deploy scripts. | \ No newline at end of file +| [/scripts](./scripts) | Scripts to automate task in project, for example build scripts, deploy scripts. | + + +## Available Connection implementations +* [IBC](https://github.com/icon-project/IBC-Integration/blob/main/docs/adr/XCall_IBC_Connection.md) + * [Rust](https://github.com/icon-project/IBC-Integration/tree/main/contracts/cosmwasm-vm/cw-xcall-ibc-connection) + * [Java](https://github.com/icon-project/IBC-Integration/tree/main/contracts/javascore/xcall-connection) +* [BTP](https://github.com/icon-project/btp2) is supported natively and does not need a connection contract. + +## Building a xCall connection +If xCall is deployed, anyone can create a new connection contract to relay messages between xCall contracts. +To do this a connection contract has to be developed and deployed on both sides. + +The base design for a connection can be found in the [xCall docs](./docs/adr/xcall.md#Connections) \ No newline at end of file