docs: compile, deploy and interact contracts on starknet-devnet-rs using starkli

[rnbguy]

Closes #1
Closes #4

Rendered

[soareschen]

Thanks for the detailed documentation! Actually, we can also put the documentation on Notion, if it makes it easier to write and keep updated. Sorry for not being clear earlier.

For proper documentation, we can do it a bit later once the projects are properly setup. We will also try to automate the steps in the future using Nix and Rust, so that there are less manual steps to take.

[rnbguy]

Ah. I still like to keep this at docs/ as I look at Github more than Notion for engineering stuff. I can still create a notion page for continuous updates.

[rnbguy]

One thing I noticed, starkli call doesn't support --block-number to read data from previous blocks.(I was not using latest version) Also, I couldn't find a way to dump the starkli outputs in JSON.

The other tool library, I liked, is starknetjs. Although, it is a typescript package and not a command line tool, using it through deno is simple.

$ docker network create starknet-network
$ docker run --rm --network starknet-network --name starknet.devnet shardlabs/starknet-devnet-rs --seed=0 --accounts=3 --state-archive-capacity=full
$ docker run --rm --network starknet-network denoland/deno eval -q '
import { RpcProvider } from "npm:starknet";
console.log(await new RpcProvider({ nodeUrl: "http://starknet.devnet:5050" }).getBlockNumber());
'
0

This may be useful if we are writing CI automation scripts.

[soareschen]

I think we don't need to worry about automation and formatting for now. The use of starkli is a starting point. Since it is written in Rust and is using starknet-rs, it will be quite easy to use the library underneath to directly implement the automation and integration tests in Hermes SDK. The current documentation is more for our own reference, so that we can get things working manually while the automation is implemented.

Ah. I still like to keep this at docs/ as I look at Github more than Notion for engineering stuff. I can still create a notion page for continuous updates.

No problem to keep it on GitHub only, fee free to use the best approach you see fit.

[soareschen]

So it looks like we cannot really rely on starkli to interact with more complex contracts. I will work on the Hermes client so that we can use that instead to interact with the contracts we written.

[rnbguy]

Yes, looks like that. I added more instructions to transfer funds for ERC20 contracts. They work - but requires value serialization.

[rnbguy]

The type information is stored in the compiled .contract_class.json and it can be fetched from a starknet node.

The way I see, starkli should do something like grpcurl to (de)serialize the input and output values dynamically. grpcurl uses reflection to parse/format from/to JSON string to/from proto encoding.

[rnbguy]

There is a tool exactly for this --- cainome It's like protoc with tonic.

$ cargo install --features=build-binary --git https://github.com/cartridge-gg/cainome
$ mkdir codegen
$ cainome --output-dir gen --contract-name erc20 --execution-version v3 --contract-address 0x49D36570D4E46F48E99674BD3
FCC84644DDD6B96F7C741B1562B82F9E004DC7 --rpc-url http://127.0.0.1:5050 --rust 

[rnbguy]

I think that the document is a good position now. We can merge it. Let me know if it is better to break the README into multiple markdowns.

[soareschen]

Awesome, looks great! Let's merge it and move on to other work. Remember that this is mainly internal documentation for us to get started with the development more quickly. So we don't need to be too comprehensive.