added draft description for the vane-xcm pallet

docs/404.html

@@ -192,6 +192,22 @@ <h1 id="document-not-found-404"><a class="header" href="#document-not-found-404"
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/ch00-00-introduction.html

@@ -199,6 +199,22 @@ <h2 id="what-is-vane"><a class="header" href="#what-is-vane">what is Vane</a></h
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/ch01-00-getting-started.html

@@ -202,6 +202,22 @@ <h1 id="getting-started"><a class="header" href="#getting-started">Getting Start
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/ch01-01-components.html

@@ -202,6 +202,22 @@ <h1 id="components"><a class="header" href="#components">Components</a></h1>
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/ch01-02-01-vane-order.html

@@ -202,6 +202,22 @@ <h1 id="vane-order"><a class="header" href="#vane-order">Vane-Order</a></h1>
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/ch01-02-02-vane-payment.html

@@ -202,6 +202,22 @@ <h1 id="vane-payment"><a class="header" href="#vane-payment">Vane-Payment</a></h
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/ch01-02-03-vane-register.html

@@ -202,6 +202,22 @@ <h1 id="vane-register"><a class="header" href="#vane-register">Vane-Register</a>
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/ch01-02-04-vane-wallet-less.html

@@ -202,6 +202,22 @@ <h1 id="vane-wallet-less"><a class="header" href="#vane-wallet-less">Vane-Wallet
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/ch01-02-05-vane-xcm.html

@@ -172,6 +172,52 @@ <h1 class="menu-title">vane</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="vane-xcm"><a class="header" href="#vane-xcm">Vane-XCM</a></h1>
+<h2 id="pallet-calls"><a class="header" href="#pallet-calls">Pallet Calls</a></h2>
+<p>Certainly, let's go through the callable methods defined in the provided Rust code for the <code>Pallet</code> module in detail:</p>
+<ol>
+<li>
+<p><strong><code>vane_transfer</code></strong>:</p>
+<ul>
+<li><strong>Description</strong>:
+<ul>
+<li>This function is responsible for initiating a transfer from the caller's account to the specified recipient account.</li>
+<li>It first ensures that the caller has the proper authorization (through <code>ensure_signed</code>).</li>
+<li>Depending on the <code>currency</code> type currently we have <code>Token::Dot</code> and in future we will be supporting <code>Token::Usdt</code>, it performs specific actions.</li>
+<li>If <code>currency</code> is <code>Token::Dot</code>, it initiates an XCM (Cross-Chain Message) transfer.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<p><strong><code>vane_confirm</code></strong>:</p>
+<ul>
+<li><strong>Description</strong>:
+<ul>
+<li>This function is used for confirming a transfer initiated by another party.</li>
+<li>It checks the caller's authorization using <code>ensure_signed</code>.</li>
+<li>If the caller is the payer, it checks if the payee has already confirmed. If not, it adds the payer to the list of confirmed signers and performs various operations.</li>
+<li>Once the caller is the validated as payee, it adds the payee to the list of confirmed signers.</li>
+<li>It derives multi-identifiers for confirmed and allowed signers, ensuring they match.</li>
+<li>If the multi-identifiers match, it dispatches an XCM call for confirmation.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<p><strong><code>test_storing</code></strong>:</p>
+<ul>
+<li><strong>Description</strong>:
+<ul>
+<li>This function allows the caller to store a number associated with a specific account in a storage map.</li>
+<li>It ensures that the caller is authorized using <code>ensure_signed</code>.</li>
+<li>It stores the provided <code>num</code> associated with the provided <code>acc</code> in the <code>TestStorage</code> storage map.</li>
+<li>It emits an <code>Event::TestStored</code> event to signal that the storing operation was successful.</li>
+</ul>
+</li>
+</ul>
+</li>
+</ol>
+<p>These callable methods are part of the <code>Pallet</code> and provide functionality related to multi-signature transfers, confirmation of transfers, and a simple storage mechanism for testing purposes. Depending on the specific use case and configuration of your Substrate runtime, these methods may have different behavior or additional requirements.</p>
 
                     </main>
 
