hyperledger-labs / yui-ibc-solidity Goto Github PK

View Code? Open in Web Editor NEW

124.0 15.0 59.0 2.44 MB

IBC in Solidity

License: Apache License 2.0

Makefile 0.24% Dockerfile 0.12% Shell 0.28% Solidity 86.92% Go 12.43%

solidity ethereum hyperledger-besu ibc cosmos

yui-ibc-solidity's Introduction

ibc-solidity

IBC implementations in Solidity.

IBC compatibility: v8

This is available not only for Ethereum and Hyperledger Besu, but also for Polygon PoS and other EVM-compatible chains.

DISCLAIMER: This project is still under development and has not been audited.

Features

Implementation of ICS
Implementation of ICS-20
ERC-20 Token Transfer

Documents

Supported Light Client

You can deploy a Light Client that implements the ILightClient interface to integrate with ibc-solidity.

Here are some such examples:

IBC relayer support

yui-relayer: An IBC relayer for heterogeneous chains
ethereum-ibc-relay-chain: A relay-chain module for EVM-compatible chains
ethereum-ibc-relay-prover: A relay-prover module for Ethereum sync committee
ibft2-relay-prover: A relay-prover module for IBFT 2.0 consensus

Related projects

A demo of trustless bridge
- between Harmony and Cosmos(Tendermint): https://github.com/datachainlab/harmony-cosmos-bridge-demo
- between Celo and Cosmos: https://github.com/ChorusOne/celo-cosmos-bridge
A demo of bridge between Cosmos(ibc-go) and Ethereum using IBC and LCP: https://github.com/datachainlab/cosmos-ethereum-ibc-lcp

For Developers

Unit test

$ make test

E2E test

Launch two Hyperledger Besu chains(ethereum-compatible) with the contracts deployed with the following command:

$ make network-e2e

After launch the chains, execute the following command:

$ make e2e-test

E2E-test with IBC-Relayer

An example of E2E with IBC-Relayer(yui-relayer) can be found here:

solidity-protobuf

To generate the proto encoders and decoders in solidity from proto files, you need to use the code generator solidity-protobuf

Currently, v0.1.0 is required.

If you edit the proto definitions, you should execute the following command:

$ make SOLPB_DIR=/path/to/solidity-protobuf proto-sol

Maintainers

Jun Kimura

yui-ibc-solidity's People

Contributors

Stargazers

Watchers

Forkers

datachainlab toshihiko-okubo sekmet mkaczanowski bluele siburu trajan0x chorusone electronic-signatures-industries polymerdao zedonboy milli-archive 3100 twominutecode abhinavmir stcchain khoslaventures endygamie tauruswei rafaelapb riversyang kokeshim0chi hiromaily hackersamuraidao composablefi blueshift-fi singhravipratap daveminer electron-labs mattsu6666 jinankjain pinkdiamond1 binny1024 wdh1012 amherstlabs yoshidan hussein-aitlahcen samkenxstream michwqy neoiss 0fatih gavin-research adamewozniak avenlabs dzmitry-lahoda-forks kunpengren zsystm linyer-qwq gacwr asverty kaur-d23 skywalker2017 dongrie willchain-labs

yui-ibc-solidity's Issues

Goals for this project?

Hi y'all. I have a few questions about this. It's very interesting.

Does Interchain Foundation support this project?
How much maintenance is expected on this project once it reaches the current state of the IBC protocol? Will it need to be updated regularly, and are there transition plans in place for folks who use the smart contract as the contract implementation may change?
Which blockchains would be good targets for usage with a smart contract implementation of IBC?

Cheers! Let me know if these questions are best answered elsewhere as well. Feel free to tag any relevant parties.

Add link to a tutorial

We are preparing a tutorial for developing a sample IBC application using yui-ibc-solidity. The hyperlink of the tutorial will be added to README.

Turn TODOs into issues for easier tracking

