From aa5e4678c128d6a63805093acfab1aef244c1e8b Mon Sep 17 00:00:00 2001 From: Ihor Diachenko Date: Wed, 24 Jan 2024 18:50:21 +0200 Subject: [PATCH] More structure fixes --- .../rarimo-protocol/api-reference.mdx | 26 ----------- ...verview-of-use-cases.mdx => use-cases.mdx} | 4 -- docs/whitepaper.mdx | 44 ++++++------------- docs/whitepaper/abstract.mdx | 32 ++++++++++++++ sidebars.js | 5 ++- 5 files changed, 49 insertions(+), 62 deletions(-) rename docs/{use-cases/overview-of-use-cases.mdx => use-cases.mdx} (62%) create mode 100644 docs/whitepaper/abstract.mdx diff --git a/docs/products/rarimo-protocol/api-reference.mdx b/docs/products/rarimo-protocol/api-reference.mdx index 57f94285..4e470874 100644 --- a/docs/products/rarimo-protocol/api-reference.mdx +++ b/docs/products/rarimo-protocol/api-reference.mdx @@ -50,29 +50,3 @@ It is a gRPC endpoint to call cosmos modules. | Mainnet | https://core-api.mainnet.rarimo.com | | ------- | ---------------------------------------------- | | Testnet | https://core-api.node1.mainnet-beta.rarimo.com | - -## Proof of Humanity - -This section contains all Proof of Humanity-related endpoints. - -### KYC Service - -This service is responsible for the verification of users. - -GitHub: https://github.com/rarimo/kyc-service - - - -### Issuer - -This service issues verifiable credentials for verified users. - -GitHub: https://github.com/rarimo/issuer - - - -#### Endpoints - -| Mainnet | https://api.robotornot.rarimo.com | -| ------- | ---------------------------------------------- | -| Testnet | https://api.robotornot.mainnet-beta.rarimo.com | diff --git a/docs/use-cases/overview-of-use-cases.mdx b/docs/use-cases.mdx similarity index 62% rename from docs/use-cases/overview-of-use-cases.mdx rename to docs/use-cases.mdx index b0f998c2..d4965211 100644 --- a/docs/use-cases/overview-of-use-cases.mdx +++ b/docs/use-cases.mdx @@ -8,9 +8,7 @@ Learn about the use cases of Rarimo and check out the case studies of existing i ## Identity Use Cases -- [Proof of Humanity](/products/proof-of-humanity/overview) - [Self-Sovereign Identity(SSI)](/use-cases/self-sovereign-identities) -- [Polygon ID Cross-Chain State Replication](/products/polygon-id-state-replication/overview) - [Social Graphs](/use-cases/social-graphs) - [Gaming Profiles](/use-cases/gaming-profiles) - [SBT Ownership Proofs](/use-cases/cross-chain-proofs) @@ -18,6 +16,4 @@ Learn about the use cases of Rarimo and check out the case studies of existing i ## Bridging Use Cases -- [Token Agnostic Payments Widget](/products/token-agnostic-payments/overview) - [Multi-Chain Token Mints](/use-cases/multi-chain-mints) -- [Circle CCTP Integration for Managing USDC Liquidity](/products/bridging-protocol/circle-cctp-integration) diff --git a/docs/whitepaper.mdx b/docs/whitepaper.mdx index 74ee4819..c07b3c95 100644 --- a/docs/whitepaper.mdx +++ b/docs/whitepaper.mdx @@ -1,32 +1,16 @@ ---- ---- +# Whitepaper -# Abstract +## Table of contents -Many factors shape our identities; the communities we belong to, the activities we participate in, and the assets we -own. Web3 identities are no different. A user may hold identity artifacts such as an NFT that confers DAO membership, a -Soul-Bound Token (SBT) that certifies their university degree, and cryptographic proof that confirms their affiliations -in some social graph. Unlike in real life, however, web3 identities are not yet cohesive (with digital assets, the -situation is similar, but a wider list of protocols works on the problem). This is because the web3 ecosystem is -dispersed across multiple blockchains. For instance, a user’s DAO NFT may be issued on Ethereum, their University -Credential on Solana, and their social graph may be off-chain but reflecting interactions on a dApp on Polygon. While -many protocols bring interoperability to digital assets, none provide unique solutions to make digital identities and -their myriad components interoperable. - -Firstly, the various custom artifacts composing digital identities require bespoke solutions. Yet, it is also vital to -use them interchangeably and that the solutions meet certain standardizations. Secondly, privacy concerns require users -to reveal only specific aspects of their identity, like confirming residency without sharing their precise address. - -Rarimo is the only interoperability protocol that overcomes these challenges. It offers cross-chain identity, state, and -digital asset management across chains using embedded ZK proofs for privacy assurance. Rarimo allows: 1) transfer -(asset) and replicate (identity state) existing entity from its source chain to the needed or 2) create identity state -directly on Rarimo and propagate it to any point of web3 universe. - -**Rarimo**: As well as its identity-specific features, Rarimo has a range of characteristics that make it particularly -secure, seamless, and cost-effective as a general-use interoperability protocol. Firstly, using a Threshold Signature -Scheme (TSS), Rarimo provides high-security guarantees at a constant operation price. Secondly, its application layer -means developers can effortlessly integrate messaging contracts from existing dApps without building notable amounts of -custom, use-case-specific logic. Thirdly, Rarimo supports streamlined, single-click, single-transaction flows. Users can -perform complex, multi-chain activities with only a single click. Especially for identity cases, Rarimo uses a -zk-focused approach that allows using cryptographically secure credentials without revealing personal data on-chain, -making publishing identities easier and cheaper for identity providers. \ No newline at end of file +- [Abstract](/whitepaper/abstract) +- [Problem Statement](/whitepaper/problem_statement) +- [Protocol Vision](/whitepaper/protocol-vision) +- [Architecture and Operating Principles](/whitepaper/architecture-and-operating-principles) +- [Main Flow of Messages Transferring](/whitepaper/main-flow-of-messages-transferring) +- [Rarímo Identity Sub-Protocol](/whitepaper/rarimo-identity-sub-protocol) +- [Light Wallet Supporting](/whitepaper/light-wallet-supporting) +- [Security and Efficiency](/whitepaper/security-and-efficiency) +- [Utilities of the Token](/whitepaper/utilities-of-the-token) +- [Governance](/whitepaper/governance) +- [Summary](/whitepaper/summary) +- [Sources](/whitepaper/sources) diff --git a/docs/whitepaper/abstract.mdx b/docs/whitepaper/abstract.mdx new file mode 100644 index 00000000..74ee4819 --- /dev/null +++ b/docs/whitepaper/abstract.mdx @@ -0,0 +1,32 @@ +--- +--- + +# Abstract + +Many factors shape our identities; the communities we belong to, the activities we participate in, and the assets we +own. Web3 identities are no different. A user may hold identity artifacts such as an NFT that confers DAO membership, a +Soul-Bound Token (SBT) that certifies their university degree, and cryptographic proof that confirms their affiliations +in some social graph. Unlike in real life, however, web3 identities are not yet cohesive (with digital assets, the +situation is similar, but a wider list of protocols works on the problem). This is because the web3 ecosystem is +dispersed across multiple blockchains. For instance, a user’s DAO NFT may be issued on Ethereum, their University +Credential on Solana, and their social graph may be off-chain but reflecting interactions on a dApp on Polygon. While +many protocols bring interoperability to digital assets, none provide unique solutions to make digital identities and +their myriad components interoperable. + +Firstly, the various custom artifacts composing digital identities require bespoke solutions. Yet, it is also vital to +use them interchangeably and that the solutions meet certain standardizations. Secondly, privacy concerns require users +to reveal only specific aspects of their identity, like confirming residency without sharing their precise address. + +Rarimo is the only interoperability protocol that overcomes these challenges. It offers cross-chain identity, state, and +digital asset management across chains using embedded ZK proofs for privacy assurance. Rarimo allows: 1) transfer +(asset) and replicate (identity state) existing entity from its source chain to the needed or 2) create identity state +directly on Rarimo and propagate it to any point of web3 universe. + +**Rarimo**: As well as its identity-specific features, Rarimo has a range of characteristics that make it particularly +secure, seamless, and cost-effective as a general-use interoperability protocol. Firstly, using a Threshold Signature +Scheme (TSS), Rarimo provides high-security guarantees at a constant operation price. Secondly, its application layer +means developers can effortlessly integrate messaging contracts from existing dApps without building notable amounts of +custom, use-case-specific logic. Thirdly, Rarimo supports streamlined, single-click, single-transaction flows. Users can +perform complex, multi-chain activities with only a single click. Especially for identity cases, Rarimo uses a +zk-focused approach that allows using cryptographically secure credentials without revealing personal data on-chain, +making publishing identities easier and cheaper for identity providers. \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 2ab4fc6a..e794d519 100644 --- a/sidebars.js +++ b/sidebars.js @@ -8,9 +8,9 @@ const sidebars = { { type: 'category', label: 'Use Cases', + link: {type: 'doc', id: 'use-cases'}, collapsed: true, items: [ - 'use-cases/overview-of-use-cases', 'use-cases/gaming-profiles', 'use-cases/social-graphs', 'use-cases/multi-chain-mints', @@ -173,9 +173,10 @@ const sidebars = { { type: 'category', label: 'Whitepaper', + link: {type: 'doc', id: 'whitepaper'}, collapsed: true, items: [ - 'whitepaper', + 'whitepaper/abstract', 'whitepaper/problem_statement', 'whitepaper/protocol-vision', 'whitepaper/architecture-and-operating-principles',