-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of gitlab.hoshogroup.com:company-projects/Meado…
…w into develop
- Loading branch information
Showing
1 changed file
with
113 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,150 @@ | ||
| # Meadow | ||
|
|
||
| An integrated Ethereum implementation and tool suite focused on Solidity testing and development. Written completely in cross-platform C# with .NET Core. Meadow can be used in [VS Code](https://code.visualstudio.com/), [Visual Studio](https://visualstudio.microsoft.com/vs/), and [JetBrains Rider](https://www.jetbrains.com/rider/). | ||
|
|
||
| [](https://teamcity.meadowsuite.com/viewLog.html?buildId=lastSuccessful&buildTypeId=Meadow_MeadowSuiteTest&tab=report_project2_Code_Coverage&guest=1) | ||
| [](https://coveralls.io/github/MeadowSuite/Meadow?branch=master) | ||
| [](https://codecov.io/gh/MeadowSuite/Meadow) | ||
| [](https://ci.appveyor.com/project/Meadow/meadow/branch/master) | ||
| [](https://gitter.im/MeadowSuite/Lobby) | ||
|
|
||
| | Platform | Build | | ||
| |----------|-------| | ||
| | Windows x64 | [](https://ci.appveyor.com/project/Meadow/meadow/branch/master) | | ||
| | Linux x64 | [](https://teamcity.meadowsuite.com/viewType.html?buildTypeId=Meadow_MeadowSuiteTest&guest=1) | | ||
| | MacOS x64 | [](https://travis-ci.com/MeadowSuite/Meadow) | | ||
|
|
||
| # Meadow | ||
|
|
||
| An Ethereum implementation geared towards Solidity testing and development. Written completely in cross-platform C# with .NET Core. Use may use Meadow in VSCode, Visual Studio, and JetBrains Rider. | ||
| <table> | ||
| <tr> | ||
| <td rowspan="2">Builds</td> | ||
| <td>Windows Status</td> | ||
| <td>Linux Status</td> | ||
| <td>MacOS Status</td> | ||
| </tr> | ||
| <tr> | ||
| <td><a href="https://ci.appveyor.com/project/Meadow/meadow/branch/master"><img src="https://ci.appveyor.com/api/projects/status/nauu7pmvu9q2b2xd/branch/master?svg=true"></a></td> | ||
| <td><a href="https://teamcity.meadowsuite.com/viewType.html?buildTypeId=Meadow_MeadowSuiteTest&guest=1"><img src="https://img.shields.io/teamcity/https/teamcity.meadowsuite.com/e/Meadow_MeadowSuiteTest.svg"></a></td> | ||
| <td><a href="https://travis-ci.com/MeadowSuite/Meadow"><img src="https://travis-ci.com/MeadowSuite/Meadow.svg?branch=master"></a></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Quick start / guides | ||
|
|
||
| #### Powerful Solidity contract development, deployment, and interaction | ||
| * [Writing unit tests](TODO) - getting started writing tests against Solidity contracts and generating code coverage reports. | ||
|
|
||
| <img src="/images/screenshot1.png?raw=true" width="700" /> | ||
| * [Using the CLI](src/Meadow.Cli/README.md) - contract deployment and interaction against testnode or production. | ||
|
|
||
| Provides an intuitive framework for writing C# tests against contract deployments and interactions. Includes a personal Ethereum test node that automatically is setup during test executions. | ||
| * [VSCode Solidity Debugger](TODO) | ||
|
|
||
| --- | ||
|
|
||
| #### Visibility into Solidity revert / exception call stacks | ||
| ## Powerful Solidity contract development, deployment, and interaction | ||
|
|
||
| <img src="/images/screenshot2.png?raw=true" width="700" /> | ||
| <img src="/images/screenshot1.png?raw=true" width="700" /> | ||
|
|
||
| --- | ||
| Provides an intuitive framework for writing C# to perform contract deployments, transactions, function calls, RPC requests, and more. Solidity source files are automatically compiled and exposed as C# classes with all contract methods, events, and natspec documentation. Includes a personal Ethereum test node that automatically is setup during test executions. | ||
|
|
||
| #### Solidity debugging with breakpoints, stepping, rewinding, variable inspection, et cetera | ||
| #### Visibility into Solidity revert / exception call stacks | ||
|
|
||
| <img src="/images/screenshot3.png?raw=true" width="800" /> | ||
| <img src="/images/screenshot2.png?raw=true" width="700" /> | ||
|
|
||
| See [Solidity Debugger](#solidity-debugger). | ||
| Better understanding and investigation of Solidity execution problems. | ||
|
|
||
| --- | ||
|
|
||
| #### Solidity unit test code coverage HTML reports | ||
| # Solidity Coverage Reports | ||
|
|
||
| <img src="/images/screenshot4.png?raw=true" width="600" /> | ||
|
|
||
| --- | ||
|
|
||
| ## Quick start / guides | ||
|
|
||
| * [Writing unit tests](TODO) - getting started writing tests against Solidity contracts and generating code coverage reports. | ||
|
|
||
| * [Using the CLI](src/Meadow.Cli/README.md) - contract deployment and interaction against testnode or production. | ||
|
|
||
| * [VSCode Solidity Debugger](TODO) | ||
| Perform thorough testing of Solidity codebases. Generate HTML and JSON code coverage reports showing .sol source code coverage for line, branch, and function execution. | ||
|
|
||
| --- | ||
|
|
||
| # Solidity Debugger | ||
|
|
||
| [](https://marketplace.visualstudio.com/items?itemName=hosho.solidity-debugger) | ||
|
|
||
| Solidity debugger extension for VSCode supporting beakpoints, stepping, rewinding, call stacks, local & state variable inspection. | ||
| <img src="/images/screenshot3.png?raw=true" width="800" /> | ||
|
|
||
| Solidity debugger extension for Visual Studio Code supporting beakpoints, stepping, rewinding, call stacks, local & state variable inspection. | ||
|
|
||
| --- | ||
|
|
||
| # Components | ||
|
|
||
| | Library | Package | | | ||
| |---------|-----------|-------------| | ||
| | [Meadow.EVM](src/Meadow.EVM) | [](https://www.nuget.org/packages/Meadow.EVM) | An Ethereum Virtual Machine that includes: <ul><li>Instructions/opcodes, calling conventions/messages/return values, memory/stack, logs/events, gas, charges/limits, precompiles, contract creation logic. <li>Core Ethereum components: account storage, transaction receipts, transaction pool, blocks, world state, snapshoting/reverting, chain, mining/consensus mechanism/scoring/difficulty/uncles. <li>Underlying dependencies: configuration/genesis block/fork/versioning/chain ID support, modified Merkle Patricia Trees, bloom filters, elliptic curve signing + public key recovery, Ethash, in-memory storage database.</ul> | | ||
| | [Meadow.TestNode](src/Meadow.TestNode) | [](https://www.nuget.org/packages/Meadow.TestNode) | Ethereum "personal blockchain" / "test node" / "RPC Server" / "Ethereum client". Ran as either a standalone server or via programmatic setup / teardown during unit test execution. Supports several non-standard RPC methods for debugging, testing, and coverage report generation. | | ||
| | [Meadow.SolCodeGen](src/Meadow.SolCodeGen) | [](https://www.nuget.org/packages/Meadow.SolCodeGen) | Tool that compiles Solidity source files and generates a C# class for each contract. All public methods and events in the contract ABI are translated to corresponding idiomatic C# methods and event log classes. Solidity NatSpec comments / docs are also translated to IntelliSense / code-completion tooltips. This nuget package can be simply added to a project and Solidity files in the project `contracts` directory are automatically compiled. | | ||
| | [Meadow.CoverageReport](src/Meadow.CoverageReport) | [](https://www.nuget.org/packages/Meadow.CoverageReport) | Generates HTML and JSON code coverage reports for Solidity source files. Uses execution trace data from the EVM. | | ||
| | [Meadow.UnitTestTemplate](src/Meadow.UnitTestTemplate) | [](https://www.nuget.org/packages/Meadow.UnitTestTemplate) | Test harness providing seamless integration between MSTest and Solidity contracts. Provides a simple workflow where Solidity source files are dropped into a unit test project and C# contract code is automatically generated. C# unit tests can easily deploy/call/transact with contracts. RPC test node servers & clients are automatically boostrapped and provided to unit tests. Code coverage reports are automatically generated after unit tests are ran. | | ||
| | [Meadow.Cli](src/Meadow.Cli) | [](https://www.nuget.org/packages/Meadow.Cli) | Tool that allows contract deployments and interaction through the command line. Solidity source files are live-compiled using a file system watcher. Can be ran against a automatically bootstrapped test RPC node or an externally configured node. Leverages PowerShell Core to a provide cross platform REPL-like environment with powerful tab-completion when interacting with contracts. | | ||
| | [Meadow.Core](src/Meadow.Core) | [](https://www.nuget.org/packages/Meadow.Core) | <ul><li>RLP and ABI encoding & decoding utils. <li>Implementations of Ethereum / solidity types such as Address, UInt256, Hash, etc. <li>BIP32, BIP39, BIP44, HD account derivation implementation. <li>Fast managed Keccak hashing. <li> ECDSA / secp256k1 utils.</ul> | | ||
| | [Meadow.JsonRpc](src/Meadow.JsonRpc) | [](https://www.nuget.org/packages/Meadow.JsonRpc) | <ul><li>.NET types for the Ethereum JSON-RPC request & response data structures. <li>.NET interface for all RPC methods. <li>Serialization for JSON/hex object formats <-> Solidity/.NET types.</ul> | | ||
| | [Meadow.JsonRpc.Client](src/Meadow.JsonRpc.Client) | [](https://www.nuget.org/packages/Meadow.JsonRpc.Client) | JSON-RPC client implementation, supported transports: http, WebSocket, and IPC. | | ||
| | [Meadow.JsonRpc.Server](src/Meadow.JsonRpc.Server) | [](https://www.nuget.org/packages/Meadow.JsonRpc.Server) | Fast and lightweight HTTP and WebSockets JSON-RPC server - using Kestrel and managed sockets. | | ||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Library</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td valign="top"> | ||
| <a href="/src/Meadow.EVM">Meadow.EVM</a><br><br> | ||
| <a href="https://www.nuget.org/packages/Meadow.EVM"><img src="https://img.shields.io/nuget/v/Meadow.EVM.svg?colorB=blue"/></a> | ||
| </td> | ||
| <td>An Ethereum Virtual Machine that includes: <ul><li>Instructions/opcodes, calling conventions/messages/return values, memory/stack, logs/events, gas, charges/limits, precompiles, contract creation logic. <li>Core Ethereum components: account storage, transaction receipts, transaction pool, blocks, world state, snapshoting/reverting, chain, mining/consensus mechanism/scoring/difficulty/uncles. <li>Underlying dependencies: configuration/genesis block/fork/versioning/chain ID support, modified Merkle Patricia Trees, bloom filters, elliptic curve signing + public key recovery, Ethash, in-memory storage database.</ul></td> | ||
| </tr> | ||
| <tr> | ||
| <td valign="top"> | ||
| <a href="/src/Meadow.TestNode">Meadow.TestNode</a><br><br> | ||
| <a href="https://www.nuget.org/packages/Meadow.TestNode"><img src="https://img.shields.io/nuget/v/Meadow.TestNode.svg?colorB=blue"></a> | ||
| </td> | ||
| <td>Ethereum "personal blockchain" / "test node" / "RPC Server" / "Ethereum client". Ran as either a standalone server or via programmatic setup / teardown during unit test execution. Supports several non-standard RPC methods for debugging, testing, and coverage report generation.</td> | ||
| </tr> | ||
| <tr> | ||
| <td valign="top"> | ||
| <a href="/src/Meadow.SolCodeGen">Meadow.SolCodeGen</a><br><br> | ||
| <a href="https://www.nuget.org/packages/Meadow.SolCodeGen"><img src="https://img.shields.io/nuget/v/Meadow.SolCodeGen.svg?colorB=blue"></a> | ||
| </td> | ||
| <td>Tool that compiles Solidity source files and generates a C# class for each contract. All public methods and events in the contract ABI are translated to corresponding idiomatic C# methods and event log classes. Solidity NatSpec comments / docs are also translated to IntelliSense / code-completion tooltips. This nuget package can be simply added to a project and Solidity files in the project <code>contracts</code> directory are automatically compiled.</td> | ||
| </tr> | ||
| <tr> | ||
| <td valign="top"> | ||
| <a href="/src/Meadow.CoverageReport">Meadow.CoverageReport</a><br><br> | ||
| <a href="https://www.nuget.org/packages/Meadow.CoverageReport"><img src="https://img.shields.io/nuget/v/Meadow.CoverageReport.svg?colorB=blue"></a> | ||
| </td> | ||
| <td>Generates HTML and JSON code coverage reports for Solidity source files. Uses execution trace data from the EVM.</td> | ||
| </tr> | ||
| <tr> | ||
| <td valign="top"> | ||
| <a href="/src/Meadow.UnitTestTemplate">Meadow.UnitTestTemplate</a><br><br> | ||
| <a href="https://www.nuget.org/packages/Meadow.UnitTestTemplate"><img src="https://img.shields.io/nuget/v/Meadow.UnitTestTemplate.svg?colorB=blue"></a> | ||
| </td> | ||
| <td>Test harness providing seamless integration between MSTest and Solidity contracts. Provides a simple workflow where Solidity source files are dropped into a unit test project and C# contract code is automatically generated. C# unit tests can easily deploy/call/transact with contracts. RPC test node servers & clients are automatically boostrapped and provided to unit tests. Code coverage reports are automatically generated after unit tests are ran.</td> | ||
| </tr> | ||
| <tr> | ||
| <td valign="top"> | ||
| <a href="/src/Meadow.Cli">Meadow.Cli</a><br><br> | ||
| <a href="https://www.nuget.org/packages/Meadow.Cli"><img src="https://img.shields.io/nuget/v/Meadow.Cli.svg?colorB=blue"></a> | ||
| </td> | ||
| <td>Tool that allows contract deployments and interaction through the command line. Solidity source files are live-compiled using a file system watcher. Can be ran against a automatically bootstrapped test RPC node or an externally configured node. Leverages PowerShell Core to a provide cross platform REPL-like environment with powerful tab-completion when interacting with contracts.</td> | ||
| </tr> | ||
| <tr> | ||
| <td valign="top"> | ||
| <a href="/src/Meadow.Core">Meadow.Core</a><br><br> | ||
| <a href="https://www.nuget.org/packages/Meadow.Core"><img src="https://img.shields.io/nuget/v/Meadow.Core.svg?colorB=blue"></a> | ||
| </td> | ||
| <td><ul><li>RLP and ABI encoding & decoding utils. <li>Implementations of Ethereum / solidity types such as Address, UInt256, Hash, etc. <li>BIP32, BIP39, BIP44, HD account derivation implementation. <li>Fast managed Keccak hashing. <li> ECDSA / secp256k1 utils.</ul></td> | ||
| </tr> | ||
| <tr> | ||
| <td valign="top"> | ||
| <a href="/src/Meadow.JsonRpc">Meadow.JsonRpc</a><br><br> | ||
| <a href="https://www.nuget.org/packages/Meadow.JsonRpc"><img src="https://img.shields.io/nuget/v/Meadow.JsonRpc.svg?colorB=blue"></a> | ||
| </td> | ||
| <td><ul><li>.NET types for the Ethereum JSON-RPC request & response data structures. <li>.NET interface for all RPC methods. <li>Serialization for JSON/hex object formats <-> Solidity/.NET types.</ul></td> | ||
| </tr> | ||
| <tr> | ||
| <td valign="top"> | ||
| <a href="/src/Meadow.JsonRpc.Client">Meadow.JsonRpc.Client</a><br><br> | ||
| <a href="https://www.nuget.org/packages/Meadow.JsonRpc.Client"><img src="https://img.shields.io/nuget/v/Meadow.JsonRpc.Client.svg?colorB=blue"></a> | ||
| </td> | ||
| <td>JSON-RPC client implementation, supported transports: http, WebSocket, and IPC.</td> | ||
| </tr> | ||
| <tr> | ||
| <td valign="top"> | ||
| <a href="/src/Meadow.JsonRpc.Server">Meadow.JsonRpc.Server</a><br><br> | ||
| <a href="https://www.nuget.org/packages/Meadow.JsonRpc.Server"><img src="https://img.shields.io/nuget/v/Meadow.JsonRpc.Server.svg?colorB=blue"></a> | ||
| </td> | ||
| <td>Fast and lightweight HTTP and WebSockets JSON-RPC server - using Kestrel and managed sockets.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|