Example here - this todo is pretty simple to do (and highly suggested). This can be a starting point, but todos as issues are easier to tackle. Can take it up.

Compatibility with ibc-go v4

https://github.com/cosmos/ibc-go/releases/tag/v4.0.0-rc2

Comply with ibc-go v1.0.0-beta1

ref. https://github.com/cosmos/ibc-go/releases/tag/v1.0.0-beta1

`VerifyPacketAcknowledgement` should receive an acknowledgement data instead of its commitment

IBCHandler::sendMessage method accepting google protobuf ``Any`` to dispatch messages

there should be a general entry point able to receive an Any protobuf message to collect and dispatch all the messages sent to the IBC Handler by a relayer, as the cosmos client has.
Just to give a few references, looking at hermes, one of the most trending ibc relayer implementation:
https://docs.rs/ibc-relayer/0.8.0/ibc_relayer/chain/trait.ChainEndpoint.html#tymethod.send_messages_and_wait_commit
https://docs.rs/ibc-relayer/0.8.0/src/ibc_relayer/chain/cosmos.rs.html#874-928

Use the prefix for writing a commitment

Stop compile-time warnings

Stop warnings related to:

Function state mutability
public modifiers of constructors
Unused function parameter
Variable shadowing

Fix occasional errors related to delay-period on E2E testing

ref: https://github.com/hyperledger-labs/yui-ibc-solidity/runs/4068329218?check_suite_focus=true#step:11:10

Port contract initialization transactions to truffle script

yui-ibc-solidity/pkg/testing/chains.go

Line 248 in ca90e73

