Skip to content

Commit

Permalink
fixed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
olegfomenko committed Oct 5, 2023
1 parent 6b20942 commit f0940c4
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 15 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

## Introduction

**rarimocore** is a blockchain built using Cosmos SDK and Tendermint and created with [Ignite CLI](https://ignite.com/cli).
**rarimo-core** is a blockchain built using Cosmos SDK and Tendermint and created with [Ignite CLI](https://ignite.com/cli).

Based on Tendermint + Cosmos SDK blockchain core the main goal is to provide validated information about different cross-chain operations.

Documentation:
* [Rarimo core modules business logic](./x/README.md)
* [Bridge contract architecture](./docs/common/contracts/001-contracts.md)
* [Bridging flow overview](./docs/common/bridging/001-bridging.md)
* [Oracles atrcitecture overview](./docs/common/oracles/001-oracles.md)
* [Oracles architecture overview](./docs/common/oracles/001-oracles.md)

## Build

Expand Down
8 changes: 4 additions & 4 deletions docs/common/bridging/002-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Identity transfers currently implemented in the following way:
- There is an operation type `IDENTITY_DEFAULT_TRANSFER` that should be used to transfer simple state from one chain to another.

- An [evm-identity-oracle-svc](https://gitlab.com/rarimo/polygonid/evm-identity-saver-svc) exists, that is responsible
- An [evm-identity-oracle-svc](https://github.com/rarimo/evm-identity-saver-svc) exists, that is responsible
for delivering information from certain Iden3 state contract into the Rarimo chain.

- After delivering information about state update, oracles (`evm-identity-saver-svc`) vote for information correctness.
Expand Down Expand Up @@ -93,7 +93,7 @@ After fetching of some event, oracle will create the corresponding transaction a
After transaction appears in Rarimo blockchain all chain oracles have to vote for its correctness.
So they will fetch the information about state update from Rarimo chain, verify it and submit their votes (YES/NO answers).
For submitting transactions, savers (oracles) uses the [broadcaster-svc](https://gitlab.com/rarimo/broadcaster-svc).
For submitting transactions, savers (oracles) uses the [broadcaster-svc](https://github.com/rarimo/broadcaster-svc).
It accepts the transaction by GRPC endpoint, signs it with configured private key and submits it to the Rarimo chain.
The following configuration .yaml file should be provided to launch your broadcaster service:
Expand Down Expand Up @@ -130,7 +130,7 @@ version: "3.7"
services:

broadcaster:
image: registry.gitlab.com/rarimo/broadcaster-svc:v1.0.1
image: registry.github.com/rarimo/broadcaster-svc:v1.0.1
restart: unless-stopped
depends_on:
- broadcaster-db
Expand All @@ -152,7 +152,7 @@ services:
- broadcaster-data:/pgdata

evm-identity-saver:
image: registry.gitlab.com/rarimo/polygonid/evm-identity-saver-svc:v1.0.2
image: registry.github.com/rarimo/evm-identity-saver-svc:v1.0.2
restart: unless-stopped
depends_on:
- broadcaster
Expand Down
6 changes: 3 additions & 3 deletions docs/common/contracts/001-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Whenever possible, we made sure to maintain similar interface and signatures to

## Bridge & commissions

- Repo: [Solana Bridge Program](https://gitlab.com/rarimo/contracts/solana-bridge-program)
- Repo: [Near Bridge](https://gitlab.com/rarimo/contracts/near-bridge)
- Repo: [EVM Bridge](https://gitlab.com/rarimo/contracts/evm-bridge)
- Repo: [Solana Bridge Program](https://github.com/rarimo/contracts/solana-bridge-program)
- Repo: [Near Bridge](https://github.com/rarimo/contracts/near-bridge)
- Repo: [EVM Bridge](https://github.com/rarimo/contracts/evm-bridge)

Documentation:
* [Bridge architecture](./002-bridge.md)
Expand Down
10 changes: 5 additions & 5 deletions docs/common/oracles/001-oracles.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Oracles (Savers)

- Repo: [Saver Lib](https://gitlab.com/rarimo/savers/saver-grpc-lib)
- Repo: [EVM Saver](https://gitlab.com/rarimo/savers/evm-saver-svc)
- Repo: [Solana Saver](https://gitlab.com/rarimo/savers/solana-saver-svc)
- Repo: [Near Saver](https://gitlab.com/rarimo/savers/near-saver-svc)
- Repo: [Saver Lib](https://github.com/rarimo/saver-grpc-lib)
- Repo: [EVM Saver](https://github.com/rarimo/evm-saver-svc)
- Repo: [Solana Saver](https://github.com/rarimo/solana-saver-svc)
- Repo: [Near Saver](https://github.com/rarimo/near-saver-svc)

Managing events' creation requires some special logic for every chain that will observe blockchain state for new events,
parse in accordance with chain rules, etc. Rarimo core can not fetch events data by itself because interaction with
Expand Down Expand Up @@ -63,7 +63,7 @@ Let's describe the flow more accurately:

## Library

In `gitlab.com/rarimo/savers/saver-grpc-lib` we defined the common utils for all oracles.
In `github.com/rarimo/saver-grpc-lib` we defined the common utils for all oracles.
Every oracle should implement `verifiers.TransferOperator` interface for every supported token type
and put that implementations into the `voter.Subscriber` and `voter.Catchupper` using `verifiers.TransferVerifier` wrapper.

Expand Down
3 changes: 2 additions & 1 deletion docs/common/oracles/002-running-identity-oracle.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,8 @@ profiler:
## Issuer information

state_contract_cfg:
issuer_id: "issuer id in decimal format"
issuer_id: ['', '']
disable_filtration: true
```
Also, some environment variables will be needed to run
Expand Down

0 comments on commit f0940c4

Please sign in to comment.