Skip to content

Commit

Permalink
Update vane-network.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MrishoLukamba authored Oct 25, 2023
1 parent c214dde commit 840b650
Showing 1 changed file with 4 additions and 22 deletions.
26 changes: 4 additions & 22 deletions applications/vane-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,16 +212,7 @@ Please also provide the GitHub accounts of all team members. If they contain no
| **0c.** | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. |
| **0d.** | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
| 0e. | Video tutorial | We will publish an workshop on X/Twitter that explains what was done/achieved as part of the grant and how the product should be used and invite one user to try out the feature implemented and get the impression |
| 1. | vane_relay_asset |The pallet_vane_relay_asset will have the following unique feature implementation.|
| | | **Vane token abstraction for fees handling**
| | |This functionality will enable users of vane-network solution to just use their existing DOT, USDT, USDC tokens and not being introduced with any foreign native token. This will improve UX and enable more people to use the solution.
| | | This pallet will interact with pallet_alances to handle fees,token depositing and withdrawing based on deposited balance in the relay chain vane para account.
| | | Pallet balances native token will not be liquid to end users as the required amount of fees to handle DOS attack will be handled automatically after the initialization of transaction. Hence token abstraction and native token-less approach as for now.
| | | **Map only supported asset**
| | |This functionality will enable existing users to transfer their DOT, USDT, USDC tokens only in a risk free system with confirmation and reversibility of the transaction. This functionality will interact with the following traits, EnsureOriginWithArg, MultiCurrencyAsset, ContainsPair. The multilocations which will be allowed and handled are, {parent:1,parachain:1000}, {parent:0, Here}.
| | | **On Deposit & OnConfirmed trait introduction and implementation**
| | | On Deposit - This trait will handle creation of Multi-Signature account and depositing of funds to the multi-id. It will interact with TransactAsset to handle this implementation on XCM message execution ( DepositReserveAssets).
| | | OnConfirmed - This trait will handle the submission of custom XCM messages to relay chain/assethub for transaction asset to the beneficiary post confirmation, updating transactionStatus to handle failed transaction claims later if anything goes wrong on the delivery of XCM message.
| 1. | vane_relay_asset |The pallet_vane_relay_asset will have the following unique feature implementation.<br><br> **Vane token abstraction for fees handling**<br><br>This functionality will enable users of vane-network solution to just use their existing DOT, USDT, USDC tokens and not being introduced with any foreign native token. This will improve UX and enable more people to use the solution.<br><br> This pallet will interact with pallet_alances to handle fees,token depositing and withdrawing based on deposited balance in the relay chain vane para account.<br> Pallet balances native token will not be liquid to end users as the required amount of fees to handle DOS attack will be handled automatically after the initialization of transaction. Hence token abstraction and native token-less approach as for now.<br><br> **Map only supported asset**<br>This functionality will enable existing users to transfer their DOT, USDT, USDC tokens only in a risk free system with confirmation and reversibility of the transaction. This functionality will interact with the following traits, EnsureOriginWithArg, MultiCurrencyAsset, ContainsPair. The multilocations which will be allowed and handled are, {parent:1,parachain:1000}, {parent:0, Here}.<br><br>**On Deposit & OnConfirmed trait introduction and implementation**<br>On Deposit - This trait will handle creation of Multi-Signature account and depositing of funds to the multi-id. It will interact with TransactAsset to handle this implementation on XCM message execution ( DepositReserveAssets).<br>OnConfirmed - This trait will handle the submission of custom XCM messages to relay chain/assethub for transaction asset to the beneficiary post confirmation, updating transactionStatus to handle failed transaction claims later if anything goes wrong on the delivery of XCM message.<br>
| 2. | Backend (Nest JS) | All chain ( vane, polkadot/rococo, assethub) api interaction implementation, wallet-less signin ( for easier onboarding users for testing the prodduct) not production ready |
| 3. | FrontEnd | A front end prototype in Figma, A front end interaction for implemented feature hosted in vercel which will be only for wide screen ( no responsiveness ) as later on (not this grant ) we will implement a mobile application |