func (chain *Chain) Init() error {

Remove the view modifier from the state verification functions in IClient

This is because there is some IBC client spec that has side-effects in state verification functions.
e.g. https://github.com/cosmos/ibc/tree/master/spec/client/ics-006-solo-machine-client

forge test is failing to compile

The following error message is reported:

❯ forge test
[⠒] Compiling...
[⠢] Unable to resolve imports:
      "openzeppelin-solidity/contracts/utils/Context.sol" in "/home/ubuntu/electron/zk-ibc/ibc-solidity/contracts/app/ICS20Bank.sol"
      "openzeppelin-solidity/contracts/utils/Address.sol" in "/home/ubuntu/electron/zk-ibc/ibc-solidity/contracts/app/ICS20Bank.sol"
      "openzeppelin-solidity/contracts/utils/Context.sol" in "/home/ubuntu/electron/zk-ibc/ibc-solidity/tests/foundry/src/MockApp.sol"
      "openzeppelin-solidity/contracts/token/ERC20/ERC20.sol" in "/home/ubuntu/electron/zk-ibc/ibc-solidity/contracts/app/SimpleToken.sol"
      "openzeppelin-solidity/contracts/token/ERC20/IERC20.sol" in "/home/ubuntu/electron/zk-ibc/ibc-solidity/contracts/app/ICS20Bank.sol"
      "openzeppelin-solidity/contracts/utils/Context.sol" in "/home/ubuntu/electron/zk-ibc/ibc-solidity/contracts/app/ICS20Transfer.sol"
      "openzeppelin-solidity/contracts/access/AccessControl.sol" in "/home/ubuntu/electron/zk-ibc/ibc-solidity/contracts/app/ICS20Bank.sol"
with remappings:
      ds-test/=/home/ubuntu/electron/zk-ibc/ibc-solidity/tests/foundry/lib/forge-std/lib/ds-test/src/
      forge-std/=/home/ubuntu/electron/zk-ibc/ibc-solidity/tests/foundry/lib/forge-std/src/
[⠰] Compiling 41 files with 0.8.17
[⠔] Solc 0.8.17 finished in 76.26ms
Error:
Compiler run failed
error[6275]: ParserError: Source "openzeppelin-solidity/contracts/utils/Context.sol" not found: File not found. Searched the following locations: "/home/ubuntu/electron/zk-ibc/ibc-solidity".
 --> contracts/app/ICS20Bank.sol:4:1:
  |
4 | import "openzeppelin-solidity/contracts/utils/Context.sol";
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



error[6275]: ParserError: Source "openzeppelin-solidity/contracts/access/AccessControl.sol" not found: File not found. Searched the following locations: "/home/ubuntu/electron/zk-ibc/ibc-solidity".
 --> contracts/app/ICS20Bank.sol:5:1:
  |
5 | import "openzeppelin-solidity/contracts/access/AccessControl.sol";
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



error[6275]: ParserError: Source "openzeppelin-solidity/contracts/token/ERC20/IERC20.sol" not found: File not found. Searched the following locations: "/home/ubuntu/electron/zk-ibc/ibc-solidity".
 --> contracts/app/ICS20Bank.sol:6:1:
  |
6 | import "openzeppelin-solidity/contracts/token/ERC20/IERC20.sol";
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



error[6275]: ParserError: Source "openzeppelin-solidity/contracts/utils/Address.sol" not found: File not found. Searched the following locations: "/home/ubuntu/electron/zk-ibc/ibc-solidity".
 --> contracts/app/ICS20Bank.sol:7:1:
  |
7 | import "openzeppelin-solidity/contracts/utils/Address.sol";
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



error[6275]: ParserError: Source "openzeppelin-solidity/contracts/utils/Context.sol" not found: File not found. Searched the following locations: "/home/ubuntu/electron/zk-ibc/ibc-solidity".
  --> contracts/app/ICS20Transfer.sol:12:1:
   |
12 | import "openzeppelin-solidity/contracts/utils/Context.sol";
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



error[6275]: ParserError: Source "openzeppelin-solidity/contracts/token/ERC20/ERC20.sol" not found: File not found. Searched the following locations: "/home/ubuntu/electron/zk-ibc/ibc-solidity".
 --> contracts/app/SimpleToken.sol:4:1:
  |
4 | import "openzeppelin-solidity/contracts/token/ERC20/ERC20.sol";
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



error[6275]: ParserError: Source "openzeppelin-solidity/contracts/utils/Context.sol" not found: File not found. Searched the following locations: "/home/ubuntu/electron/zk-ibc/ibc-solidity".
  --> tests/foundry/src/MockApp.sol:11:1:
   |
11 | import "openzeppelin-solidity/contracts/utils/Context.sol";
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

encountered an error while attempting to update latest block

when i exec NO_GEN_CODE=1 ./scripts/setup.sh testtwochainz :

> Compilation skipped because --compile-none option was passed.

/Users/binny/go/src/yui-ibc-solidity/node_modules/eth-block-tracker/src/polling.js:51
        const newErr = new Error(`PollingBlockTracker - encountered an error while attempting to update latest block:\n${err.stack}`)
                       ^
Error: PollingBlockTracker - encountered an error while attempting to update latest block:
undefined
    at PollingBlockTracker._performSync (/Users/binny/go/src/yui-ibc-solidity/node_modules/eth-block-tracker/src/polling.js:51:24)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)

Update docs

Due to changes from #130, docs needs to be updated.

Introduce `generateIdentifier` to Client, Connection, and Channel

Identifiers that identify these states need to be generated by the host state machine, not given from an external input.

spec:

Change the module path to hypeledger-labs/yui-ibc-solidity

Fix type of `timeoutHeight` in ICS20

should use Height struct instead of uint64

Use IBC's struct `Height` as height parameter in IClient

Initialize the state of IBC using truffle instead of the test suite

This operation should be performed at the contract initialization.

https://github.com/hyperledger-labs/yui-ibc-solidity/blob/main/pkg/testing/chains.go#L248

cc: @toshihiko-okubo

checkout proto files from ibc-go

ibc-solidity places a high priority on compatibility with ibc-go. By using a tool like submodule to check out proto files for IBC, we can clarify supported version and simplify operations when updating ibc version.

