Forcerelay Tracking Issues

[ashuralyk]

Forcerelay is now in active development stage and has a lot of things to do.

Currently we accomplished the creation of connection and channel layer between Axon and Ckb in CI, and so dose the creation of packet layer only in Ckb, so here is the further TODO checklist in both of relayer, contract, document and acceptance components:

In the relayer of Forcerelay/Axon

features

• add sUDT escrow contract into packet test in Ckb @ashuralyk @blckngm
• accomplish packet layer CI test only in Axon @jjyr
  test: Add packet test for Axon #330
• accomplish packet layer CI test between Axon and Ckb (using sUDT transfer)
  • feat: sudt transfer module forcerelay-ckb-contracts#27
  • feat: ckb <-> axon transfer test #332
• add Axon and Ckb compatible secret keys management logic in forcerelay keys command
• check Axon and Ckb's unimplemented methods in Endpoint trait, some of them might not to be completed because of the unnecessary telemetry query requirements @jjyr
  • checklist on query methods in Axon endpoint #164
• Fully implement CKB chain endpoint #316 @ashuralyk
  • test-framework will create another mock connection id in creating IBC connection, which will cause an error print while running CI test
• implement header mpt-proof in Axon once the hard-fork feature has finished
  • uncomment AxonTools::verify_mpt_proof after Axon's bug fixed #264
• collect light client verification parameters from CKB to send with for IBC messages to Axon
• (P-Medium) handle Timeout packet in both of Axon and Ckb packet timeout issue in packet relaying scenario between two Axon chains #272
• (P-Low) complete the CI test of IBC communication between Axon and Cosmos
• (P-Low) complete the CI test of IBC communication between Ckb and Cosmos
• (P-Low) merge latest Hermes version v1.6.0 merge latest version of Hermes framework after finishing Forcerelay/Axon #255 ~~
• integrate cell-emitter runtime in Ckb monitor and relay Ckb headers and filtered cells to Axon system contract

issues

• (P-Medium) relayer only prints hex-encoded error message while execution failed in Solidity contract, which brings barrier in contract debug The error from solidity contract is hex encoded, we should parse it to human-readable string format #274

In the Solidity contract of Forcerelay/Axon

features

• replace truffle framework with hardhat @15168316096

  should keep aline with the upstream repo's tool chain.

• write script to send message to business module contract (done forcerelay-ckb-sdk sudt-transfer example) @blckngm @ashuralyk
• implement cell-existence proof check in Ckb light client once Ckb integrated live-cell mpt root in its header (work with Axon system contract)
  replaced by Axon precomplied contracts: ckb_blake2b & verify_mmr_proof
• feat: implement verifyMembership ibc-solidity-contract#38
• (P-Low) kill warnings Fix the warnings while compiling Solidity contracts ibc-solidity-contract#19
• (P-Low) docs: write script to allow developers to register their business module contract manually

issues

• (P-Low) try to reduce contract binary size if possible Optimize contract size ibc-solidity-contract#9
  • (P-Low) write more test cases to check more code branches (limited by compiled binary size)

In the CKB contract of Forcerelay/Axon

features

• design and accomplish sUDT escrow contract to enable ICS20 protocol in Ckb @blckngm
• complete tx-receipt existence check in Axon header once hard-fork feature has been finished
• (P-Medium) complete client crate to verify Axon block with validator list in Metadata cell
• (P-Medium) write more test cases to check more code branches in ckb-ics repo
• Storing full received_sequences: Vec<u64> in witness is not sustainable forcerelay-ckb-contracts#30
• (to be discussed) design and accomplish Client and Port contracts to transform client_id and port_id from h256 to arbitrary string, which increases the compatibility of Ckb with IBC protocol [refactor] add a new client cell and a new port cell to make ibc-ckb-contract compatible with IBC protocol ckb-ics#7
• (to be discussed) design and accomplish TypeId contract to use different type hash to mark a group of IBC cells (coming up with IBC Utility contract in the future, maybe)
  • There are some per-defined cell capacities in ckb-ics-axon but they are not enforced in the contracts. (Edit: this should probably be checked in the “type id” script.)
    
  • add type id script into ckb contracts to generate a unique IBC-ID to eliminate fake cells attack（optional）
    -> See also Forcerealy IBC state(SMT) rollup solution

Acceptance of Forcerelay/Axon

• deploy solidity contracts and ckb contracts manually and start a standalone forcerelay server to test the message relay in the real world
• (P-Medium) check the security of the design of Ckb contracts, which contains but not limited by the fake IBC cells and fake light client proofs, etc
• (P-Low) concurrently create connection, channel and packet to test the stability of forcerelay
• (P-Low) check the case of insufficient ckb of forcerelay

  Construct a test scenario and try to spend all the CKB of the relayer

---

Done

In the document of Forcerelay/Axon

• README.md for forcerelay, which contains introduction, high level design, simplified deployment/config instructions and todo list #327
• README.md for solidity contract
• README.md for ckb contract
• Deployment docs: [document]A complete forcerelay operation document #285
  • How to run a new Forcerelay/Axon relayer as a third party?

    operation instructions that introduce how to config forcerelay and deploy solidity and ckb contracts

• README.md for forcerelay-ckb-sdk @blckngm
  docs: write a simple README for forcerelay-ckb-sdk forcerelay-ckb-sdk#6