sol-warp 1.2.0

A Solidity to Cairo Transpiler

Warp

Warp brings Solidity to StarkNet, making it possible to transpile Ethereum smart contracts to Cairo, and use them on StarkNet.

Table of Contents :clipboard:

• NOTE
• Warp
  • Table of Contents :clipboard:
  • Installation :gear:
  • Setting up autocompletion
  • Usage :computer:
  • Solidity Constructs Currently Not Supported
  • Want to contribute? :thumbsup:
  • License

Installation :gear:

Prerequisites: Make sure your Solidity compiler version is >= 0.8.0

Linux:

sudo apt update
sudo apt install software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install -y python3.7
sudo apt install -y python3.7-dev
sudo apt install -y libgmp3-dev
sudo apt install -y libboost-all-dev
sudo apt-get install -y python3.7-venv
python3.7 -m venv ~/warp
source ~/warp/bin/activate
pip install z3-solver

MacOs:

brew install python@3.7
brew install gmp
brew install boost
brew install z3
python3.7 -m venv ~/warp
source ~/warp/bin/activate

Install Warp:

pip install sol-warp

Setting up autocompletion

Warp comes with support for command line completion in bash, zsh, and fish

for bash:

 eval "$(_WARP_COMPLETE=bash_source warp)" >> ~/.bashrc

for zsh:

 eval "$(_WARP_COMPLETE=zsh_source warp)" >> ~/.zshrc

for fish:

_WARP_COMPLETE=fish_source warp > ~/.config/fish/completions/warp.fish

Usage :computer:

You can transpile your Solidity contracts with:

warp transpile FILE_PATH CONTRACT_NAME

To see the cairo output of the transpilation process:

warp transpile FILE_PATH CONTRACT_NAME --cairo-output

CONTRACT_NAME is the name of the primary contract (non-interface, non-library, non-abstract contract) that you wish to transpile

To deploy the transpiled program to Starknet use:

warp deploy CONTRACT.json

To invoke a public/external method use:

warp invoke --program CONTRACT.json --address ADDRESS --function FUNCTION_NAME --inputs 'INPUTS'

Here's an example that shows you the format of the inputs for inputs:

Let's say we want to call the following Solidity function in a contract that we've transpiled & deployed on StarkNet:

struct Person {
    uint age;
    uint height;
}
function validate(address _ownerCheck, Person calldata _person, uint _ownerCellNumberCheck)
  public view returns (bool) {
    return (owner == _ownerCheck && ownerAge == _person.age
        && ownerCellNumber == _ownerCellNumberCheck);
}

The command to call this function would be:

warp invoke --program CONTRACT.json --address ADDRESS --function validate \
        --inputs '[0x07964d2123425737cd3663bec47c68db37dc61d83fee74fc192d50a59fb7ab56,
        (26, 200), 7432533831]'

The --inputs flag, if not empty, should always be an 'array'. As you can see, we have passed the struct fields as a tuple, their order should be the same as their declaration order (i.e age first, person second). If the first argument to the validate function was an array of uint's, then we'd pass it in as you'd expect:

--inputs = '[[42,1722,7], (26, 200), 7432533831]'

If you're passing in the bytes Solidity type as an argument, use the python syntax, for example:

--inputs = '[[10,20], b"\x01\x02"]'

You can check the status of your transaction with:

warp status TX_HASH

Testing with Warp

You'll find an example of how to write tests in your solidity contract, and then call warp test to run them in src/warp/test_tool/example. For the tests to work, you'll need to run warp test from a parent directory where your solidity contracts are in a directory named contracts, as per the example mentioned above.

Solidity Constructs Currently Not Supported

Support Status	Symbol
Will likely never be supported	:x:
Support will land soon	:hammer_and_pick:
Will be supported in the future	:exclamation:
Currently Unknown	:question:

Solidity	Support Status
try/catch	:question:
msg.value	:x:
tx.origin	:exclamation:
tx.gasprice	:question:
block.basefee	:x:
block.chainid	:exclamation:
block.coinbase	:question:
block.difficulty	:x:
block.gaslimit	:question:
gasleft()	:question:
functions as data	:x:
precompiles	:exclamation:
create/create2	:exclamation:
Selfdestruct	:x:
BlockHash	:exclamation:

Yul	Support Status
linkersymbol	:question:
codeCopy	:question:
codeSize	:question:

Run solc --optimize --ir-optimized <file> to see if your Solidity results in any of these YUL constructs.

Want to contribute? :thumbsup:

Your contributions are always welcome, see contribution guidelines.

License

Apache License Version 2.0, January 2004.