Support generic proof verification

https://github.com/cosmos/ibc/tree/main/spec/core/ics-002-client-semantics#state-verification

Introduce linting tool

something like https://github.com/protofire/solhint

Add ChanClose{Init,Confirm} support

spec: https://github.com/cosmos/ics/tree/master/spec/ics-004-channel-and-packet-semantics

Consider to store {client,consensus}state in the host as protobuf-Any

It's for ibc-go compatibility.

Compatibility with packet commitment in ICS

ref. https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#sending-packets

Add Packet Timeout support

spec: https://github.com/cosmos/ics/tree/master/spec/ics-004-channel-and-packet-semantics

IBFT2 header fails to decode in multiple validators configuration.

Decoding is successful in using Solidity v0.6, but it fails in using Solidity v0.8.
The issue is related to "Checked arithmetic", which was introduced in v0.8?
You can reproduce this bug by using this branch.

ICS-20: Use JSON for packet data serialization

This is required for compatibility with ICS and ibc-go implementation.

ref. https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer#data-structures

ICS20Transfer: Authenticate a caller of Module callback functions

Received unexpected error: when i exec `chains_test.go`

This is where things go wrong：

blockNumber =====  0x33af
address =====  e6d8ff7eddb380c99b898c04b78edda4a92cc966
hashes =====  []
blockNumber =====  0x93130
    chains_test.go:186: delay for ack@chainA 15.430340792s
    chains_test.go:216: 
        	Error Trace:	/Users/binny/go/src/yui-ibc-solidity/tests/e2e/chains_test.go:216
        	Error:      	Received unexpected error:
        	            	All attempts fail:
        	            	#1: failed to execute a transaction: &{{[] 0 232807 [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0] [] 0x09c8f5d14efcd2eb8ada8121154a872f8186ba458e0b081738f29c74f9d5f010 0x0000000000000000000000000000000000000000 232807 0xdeb835b13d51e2bbb3f2737eb7ffedbb81dc28eac41f10c2387c19c109ccc669 13273 0} []}
        	Test:       	TestChainTestSuite/TestChannel
    --- FAIL: TestChainTestSuite/TestChannel (154.75s)


FAIL

Debugger finished with the exit code 0

Supports IBFT consensus in GoQuorum

ref. https://docs.goquorum.consensys.net/en/stable/Concepts/Consensus/IBFT/

consider using more efficient solidity proto libraries

from @adlerjohn:

They encode to storage, not memory https://github.com/datachainlab/ibc-solidity/blob/e5c5e622877e1c6c5269b4238889007dd135be13/contracts/core/types/ProtoBufRuntime.sol#L21
i.e. it'll cost like a billion gas to do anything. If you know them, tell them to use and contribute to my library!

Add pruning old consensus states support

Implement tests for verifyClientState and verifyClientConsensusState

Apply code fmt and check it on CI

``createClient`` should return the clientID

function createClient should return a string with the clientID just created.

Pass the relayer address to functions in App Module

cosmos/ibc#579

Add ClientMisbehaviour support

ref. https://github.com/cosmos/ibc/tree/master/spec/core/ics-026-routing-module#datagram-handlers-write

Compliant with IBC commitment path spec

bump solidity version

This is blocked by datachainlab/solidity-protobuf#10

Create a MAINTAINERS.md file

Example: https://github.com/hyperledger-labs/solang/blob/main/MAINTAINERS.md Example of a pointer: https://github.com/hyperledger-labs/homebrew-solang/blob/main/MAINTAINERS.md

Add mock client support

Currently, we support only the IBFT2 client as IBC Client, so many features of IBC will only work on Besu. There is a concern that this will increase the cost of development. Therefore, we wanted to run our implementation except for the IBC Client on ganache, which is more suitable for contract development. This is expected to be achieved by supporting a mock IBC Client.