Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zobront/xchain
Cross chain call library for Solidity
https://github.com/zobront/xchain
Last synced: 3 months ago
JSON representation
Cross chain call library for Solidity
- Host: GitHub
- URL: https://github.com/zobront/xchain
- Owner: zobront
- Created: 2022-07-11T20:41:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-12T01:46:27.000Z (almost 2 years ago)
- Last Synced: 2024-04-04T12:57:56.261Z (3 months ago)
- Language: Solidity
- Size: 20.5 KB
- Stars: 81
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Lists
- awesome-foundry - XChain - Cross chain call library for Solidity & Foundry. (Templates & Libraries)
README
#
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
```solidity
import { XChain } from "xchain/XChain.sol";
```
2. Enable [ffi](https://book.getfoundry.sh/cheatcodes/ffi.html).
```
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`).
```
3. 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.
```
4. Make cross chain calls from your test or script
```solidity
// 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");
```
5. Decode responses
```solidity
// 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](./test/XChain.t.sol) 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](https://getfoundry.sh). See the [book](https://book.getfoundry.sh/getting-started/installation.html) 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](https://twitter.com/devan_non) and [Ape Dev](https://twitter.com/_apedev) for their work on [Solenv](https://github.com/memester-xyz/solenv) and [Surl](https://github.com/memester-xyz/surl/), which inspired this project.