Skip to content

Latest commit

 

History

History
114 lines (99 loc) · 5.38 KB

DevNotes.md

File metadata and controls

114 lines (99 loc) · 5.38 KB
Raw

Development Notes

Phat Contract side

Misc

  • Refactor experimental code as contracts
    • Switch to OpenBrush's ink-env with the advanced unit test kits

Components

  • SimpleScheduler
    • Design
    • Query poll()
      • call all the ready targets
      • should check health (trigger exactly one health worker)
    • Tx register(config, address, calldata) owner-only (direct call, stateless)
    • Tx delete(id) owner-only
    • log the triggered events
  • Rollup Submit
    • Account management: generate secret key & reveal public key
    • Tx config(rpc, rollup_handler, anchor) by owner
    • Query poll()
      • get Result<RollupResult, Vec<u8>> response
      • submit tx to RollupResult.target_id
        • use the latest nonce
        • fire and forget
    • enum RollupTarget
      • EVM(chain, address)
      • Pallet(chain)
    • Raw tx submit
    • Gas efficiency submit - for gas efficiency, save the recent submitted tx to local storage (with timeout) to avoid redundant submission in a short period
  • TestOracle
    • Minimum implementation
    • Refactor to strip SDK logic
    • Real-time fetch price
    • Feed
    • Request
  • Locks
    • Experimental lock tree (tx_read, tx_write)
    • Correct implementation
  • struct RollupTx
    • Condition
    • Updates
    • Actions
  • struct RollupResult
    • RollupTx
    • RollupTarget
    • (opt) signature of RollupTx
  • Read client
    • Read from EVM
    • Wrap as a client object
    • Consider block_hash when reading data
    • Read from Substrate
    • Batch read optimization
    • Substrate WS client
  • Security
    • RPC cross validation
    • RPC redundancy
    • RPC light validation
    • Rollup cross validation

Development Notes

  • To run Phat Contract unit tests, you need to configure .env file under each contract directory. It's suggested to copy .env_sample to .env and config it based on the comments.
  • abi.decode() doesn't have any error handling currently. When it failed, the transaction will get revereted silently, which is hard to debug. So it's always a good habit to verify the raw input to decode() beforehand.
  • In unit tests, you can enable logging output (e.g. from pink::info!()) by:
    1. Add env_logger as the [dev-dependency] in the Cargo.toml file
    2. Call env_logger::try_init() at the beginning of each test function
    3. Launch the unit test with additional flags: RUST_LOG=debug cargo test -- --nocapture

Manual Full Test

(Doc WIP; info below may be incorrect.)

  1. Compile and deploy SampleOracle and EvmTransactor with their default() constructor
    • This can be done with the Phat Contract UI
    • The caller wallet will be the owner of the two contracts.
  2. Query EvmTransactor::wallet() to get the generated EVM wallet address, and deposit some test ETH to the wallet for gas fee. This account will be used to send rollup transaction from Phat Contract to EVM.
  3. Deploy the EVM contracts (PhatQueuedAnchor and TestOracle) under evm/contracts.
    • Deploy with hardhat: npx hardhat run scripts/deploy-test.ts --network <network>
    • Please replace phatEvmTransactor in deploy-test.ts with the wallet you get from step 2
    • The script will output the address of the deployed contracts
  4. Config SampleOracle and EvmTransactor
    • Can be don with Phat Contract UI
    • Config SampleOracle: give it the EVM RPC address (e.g. Alchemy Goerli RPC) and the EVM PhatQueuedAnchor address
    • Config EvmTransactor: give it the EVM RPC address, the Phat Contract SampleOracle address (rollup_handler), and the EVM PhatQueuedAnchor address
    • The E2E test script is an equivalent example
  5. Call the EVM contract TestOracle.request() to initiate a request
  6. Call Phat Contract EvmTransactor::poll() to answer the request
    • It should results in an rollup transaction like this

Deploy with scheduler

(Doc WIP; info below may be incorrect.)

  1. Follow the "Manual Full Test" section to setup SampleOracle, EvmTransactor, and the EVM contracts.
  2. Deploy LocalScheduler with default() constructor
  3. Call LocalScheduler::add_job() to add the automation job to trigger EvmTransactor::poll()
    • name: an arbitrary name
    • cron_expr: a cron-like expression of the automation. * * * * * means trigger per minute.
    • target: the address of EvmTransactor
    • call: the encoded call data of EvmTransactor::poll(), which is 0x1e44dfc6
  4. Call poll() repeatedly. It will trigger the job according to the cron expression.
  5. You can check LocalScheduler::getJobSchedule(n) to check the scheduled task
    • n is the job id, starting from 0.
    • Tasks are scheduled after the first poll(). So a newly added task will have None output until the first poll().
  6. The scheduler prints logs to indicate how it trigger the events. Can read it from the UI.

EVM Oracle E2E test

(Doc WIP)