Skip to content

Commit

Permalink
Update sig-provider, visualizer README.md (#887)
Browse files Browse the repository at this point in the history
* Update sig-provider readme

* Update visualizer readme
  • Loading branch information
rimrakhimov authored May 20, 2024
1 parent 56541f8 commit e46cce1
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 1 deletion.
43 changes: 43 additions & 0 deletions sig-provider/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# <h1 align="center"> Sig-provider </h1>

**Sig-provider** is a service that aggregates and decodes Ethereum signatures
for transactions and events from various sources.
Given a transaction input or an unparsed event,
it identifies possible decodings and parses the input accordingly.

Supported decoding sources include:

- [4byte directory](https://www.4byte.directory/)
- [Openchain signatures](https://openchain.xyz/signatures)
- [Ethereum bytecode database](https://docs.blockscout.com/about/features/ethereum-bytecode-database-microservice#solution-ethereum-bytecode-database-blockscout-ebd)

Sig-provider is used by Blockscout to display decoded transaction data
on transaction pages and to determine transaction actions.

## Requirements
No additional dependencies

## How to enable
Set the following ENVs on blockscout instance:
- `MICROSERVICE_SIG_PROVIDER_ENABLED=true`
- `MICROSERVICE_SIG_PROVIDER_URL={service_url}`

## Envs
Here, we describe variables specific to this service. Variables common to all services can be found [here](../docs/common-envs.md).

[anchor]: <> (anchors.envs.start)

| Variable | Required | Description | Default value |
|---------------------------------------------------|----------|----------------------------------------------------------------------|----------------------------------------------------|
| `SIG_PROVIDER__SOURCES__FOURBYTE` | | 4bytes directory HTTP URL | `https://www.4byte.directory/` |
| `SIG_PROVIDER__SOURCES__SIGETH` | | Openchain Signature Database HTTP URL | `https://sig.eth.samczsun.com/` |
| `SIG_PROVIDER__SOURCES__ETH_BYTECODE_DB__ENABLED` | | If enabled, will use ethereum bytecode database as one of data sources | `true` |
| `SIG_PROVIDER__SOURCES__ETH_BYTECODE_DB__URL` | | Ethereum bytecode database HTTP URL | `https://eth-bytecode-db.services.blockscout.com/` |

[anchor]: <> (anchors.envs.end)

## Links
- Demo - https://sig-provider.services.blockscout.com
- [Swagger](https://blockscout.github.io/swaggers/services/sig-provider/index.html)
- [Packages](https://github.com/blockscout/blockscout-rs/pkgs/container/sig-provider)
- [Releases](https://github.com/blockscout/blockscout-rs/releases?q=sig-provider&expanded=true)
28 changes: 27 additions & 1 deletion visualizer/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,27 @@
# Visualizer
A Rust service for generating Unified Modeling Language (UML) class diagrams and storage diagrams for Solidity contracts based on Node.js package
A service for generating Unified Modeling Language (UML) class diagrams and storage diagrams for Solidity contracts based on Node.js package
[sol2uml](https://github.com/naddison36/sol2uml).

## Requirements
- NodeJs environment with linked `sol2uml` binary (see [installation guide](https://github.com/naddison36/sol2uml?tab=readme-ov-file#install))

## How to enable
Set the following ENVs on blockscout instance:
- `MICROSERVICE_VISUALIZE_SOL2UML_ENABLED=true`
- `MICROSERVICE_VISUALIZE_SOL2UML_URL={service_url}`

## Envs
Here, we describe variables specific to this service. Variables common to all services can be found [here](../docs/common-envs.md).

[anchor]: <> (anchors.envs.start)

| Variable | Required | Description | Default value |
|---------------------------------------------------|----------|----------------------------------------------------------------------|----------------------------------------------------|

_* There are no service specific variables for the service_

[anchor]: <> (anchors.envs.end)

## Result Examples

### UML diagram
Expand Down Expand Up @@ -72,3 +92,9 @@ For testing on **Windows** you need to rewrite some code due to the way the serv
```let output = Command::new("cmd").arg("/C").arg("sol2uml").args(args).output().await?;```

`/C` should be replaced with the drive where sol2uml is installed.

## Links
- Demo - https://visualizer.services.blockscout.com
- [Swagger](https://blockscout.github.io/swaggers/services/visualizer/index.html)
- [Packages](https://github.com/blockscout/blockscout-rs/pkgs/container/visualizer)
- [Releases](https://github.com/blockscout/blockscout-rs/releases?q=visualizer&expanded=true)

0 comments on commit e46cce1

Please sign in to comment.