Skip to content

Commit 4490f3f

Browse files
Merge pull request #135 from multiversx/readme-07-10
Update readme, add badges
2 parents 7573686 + 43261e1 commit 4490f3f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
# Rosetta API for MultiversX
22

3+
[![CodeQL](https://github.com/multiversx/mx-chain-rosetta/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/multiversx/mx-chain-rosetta/actions/workflows/codeql-analysis.yml)
4+
[![Go](https://github.com/multiversx/mx-chain-rosetta/actions/workflows/pr-build.yml/badge.svg)](https://github.com/multiversx/mx-chain-rosetta/actions/workflows/pr-build.yml)
5+
[![codecov](https://codecov.io/gh/multiversx/mx-chain-rosetta/graph/badge.svg?token=JKUHPTDPJ9)](https://codecov.io/gh/multiversx/mx-chain-rosetta)
6+
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/multiversx/mx-chain-rosetta)
7+
38
## Overview
49

510
**MultiversX runs on a sharded architecture** - transaction, data and network sharding are leveraged.
611

712
In the Rosetta implementation, we've decided to provide a single-shard perspective to the API consumer. That is, **one Rosetta instance** would observe **a single _regular_ shard** of the network - the shard is selected by the owner of the instance.
813

9-
Currently, the Rosetta implementation only supports the native currency (EGLD), while custom currencies ([ESDTs](https://docs.multiversx.com/tokens/esdt-tokens)) will be supported in the near future. At that point, Rosetta would observe the _metachain_, as well.
14+
The implementation supports both the native currency (EGLD) and custom fungible currencies - [ESDTs](https://docs.multiversx.com/tokens/esdt-tokens).
1015

1116
## Docker setup
1217

@@ -226,7 +231,7 @@ oldest_block_identifier = first block of oldest_epoch
226231

227232
## Implementation validation
228233

229-
In order to validate the Rosetta implementation using `mesh-cli`, please follow [MultiversX/rosetta-checks](https://github.com/multiversx/mx-chain-rosetta-checks).
234+
In order to validate the Rosetta implementation using `mesh-cli`, follow [multiversx/mx-chain-rosetta-checks](https://github.com/multiversx/mx-chain-rosetta-checks) or the **system tests** section (below).
230235

231236
## System tests
232237

@@ -255,7 +260,7 @@ Run the checks:
255260
PYTHONPATH=. python3 ./systemtests/check_with_mesh_cli.py --mode=data --network=testnet --shard=0
256261
```
257262

258-
# Or, continuously:
263+
Or, continuously:
259264

260265
```
261266
while PYTHONPATH=. python3 ./systemtests/check_with_mesh_cli.py --mode=data --network=testnet --shard=0; do sleep 5; done

0 commit comments

Comments
 (0)