Skip to content

Commit

Permalink
rm title case
Browse files Browse the repository at this point in the history
  • Loading branch information
ihordiachenko committed Feb 2, 2024
1 parent 90746fc commit 085c6f9
Show file tree
Hide file tree
Showing 10 changed files with 23 additions and 23 deletions.
4 changes: 2 additions & 2 deletions docs/ecosystem/polygon-id-state-replication/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---

# API Reference
# API reference

This page contains technical resources related to the [Polygon ID State Replication](/ecosystem/polygon-id-state-replication).

Expand All @@ -11,7 +11,7 @@ Users can check out how the state replication works using our demo DApp. Leverag

Testnet(Sepolia): https://polygon.mainnet-beta.rarimo.com/

## Identity Relayer
## Identity relayer

This service replicates GIST roots and identity states on demand.
Call it before submitting proof on the destination chain.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
---
description: Learn how to set up Polygon ID State Replication for cross-chain identity state transfer.
---

# Guide: How to Set Up Polygon ID State Replication
# Guide: How to set up Polygon ID State Replication

In this guide, we'll set up the cross-chain identity state replication for Polygon ID. It enables the usage of Polygon ID zero-knowledge proofs on any chain supported by Rarimo.

For more information about how the Polygon ID identity state transfer works, visit [rarimo-core docs](https://github.com/rarimo/rarimo-core/blob/master/docs/common/bridging/002-identity.md).

## Pre-Requisites
## Pre-requisites

Before getting started, please contact us in [discord](https://discordapp.com/invite/rarimoprotocol) to ensure that the issuer is added to the allowlist and that a lightweight state contract is already deployed to the destination chain;

Expand All @@ -16,7 +17,7 @@ Other pre-requisites:
- [Postgres DB 13+](https://www.postgresql.org/download/) instance for the relayer service;
- [Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) (optional)

## Setting Up Relayer
## Setting up relayer

The Relayer service is responsible for replicating the Polygon ID state on demand. It exposes a REST endpoint for the DApps that performs the state replication to the target chain.

Expand Down Expand Up @@ -91,7 +92,7 @@ relay:

## Run

### Binary Built From Source
### Binary built from source

```sh
# apply DB migrations and run the service
Expand Down Expand Up @@ -140,7 +141,7 @@ relay:
docker-compose up
```

## Using Service
## Using service

Execute the POST `/integrations/relayer/relay` request with the following body to fetch state publishing:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Smart Contracts Reference
# Smart contracts reference

<!-- TODO: Add mainnet contracts addresses -->

Expand Down
2 changes: 1 addition & 1 deletion docs/products/bridging-protocol/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---

# API Reference
# API reference

The Rarimo SDK checkout packages provide tools to send transactions to blockchains.

Expand Down
6 changes: 3 additions & 3 deletions docs/products/bridging-protocol/circle-cctp-integration.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
---

# Circle CCTP Integration
# Circle CCTP integration

## NFT Checkout
## NFT checkout

If a user holds tokens on one chain and an NFT is for sale on another chain, there is no easy way for the user to purchase the NFT with those tokens.

Expand All @@ -15,7 +15,7 @@ Such apps usually suffer from liquidity problems as they need to manage liquidit

![flow](/img/USDC-NFT-Checkout.png)

## Cross-chain Transfer Protocol for Rarimo Identity
## Cross-Chain Transfer Protocol for Rarimo Identity

Rarimo is a protocol that allows users to use their identity cross-chain. That means that user can prove their identity in any DApp on any chain connected to Rarimo Protocol. Rarimo allows identity providers to publish ZK identity states. These states are used to verify identity on-chain. Rarimo Protocol synchronizes these states between chains so identity proofs can be verified cross-chain.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---

# Guide: How to Bundle Transactions
# Guide: How to bundle EVM transactions

Rarimo's multichain protocol bundles multiple related events into single contract calls or transactions.
In this way, the protocol simplifies complex, multistep user actions.
Expand Down
4 changes: 2 additions & 2 deletions docs/products/bridging-protocol/js-sdk-reference.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
---

# JS-SDK Reference
# JS-SDK reference

Rarimo's JavaScript/TypeScript SDK provides tools to interact with browser-based wallets and send transactions from wallets to Rarimo's contracts.
Rarimo's JavaScript SDK provides tools to interact with browser-based wallets and send transactions from wallets to Rarimo's contracts.

For complete reference information about the SDK packages, see the [SDK reference](https://rarimo.github.io/js-sdk/index.html).

Expand Down
12 changes: 6 additions & 6 deletions docs/products/bridging-protocol/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,25 @@ Let's look at the inner workings of the protocol in a real-world example: a user

![Bridging Flow](/img/bridging-flow.png)

## Protocol Features
## Protocol features

### Relayer Service
### Relayer service

The relayer automatically delivers the transfers to the destination chain. This way, users do not need to switch networks, sign additional transactions, and bother with funds to pay the gas fee on the destination chain.

### EVM Transaction Bundling
### EVM transaction bundling

To support more complex flows on EVM chains, the protocol allows bundling one or more custom transactions into the transfer. Once the transfer is completed, these transactions will be executed on the destination chain. For example, a user can transfer funds and place an order on an NFT marketplace on the destination chain using a single transaction.

### Low Fees
### Low fees

Thanks to the usage of the TSS for securing the transfers, the gas fee overhead for bridging on the destination chain is minimal.

<!-- TODO: add figures -->

Rarimo takes a fixed fee for every transfer in a token of choice. The price is negotiable.

### USDC Liquidity
### USDC liquidity

:::info

Expand All @@ -48,7 +48,7 @@ Coming Soon!

Rarimo has integrated the [Circle CCTP protocol](https://www.circle.com/en/cross-chain-transfer-protocol) to move USDC tokens between the chains without needing liquidity pools.

## Token-Agnostic Payments Widget
## Token-Agnostic Payments widget

With Rarimo's token-agnostic payments, customers can consolidate funds from multiple chains and in various tokens to make payments with just a few clicks. The system handles the token swaps and bridging.

Expand Down
1 change: 0 additions & 1 deletion docs/products/bridging-protocol/resources.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/products/identity-protocol/js-sdk-reference.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---

# JS-SDK Reference
# JS-SDK reference

The Rarimo SDK identity packages provide tools for the identity protocol.

Expand Down

0 comments on commit 085c6f9

Please sign in to comment.