Merge pull request #24 from ideal-lab5/feat/docs

Feat/docs
ideal-lab5 · Oct 16, 2024 · 67b3b8f · 67b3b8f
2 parents fa8420d + 3b4badd
commit 67b3b8f
Show file tree

Hide file tree

Showing 126 changed files with 62,384 additions and 59 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/docs/murmur/.gitignore b/docs/murmur/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/docs/murmur/README.md b/docs/murmur/README.md
@@ -0,0 +1,43 @@
+# Murmur Docs
+
+This is the official documentation for the murmur protocol.
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/docs/murmur/assets/definition.png b/docs/murmur/assets/definition.png
diff --git a/docs/murmur/assets/discord_bot_in_action.png b/docs/murmur/assets/discord_bot_in_action.png
diff --git a/docs/murmur/assets/eye-crossed.svg b/docs/murmur/assets/eye-crossed.svg
diff --git a/docs/murmur/assets/idn_stack.drawio.png b/docs/murmur/assets/idn_stack.drawio.png
diff --git a/docs/murmur/assets/mmr_cli.png b/docs/murmur/assets/mmr_cli.png
diff --git a/docs/murmur/assets/murmur_connections.drawio(1).png b/docs/murmur/assets/murmur_connections.drawio(1).png
diff --git a/docs/murmur/assets/murmur_create.drawio.png b/docs/murmur/assets/murmur_create.drawio.png
diff --git a/docs/murmur/assets/murmur_execute.drawio.png b/docs/murmur/assets/murmur_execute.drawio.png
diff --git a/docs/murmur/assets/murmur_pallets.drawio.png b/docs/murmur/assets/murmur_pallets.drawio.png
diff --git a/docs/murmur/assets/murmur_seq_diagram.drawio.png b/docs/murmur/assets/murmur_seq_diagram.drawio.png
diff --git a/docs/murmur/assets/murmur_stack.drawio.png b/docs/murmur/assets/murmur_stack.drawio.png
diff --git a/docs/murmur/assets/x-platform.svg b/docs/murmur/assets/x-platform.svg
diff --git a/docs/murmur/babel.config.js b/docs/murmur/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/docs/murmur/docs/intro.md b/docs/murmur/docs/intro.md
@@ -0,0 +1,56 @@
+---
+sidebar_position: 1
+---
+
+# Murmur
+
+---
+Noun. *a low indistinct but often continuous sound*
+> The *murmur* of the waves along the shore
+> A *murmur* of voice
+
+---
+
+Murmur is a **keyless crypto wallet protocol** powered by the [Ideal Network](https://docs.idealabs.network) (IDN). Using **timelock encryption** and secure time-based [one-time password](https://www.techtarget.com/searchsecurity/definition/one-time-password-OTP) (OTP) generation, **murmur** allows users to create and execute secure crypto wallets with no mnemonic or secret key. Murmur allows users to access crypto wallets without needing a secret key or mnemonic - it is a truly keyless wallet solution.
+
+Murmur wallets can be accessed seamlessly across web-enabled devices, providing a plug-and-play solution for app developers to easily integrate web3 capabilities into applications and services with no additional infrastructure or overhead. Murmur wallets can be used by installing a **standalone wallet client** or by using our GDPR-compliant "MMR-as-a-Service" **HTTP API**, which allows you to easily create in-app wallets with seamless interoperability across browsers and other HTTP clients. 
+
+## Why Murmur?
+
+Crypto wallets and account abstraction come in a myriad of flavors, custodial, non-custodial, MPC, and various other "wallet-as-a-service" solutions. 
+
+Murmur offers a distinct alternative to tradition MPC wallets. Normally, MPC wallets require *wallet providers* to issue threshold signatures on command. This can present several challenges, such as:
+
+- **Scalability issues**: More users means more requests for signatures and more load on the network
+- **Increased Costs**: Users can encounter significant fees for higher security, essentially placing wallet security behind a paywall
+
+Murmur sidesteps these disadvantages by relying on the Ideal Network's [randomness beacon](https://docs.idealabs.network/docs/learn/etf-pfg) to produce decryption keys for future OTP codes. Rather than producing threshold signatures on-demand, threshold signatures are produced with each block finalized by the IDN. This results in a highly scalable, cost-efficient, and decentralized wallet solution, where more users does not correlate with added computational overhead.
+
+**Key Features**
+- **Truly Keyless Wallet**: No mnemonic or key management required.
+- **No Wallet Provider**: No reliance on a third-party provider for wallet access.
+- **Infinitely Scalable**: The Murmur protocol is designed to scale without increased computational or financial overhead, limited only by the underlying blockchain.
+- **Non-Custodial**: Users retain complete control of their wallets at all times. Even when opting for the convenience of HTTP-API-based access, only the heavy computational tasks are outsourced, ensuring full ownership remains with the user.
+- **Secure Against Key Extraction Attacks**: Unlike some threshold ECDSA approaches, Murmur uses threshold BLS signatures and is resistant to key extraction vulnerabilities (e.g. [research by zengo-x](https://eprint.iacr.org/2021/1621.pdf)).
+
+<!-- 
+| Attribute | Non-Custodial | Custodial | WaaS (e.g. [magic.link](magic.link)) | MPC | Murmur |
+|-------------------|--|--|--|--|--|
+| Scalability       | a|b|c|d|e|
+| Permissibility    | a| b|c|d|e| -->
+
+## Getting Started
+
+The murmur protocol is very flexible and can be used in various contexts, each with different trust models. Start [here](./learn/protocol.md) to learn more about the inner workings of the murmur protocol, or just jump into the code on [github](https://github.com/ideal-lab5/murmur).
+
+**From a Browser or JS app**
+Murmur can be used from any web-enabled javascript context by relying on the **murmur.js** library to communicate with the **murmur-api**, allowing for the creation and execution of in-app wallets. The [murmur-api](https://github.com/ideal-lab5/murmur-api) is a permissionless HTTP API that simply outsources the computation required to compute and encrypt OTP codes and merkle proofs. [Murmur.js](https://github.com/ideal-lab5/murmur.js) is a javascript library that lets developers easily integrate keyless crypto wallets into their applications. In conjunction with [polkadot.js](https://polkadot.js.org/docs/api), it developers can add a 'wallet-as-a-service' mechanism to their applications with minimal effort. 
+
+Check out the [browser integration guide](./quick_start/browser.md) to learn how to integrate murmur into your applications by communicating with the api. See out the library in action by exploring the [murmur-dapp](https://github.com/ideal-lab5/murmur-dapp/) and [murmur discord bot](https://github.com/ideal-lab5/murmur-discord-bot).
+
+**Standalone Client**
+You can also run the murmur wallet using a standalone client. Try the [cli](./quick_start/local.md) for a terminal based client that allows you to create a wallet and execute basic balance transfers.
+
+## Question?
+
+If you have questions about Murmur or the Ideal network, get in touch by [joining our discord channel](https://discord.gg/phZvQkzU2a).
diff --git a/docs/murmur/docs/learn/_category_.json b/docs/murmur/docs/learn/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Learn",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Deep-dive into the Murmur protocol"
+  }
+}