@@ -196,6 +242,22 @@ <h1 id="vane-xcm"><a class="header" href="#vane-xcm">Vane-XCM</a></h1>
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/ch01-02-pallets.html

@@ -202,6 +202,22 @@ <h1 id="pallets"><a class="header" href="#pallets">Pallets</a></h1>
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/index.html

@@ -199,6 +199,22 @@ <h2 id="what-is-vane"><a class="header" href="#what-is-vane">what is Vane</a></h
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>
 
 
 

docs/print.html

@@ -184,6 +184,52 @@ <h2 id="what-is-vane"><a class="header" href="#what-is-vane">what is Vane</a></h
 <div style="break-before: page; page-break-before: always;"></div><h1 id="vane-register"><a class="header" href="#vane-register">Vane-Register</a></h1>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="vane-wallet-less"><a class="header" href="#vane-wallet-less">Vane-Wallet-Less</a></h1>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="vane-xcm"><a class="header" href="#vane-xcm">Vane-XCM</a></h1>
+<h2 id="pallet-calls"><a class="header" href="#pallet-calls">Pallet Calls</a></h2>
+<p>Certainly, let's go through the callable methods defined in the provided Rust code for the <code>Pallet</code> module in detail:</p>
+<ol>
+<li>
+<p><strong><code>vane_transfer</code></strong>:</p>
+<ul>
+<li><strong>Description</strong>:
+<ul>
+<li>This function is responsible for initiating a transfer from the caller's account to the specified recipient account.</li>
+<li>It first ensures that the caller has the proper authorization (through <code>ensure_signed</code>).</li>
+<li>Depending on the <code>currency</code> type currently we have <code>Token::Dot</code> and in future we will be supporting <code>Token::Usdt</code>, it performs specific actions.</li>
+<li>If <code>currency</code> is <code>Token::Dot</code>, it initiates an XCM (Cross-Chain Message) transfer.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<p><strong><code>vane_confirm</code></strong>:</p>
+<ul>
+<li><strong>Description</strong>:
+<ul>
+<li>This function is used for confirming a transfer initiated by another party.</li>
+<li>It checks the caller's authorization using <code>ensure_signed</code>.</li>
+<li>If the caller is the payer, it checks if the payee has already confirmed. If not, it adds the payer to the list of confirmed signers and performs various operations.</li>
+<li>Once the caller is the validated as payee, it adds the payee to the list of confirmed signers.</li>
+<li>It derives multi-identifiers for confirmed and allowed signers, ensuring they match.</li>
+<li>If the multi-identifiers match, it dispatches an XCM call for confirmation.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<p><strong><code>test_storing</code></strong>:</p>
+<ul>
+<li><strong>Description</strong>:
+<ul>
+<li>This function allows the caller to store a number associated with a specific account in a storage map.</li>
+<li>It ensures that the caller is authorized using <code>ensure_signed</code>.</li>
+<li>It stores the provided <code>num</code> associated with the provided <code>acc</code> in the <code>TestStorage</code> storage map.</li>
+<li>It emits an <code>Event::TestStored</code> event to signal that the storing operation was successful.</li>
+</ul>
+</li>
+</ul>
+</li>
+</ol>
+<p>These callable methods are part of the <code>Pallet</code> and provide functionality related to multi-signature transfers, confirmation of transfers, and a simple storage mechanism for testing purposes. Depending on the specific use case and configuration of your Substrate runtime, these methods may have different behavior or additional requirements.</p>
 
                     </main>
 
@@ -202,6 +248,22 @@ <h2 id="what-is-vane"><a class="header" href="#what-is-vane">what is Vane</a></h
 
         </div>
 
+        <!-- Livereload script (if served using the cli tool) -->
+        <script>
+            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
+            const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
+            const socket = new WebSocket(wsAddress);
+            socket.onmessage = function (event) {
+                if (event.data === "reload") {
+                    socket.close();
+                    location.reload();
+                }
+            };
+
+            window.onbeforeunload = function() {
+                socket.close();
+            }
+        </script>