Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nethermindeth/warp-test-box
Testing warp transpilation on truffle
https://github.com/nethermindeth/warp-test-box
nubia
Last synced: 10 days ago
JSON representation
Testing warp transpilation on truffle
- Host: GitHub
- URL: https://github.com/nethermindeth/warp-test-box
- Owner: NethermindEth
- License: mit
- Created: 2022-07-11T16:05:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-08T07:52:14.000Z (over 2 years ago)
- Last Synced: 2024-11-24T20:36:44.911Z (about 1 month ago)
- Topics: nubia
- Language: JavaScript
- Size: 98.6 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# warp-test-box (Alpha)
(Testing warp transpilation on truffle)
The Truffle Warp-transpiler Box provides the boilerplate Truffle structure necessary to start coding for StarkWare's Ethereum L2 solution, StarkNet. This is different from starknet box as it allows the developer to write solidity contracts and the compiler will automatically transpile these contracts to cairo contracts and deploy them on strakent without the user having to do any extra work.
## Instructions
1. As yet this box has not been officially published on truffles repo so for now to unbox run:
```bash
truffle unbox https://github.com/NethermindEth/warp-test-box
```
2. The solidity contracts to be transpiled should be put into `/contracts/starkent/` folder.
3. At this point if you are not in the root folder of your project then return to the root folder.
### Transpilation
To enable transpilation run `compile_starknet.mjs`:
```bash
npm run starknet:compile
```
### Deploy via warp
To deply cairo files present in `contracts/starknet` folder.
To deploy transpiled contracts via warp run the below command giving constructor arguments after the command. Arguments must be comma seperated.
```bash
npm run starknet:deploy
```
## Transpilation Process
There are two folders present in the contracts folder ethereum and starknet.
The `contracts/ethereum` folder conatains all solidity files that are not meant to be transpiled example L1 code while the `contracts/starknet` folder contains files which will be automatically transpiled to cairo on running the compile command. However solidity files with name `cairo_*.sol` which are present in the ethereum folder with be selectively transpiled to cairo and put into the starknet folder.
By default all L1 files should be put into ethereum folder while solidity files meant for transpilation for L2 part should be put into starknet folder.
## Box Structure ( Transpilation )
The main core of this box is in the `scripts` directory. This directory contains all the necessary l2 compilation/deploying files to enable cairo contracts to be deployed to starkWares networks.
On unboxing the entire box is set up and the ethereum folder is created under `/contracts/ethereum/`solidity contracts in this folder with name starting with `cairo_` will be comverted to cairo and stored in the starknet folder.
Solidity contracts present in the starknet folder will be converted into ciaro contracts and stored in `/contracts/starknet/`.
The three main files that are releavant for transpiling solidity to cairo are present in the scripts folder.
- [`cairo_transpiler.mjs`](https://github.com/Vishvesh-rao/starknet-test-box/blob/main/scripts/cairo_transpiler.mjs)
- [`compile_starknet.mjs`](https://github.com/Vishvesh-rao/starknet-test-box/blob/main/scripts/compile_starknet.mjs)
- [`exec_shellcmd.mjs`](https://github.com/Vishvesh-rao/starknet-test-box/blob/main/scripts/exec_shellcmd.mjs)
***Import order:***
```mermaid
graph TD;
compile_starknet.mjs-->cairo_transpiler.mjs;
cairo_transpiler.mjs-->exec_shellcmd.mjs
```
### #cairo_transpiler.mjs
This is the main executeble file which links truffle to warp and transpiling the contracts and is also responsible for certain folder creations, moving around of contracts, and at the end deleting any extra folders created and storing the transpiled cairo contracts into `/contracts/starknet/`.
It imports from `exec_shellcmd.mjs` to enable execution of shell commands.
### #exec_shellcmd.mjs
This is a utillity module which defines the `run()` fucntion to execute shell commands.
### #compile_starknet.mjs
This contract is main module with regards to the compilation of cairo contracts stored in `/contracts/starknet/`.
This imports `cairo_transpiler.mjs` module