Expand All @@ -247,16 +238,8 @@ Please also provide the GitHub accounts of all team members. If they contain no
| **0c.** | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. |
| **0d.** | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
| 0e. | Video tutorial | We will publish an workshop on X/Twitter that explains [...] (what was done/achieved as part of the grant and how the product should be used) |
| 1. | Transaction Delivery Tracking System | As vane-risk free transfer system involves the following parts,
| | | relay_chain xcm reserveTransfer to Vane, confirmation of sender and receiver's address,
| | | sending xcm instructions to relay/assethub for transacting asset from vane para account to receiver.
| | | The following are notable issues which may arrive; Filure to deliver and execute XCM message to vane, and relay/assethub.
| | | A tracking of where the transaction stuck is essential and will be implemented as an enum and
| | | stored in transaction tracking storage with key of multi_id.|
| | | The updating will be based on queries of effect of what the transaction is supposed to do using XCM.|
| 2. | Pallet Transaction Claim |This pallet will be used to resolve stuck transaction based on the delivery tracking data stored.
| | |The resolving includes, claiming back the funds and finishing the transaction (sending to beneficiary).
| | |Mechanism of resolving is handled on OnInitialize block hook. The claimer submits a structured struct claim with neccessary claims and intention. The resolving function will check the truth of the claim by asserting on the specific transaction desired outcome. |
| 1. | Transaction Delivery Tracking System | As vane-risk free transfer system involves the following parts.<br> Relay_chain xcm reserveTransfer to Vane, confirmation of sender and receiver's address,sending xcm instructions to relay/assethub for transacting asset from vane para account to receiver.<br> The following are notable issues which may arrive; Failure to deliver and execute XCM message to vane, and relay/assethub.<br><br> A tracking functionality of where the transaction stuck is essential and will be implemented as a struct of an enum and stored in transaction tracking storage with key of multi_id.<br> The updating will be based on queries of effect of what the transaction is supposed to do using XCM.<br>|
| 2. | Pallet Transaction Claim |This pallet will be used to resolve stuck transaction based on the delivery tracking data stored.<br>The resolving includes, claiming back the funds and finishing the transaction (sending to beneficiary).<br><br>Mechanism of resolving is handled on OnInitialize block hook. The claimer submits a structured struct claim with neccessary claims and intention. The resolving function will check the truth of the claim by asserting on the specific transaction desired outcome.<br> |
| 3. | Backend (Nest JS) | All chain ( vane, polkadot/rococo, assethub) api interaction implementation, API chart workflow |
| 4. | FrontEnd (Next JS) | A front end prototype in Figma, A front end interaction for implemented feature hosted in vercel which will be only for wide screen ( no responsiveness ) as later on (not this grant ) we will implement a mobile application |

Expand Down Expand Up @@ -284,8 +267,7 @@ Please also provide the GitHub accounts of all team members. If they contain no
| **0d.** | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. |
| 0e. | Video tutorial | We will publish an workshop on X/Twitter that explains [...] (what was done/achieved as part of the grant and how the product should be used) |
| 1. | pallet transaction claim resolver | We will create a Substrate module that will handle failed transaction based on XCM delivery issues. Allowing users to claim their incomplete transactions|
| 2. | permissioned pallet contract & chain extensions | A permissioned wasm contract pallet and chain exensions for vane risk free transfer system to be used to extend Vane product services. Account who intend to extend vane product services must apply to be whitelisted to deploy the contract.
| | |**Chain extensions** will be limited to vane specific pallets extrinsics only, which includes, pallet_vane_xcm_transfer, pallet_vane_relay_asset, pallet_transfer_claim |
| 2. | permissioned pallet contract & chain extensions | A permissioned wasm contract pallet and chain exensions for vane risk free transfer system to be used to extend Vane product services. Account who intend to extend vane product services must apply to be whitelisted to deploy the contract.<br><br>**Chain extensions**<br> This will be limited to vane specific pallets extrinsics only, which includes, pallet_vane_xcm_transfer, pallet_vane_relay_asset, pallet_transfer_claim |
| 3. | Notion template marketplace contract| The marketplace will showcase how we can enable transaction customization for social-commerce business and foster growth. It will contain, listing of notion templates, securely limiting access of the notion template, buying of the template, Order placement and tracking.|
| 4. | Backend (Nest JS) | All chain ( vane, polkadot/rococo, assethub) api interaction implementation, API chart workflow, notion marketplace implementation for storing notion pages, notion users as a POC |
| 5. | Frontend (Next JS) | A front end prototype in Figma, A front end interaction for implemented feature hosted in vercel which will be only for wide screen ( no responsiveness ) as later on (not this grant ) we will implement a mobile application |
Expand Down

0 comments on commit 840b650

Please sign in to comment.