Added installation section

invariant-labs · Dec 14, 2023 · a266096 · a266096
1 parent c140b2b
commit a266096
Show file tree

Hide file tree

Showing 3 changed files with 88 additions and 14 deletions.
diff --git a/docs/docs/casper/installation.md b/docs/docs/casper/installation.md
@@ -0,0 +1,51 @@
+---
+title: Installation
+
+slug: /casper/installation
+---
+
+This section provides detailed instructions on how to install the Invariant protocol on Casper, including prerequisites and steps for setting up the development environment.
+
+## Prerequisites
+
+- Rust & Cargo ([rustup](https://www.rust-lang.org/tools/install))
+- wasm-strip ([wabt](https://github.com/WebAssembly/wabt))
+- cargo-odra ([cargo-odra](https://github.com/odradev/cargo-odra))
+
+### Rust & Cargo
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+### wasm-strip
+
+```bash
+sudo apt install wabt
+```
+
+### cargo-odra
+
+```bash
+cargo install cargo-odra --locked
+```
+
+## Build protocol
+
+- Clone repository
+
+```
+git clone [email protected]:invariant-labs/protocol-cspr.git
+```
+
+- Build contract
+
+```
+cargo odra build -b casper
+```
+
+- Run tests
+
+```
+cargo odra test
+```
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -25,7 +25,8 @@ module.exports = {
       },
       items: [
         { to: '/docs/solana/introduction', label: 'Solana', position: 'left' },
-        { to: '/docs/aleph_zero/installation', label: 'Aleph Zero', position: 'left' }
+        { to: '/docs/aleph_zero/installation', label: 'Aleph Zero', position: 'left' },
+        { to: '/docs/casper/installation', label: 'Casper', position: 'left' }
       ]
     },
     footer: {
@@ -95,28 +96,35 @@ module.exports = {
       '@docusaurus/plugin-client-redirects',
       {
         fromExtensions: ['html'],
-        toExtensions: ['html'], 
+        toExtensions: ['html'],
         redirects: [
           {
             from: '/docs/aleph_zero/',
-            to: '/docs/aleph_zero/installation',
+            to: '/docs/aleph_zero/installation'
           },
           {
             from: '/docs/solana/',
-            to: '/docs/solana/introduction',
+            to: '/docs/solana/introduction'
           },
+          {
+            from: '/docs/casper/',
+            to: '/docs/casper/installation'
+          }
         ],
         createRedirects(existingPath) {
-          if(existingPath === "/docs/aleph_zero/" ) { 
-            return "/docs/aleph_zero/installation";
+          if (existingPath === '/docs/aleph_zero/') {
+            return '/docs/aleph_zero/installation'
+          }
+          if (existingPath === '/docs/solana/') {
+            return '/docs/solana/introduction'
           }
-          if (existingPath === "/docs/solana/") {
-            return '/docs/solana/introduction';
+          if (existingPath === '/docs/casper/') {
+            return '/docs/casper/installation'
           }
           // Path does not require a redirect.
-          return undefined;
-        },
-      },
-    ],
-  ],
+          return undefined
+        }
+      }
+    ]
+  ]
 }
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -63,7 +63,22 @@ module.exports = {
       type: 'category',
       label: 'Aleph Zero',
       collapsed: true,
-      items: ['aleph_zero/installation', 'aleph_zero/overview', 'aleph_zero/types', 'aleph_zero/storage', 'aleph_zero/collections', 'aleph_zero/entrypoints', 'aleph_zero/listing_pool_to_azero', 'aleph_zero/invariant_errors',]
+      items: [
+        'aleph_zero/installation',
+        'aleph_zero/overview',
+        'aleph_zero/types',
+        'aleph_zero/storage',
+        'aleph_zero/collections',
+        'aleph_zero/entrypoints',
+        'aleph_zero/listing_pool_to_azero',
+        'aleph_zero/invariant_errors'
+      ]
+    },
+    {
+      type: 'category',
+      label: 'Casper',
+      collapsed: true,
+      items: ['casper/installation']
     },
     'faq',
     'resources',