@mainsail/evm-contracts 0.0.1-evm.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,86 @@
1
+ # Mainsail - EVM Contracts
2
+
3
+ ![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)
4
+
5
+ ## Documentation
6
+
7
+ You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).
8
+
9
+ ### Foundry
10
+
11
+ **Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
12
+
13
+ Foundry consists of:
14
+
15
+ - **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
16
+ - **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
17
+ - **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
18
+ - **Chisel**: Fast, utilitarian, and verbose solidity REPL.
19
+
20
+ ### Documentation
21
+
22
+ https://book.getfoundry.sh/
23
+
24
+ ### Usage
25
+
26
+ #### Build
27
+
28
+ ```shell
29
+ $ forge build
30
+ ```
31
+
32
+ #### Test
33
+
34
+ ```shell
35
+ $ forge test
36
+ ```
37
+
38
+ #### Format
39
+
40
+ ```shell
41
+ $ forge fmt
42
+ ```
43
+
44
+ #### Gas Snapshots
45
+
46
+ ```shell
47
+ $ forge snapshot
48
+ ```
49
+
50
+ #### Anvil
51
+
52
+ ```shell
53
+ $ anvil
54
+ ```
55
+
56
+ #### Deploy
57
+
58
+ ```shell
59
+ $ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
60
+ ```
61
+
62
+ #### Cast
63
+
64
+ ```shell
65
+ $ cast <subcommand>
66
+ ```
67
+
68
+ #### Help
69
+
70
+ ```shell
71
+ $ forge --help
72
+ $ anvil --help
73
+ $ cast --help
74
+ ```
75
+
76
+ ## Security
77
+
78
+ If you discover a security vulnerability within this package, please send an e-mail to [security@ark.io](mailto:security@ark.io). All security vulnerabilities will be promptly addressed.
79
+
80
+ ## Credits
81
+
82
+ This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).
83
+
84
+ ## License
85
+
86
+ [GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)