In Development

Atomicity WIP Stage: Alpha

Small, Abstract, Modular, and Modifiable EVM-Solidity scripting framework.

Aiming to support cross chain consensus code through building external compatible frameworks.

Currently testing with solidity v0.8.0 testing for other versions soon

Current Project Status:

Testnet contracts on Goerli
Modular via .env files
Using node web3js for abi encoding web3py for contract deploying and interacting and a little bit of cpp for basic framework generation commands.

Currently using linux filesystem calls by default

Set up your .env Variables (go to `basic_framework` and make a .env file)

Note: If you encounter a bug while using python-dotenv you can upgrade to the latest python currently 3.11

If you get another bug related web3 package ethereum/web3.py#2704 you can follow these steps: `vim ~/.local/lib/python3.11/site-packages/parsimonious/expressions.py` and change getargspec import line to say: `from inspect import getfullargspec` These two bugs are like a sandwich between python versions placing our framework in the middle of it, so far so good though.

GoerliSenderAddr="YourPublicAddress"

GoerliPrivKey="YourPrivateKey"

Goerli="YourRPCEndpoint"

alchemy, infura, quicknode, etc...

GoerliID=5

chainID

GoerliScan="https://api-goerli.etherscan.io/api"

block explorer api link for goerli

EtherscanAPIKey="YourAPIKey"

generic API key for any etherscan based block explorer

CurrentChain="Goerli"

VerifyBlockExplorer="True"

set whether or not to verify the contract

SolidityCompilerVersion="0.8.0"

Verifying contracts only works on Goerli atm due to logic that selects the chain, will extend to all available chains

Basic Usage:

After .env variables are set up, run new_frame ContractName and replace ContractName with the name of your contract.

This will attempt to make a new folder within the current Directory named after your ContractName as long as you are not signed in as super user / root it will warn you if it tries to overwrite a folder. BE CAREFUL not to overwrite anything you need using this command, reccomended not to use it in super user / root for this reason.

NOTE: If you have constructor parameters use the flag `-CA` followed by the number of parameters, and then one argument for each parameter. You must provide these in a way that will convert to proper python format. For example String: `\"String\"` Bool: `True` or `False`. Addresses must be provided like strings, note they use escape character `\` to maintain the quotation marks while being processed as an argument.

NOTE: If you have multiple contract files that you need to compile all together, use the `-M` flag. You can use `-M` or `-CA` iterchangably provided you give all the correct follow-up parameters if using `-CA` this format should follow for future arguments. The `-M` flag will now automatically fill the config.json for solidity-flattener for you and deploy.py will flatten right before the compilation!

cd to the newly created folder named after the ContractName argument you just chose.

Write your contract in the /contracts folder. Note that we have not tested contracts using libraries yet only multi and single file contracts.

Finally run deploy.sh (python3 py/deploy.py)

If your rpc gives gas estimation issues it's because were calling `rpc.eth.gas_price` and sometimes this can be innacurate enough to revert the transaction. Increase the `gasMod` variable on line 19 of deploy.py to multiply the gas price by the desired amount.

Feel free to change the equation to raise gas for your own needs, and ONLY use any real-live-mainnet gas tokens AT YOUR OWN RISK! Testnet First!

Ofcourse it's expected that occasionally you won't know if you need Multiple Contract Files or Constructor Arguments before you set up your contract.

In that case you can easily manually add the content for these features. For Multiple Files make sure `MultiFile="True"` in the project's .env file.

After that change the directory in solidity-flattener/config.json to match the directory of your project. If you have Constructor Arguments then make sure `ConstructorArgs="True"` in your project's .env file. Then create a list within the global scope of the project's py/deploy.py file that looks something like `constructorParamVals = ["myConstructorParamArg"]` fill the list with your constructor arguments in the order you want to call them.

With those tweaks you will be able to modify the state of the framework interpreter after you've already started working on the project. We plan to add some commands to help automate this post processing so people dont have to modify the python code or their .envs manually.

dzyphr/Atomicity