Skip to content

Latest commit

 

History

History
95 lines (60 loc) · 2.76 KB

README.md

File metadata and controls

95 lines (60 loc) · 2.76 KB
Raw

xchain

Cross chain calls from Solidity tests and scripts.

Installation

forge install zobront/xchain

Note: You must be running a UNIX based machine with bash and cast installed.

Usage

  1. Add import to your test or script
import { XChain } from "xchain/XChain.sol";
  1. Enable ffi.
The easiest option is to add `ffi = true` to your `foundry.toml` file.

You can also pass the `--ffi` flag to any forge commands you run (e.g. `forge script Script --ffi`).
  1. Add RPC URLs to the text file
The file lives at ./rpcs.txt. From the root of your project, the path will be ./lib/xchain/rpcs.txt.
  1. Make cross chain calls from your test or script
// There are two peek functions: peek() and peekWithCalldata().

XChain.peek(
    uint _chainId OR string memory _chainName,
    address contract,
    string memory functionSig
)

XChain.peekWithCalldata(
    uint _chainId OR string memory _chainName,
    address contract,
    string memory _calldata
)

// Example peek() with Chain ID
bytes memory res = XChain.peek(1, CONTRACT_ADDRESS, '"ownerOf(uint256)" 1');

// Example peek() with Chain Name
bytes memory res = XChain.peek("mainnet", CONTRACT_ADDRESS, '"ownerOf(uint256)" 1');

// Example peekWithCalldata() with Chain ID.
bytes memory res = XChain.peekWithCalldata(1, CONTRACT_ADDRESS, "0x6352211e0000000000000000000000000000000000000000000000000000000000000001");
  1. Decode responses
// Responses are always encoded as bytes, and must be decoded into the expected type.
address addr = address(uint160(uint256(bytes32(res))));

// There are two built in helper methods for decoding addresses and ints.
address addr = XChain.decodeAddress(res);
uint num = XChain.decodeInt(res);

Example

You can find example usage for tests in the test repo.

Why?

There is often a need to get data from other chains in the middle of Solidity tests and scripts. Currently, Forge only allows forking one network, so we aren't able to access this other data. With XChain, you can easily get data from other chains in the middle of your tests and scripts.

Development

This project uses Foundry. See the book for instructions on how to install and use Foundry.

To Dos

  • decoding helpers for more complex types
  • RPC URLs pull from environment variables if not set in rpcs.txt

Thanks

Shout out to Devan Non and Ape Dev for their work on Solenv and Surl, which inspired this project.