https://github.com/blockchainsllc/piet

https://github.com/blockchainsllc/piet

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/blockchainsllc/piet
• Owner: blockchainsllc
• License: gpl-3.0
• Created: 2019-08-06T08:27:40.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T01:47:36.000Z (over 1 year ago)
• Last Synced: 2024-06-12T08:55:21.699Z (3 months ago)
• Language: JavaScript
• Size: 4.89 MB
• Stars: 109
• Watchers: 5
• Forks: 14
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Blockchains Piet

A tool helping to grasp solidity smart contract architectures.

[Live Demo](https://piet.blockchains.com/?container=examples%2Fexport1562664060589.piet.json)

**Warning:** Piet has not yet undergone in-depth testing and may contain serious bugs.

## Abstract

Piet is a web application providing support to understand smart contract architectures. 

This is approached by generating a graphical representation of such architectures and a possibility to query deployed instances of smart contracts.

The graphical representation shows the inheritance structure of solidity contracts. In addition to the inheritance structure the defined enumerations and structs are shown.

To provide understanding of one single solidity contract Piet offers an inspector view showing all members of the contract including the inherited ones.

The presentation of the contract and the contract members is enriched by documentation labels derived from Ethereum NatSpec tags.

Piet also provides an interactive mode enabling to read the state of a smart contract, sending transactions and browsing through events. This is achieved by connecting to deployed smart contracts through an injected web3 object.  

## Feature List

- Graphical representation of smart contract architectures

  - Inheritance structure of contracts

  - Shows structs and enums

- Smart contract inspector

  - Shows structure of a smart contract (e.g. functions, events, ...)

  - Shows inherited members

  - Convenient representation of solidity code documentation

- Interactive Mode

  - Read state from blockchain (e.g. state variables, view functions) 

  - Send transactions

- Event browser

- NatSpec to Markdown documentation generator

- Node inspection via JSON RPC calls

- Transaction history view

- Code and ABI view

## Usage

Type `npm i` followed by `npm start` to start a local instance of Piet at [http://localhost:3001](http://localhost:3001 ) 

## Known Issues

- Some returned tuples may not be displayed correctly

- Two or more contracts with the identical name cannot be loaded

- The react component structure needs to be refactored