Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..f173110 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +This file makes sure that Github Pages doesn't process mdBook's output. diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..3085de0 --- /dev/null +++ b/docs/404.html @@ -0,0 +1,216 @@ + + +
+ + +This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +Vane enables entrepreneurs expand their social commerce business by leveraging trust and allows transaction safety in web3, i.e reversible and re-confirmation of transactions +Vane acts as an extension product and safety layer on Ethereum, Polkadot and Bitcoin, whereby users can access Vane's features using existing chains' native tokens i.e ETH, DOT & BTC
+ +This module defines callable functions for placing and managing orders. Users can place orders for products, and these orders are associated with both the payer and the seller. Order information is stored in the runtime's storage.## Usage +This module can be integrated into a Substrate runtime to enable decentralized e-commerce functionality. Users can place and manage orders for products registered in the system. The module interacts with other pallets and libraries to verify product existence and handle order placement and management.
+Please note that the functionality of this module is dependent on the configuration and interactions with other pallets and modules within the Substrate runtime. It should be used in conjunction with other components to create a complete e-commerce system.
+The behavior of this module can be customized through a configuration trait Config
. The configuration trait specifies the runtime's requirements and includes the following traits:
frame_system::Config
: Required for system-related functionality.vane_register::Config
: Required for interacting with the product registration system.Currency<Self::AccountId>
: The currency type used for transactions in the runtime.PayerOrder:
+Order<T>
. Orders are indexed by the payer's account.StorageMap<_, Blake2_128Concat, T::AccountId, Vec<Order<T>>, ValueQuery>
PayeeOrderRef:
+StorageMap<_, Blake2_128Concat, T::AccountId, Vec<(T::AccountId, u32, u32)>, ValueQuery>
OrderPlaced:
+buyer
: The account of the buyer who placed the order.item_id
: The ID of the product or item being ordered.order_no
: The order number associated with the placed order.seller
: The account of the seller from whom the order was placed.OrderCancelled:
+place_order
Parameters:
+origin
: An OriginFor<T>
representing the caller's origin.item_id
: A u32
representing the ID of the item being ordered.seller_id
: A T::AccountId
representing the account of the seller.Description:
+The module defines callabale methods that facilitates the registration of both payers and payees in a decentralized system. Users can register as either payers or payees, and additional functionalities include product registration by payees. This module interacts with various other Substrate pallets and provides custom storage, events, errors, and callable functions. +This module can be integrated into a Substrate runtime to enable user registration and product management functionalities in a decentralized system. Users can register as payers or payees, and payees can register and update their product offerings. The module also emits events to track user registration.
+The behavior of this module can be customized through a configuration trait Config
. The configuration trait specifies the runtime's requirements and includes the following traits:
frame_system::Config
: Required for system-related functionality.Currency<Self::AccountId>
: The currency type used for transactions in the runtime.RuntimeEvent
: Events generated by this module.PayeeStorage:
+PayeeAccountProfile<T>
. Each PayeeAccountProfile
contains information about the payee, including name, location, Instagram link, and registration time.StorageMap<_, Blake2_128, T::AccountId, PayeeAccountProfile<T>>
PayerStorage:
+PayerAccountProfile<T>
. Each PayerAccountProfile
contains information about the payer, including name, KYC (Know Your Customer) information, email, Vane ID, and registration time.StorageMap<_, Blake2_128, T::AccountId, PayerAccountProfile<T>>
PayeeProducts:
+ProductProfile<T>
. Each ProductProfile
represents a product registered by the payee and contains details such as product ID, image URL, price, and seller's account.StorageMap<_, Blake2_128Concat, T::AccountId, Vec<ProductProfile<T>>, ValueQuery>
PayerRegistered:
+id
: The account ID of the registered payer.time
: The block number indicating the registration time.PayeeRegistered:
+id
: The account ID of the registered payee.time
: The block number indicating the registration time.register_payer
Parameters:
+origin
: An OriginFor<T>
representing the caller's origin.name
: An optional Vec<u8>
representing the payer's name.email
: An optional Vec<u8>
representing the payer's email.kyc
: An optional Vec<u8>
representing KYC (Know Your Customer) information.Description:
+register_payee
Parameters:
+origin
: An OriginFor<T>
representing the caller's origin.name
: A Vec<u8>
representing the payee's name.ig_link
: A Vec<u8>
representing the payee's Instagram link.location
: A Vec<u8>
representing the payee's location.Description:
+update_products
Parameters:
+origin
: An OriginFor<T>
representing the caller's origin.product_id
: A u32
representing the ID of the product.link
: A Vec<u8>
representing the product's URL link.amount
: The price of the product.image_url
: An optional Vec<u8>
representing the product's image URL.Description:
+ProductProfile
is created with the provided product information and added to the payee's list of products.Certainly, let's go through the callable methods defined in the provided Rust code for the Pallet
module in detail:
vane_transfer
:
ensure_signed
).currency
type currently we have Token::Dot
and in future we will be supporting Token::Usdt
, it performs specific actions.currency
is Token::Dot
, it initiates an XCM (Cross-Chain Message) transfer.vane_confirm
:
ensure_signed
.test_storing
:
ensure_signed
.num
associated with the provided acc
in the TestStorage
storage map.Event::TestStored
event to signal that the storing operation was successful.These callable methods are part of the Pallet
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.
Vane enables entrepreneurs expand their social commerce business by leveraging trust and allows transaction safety in web3, i.e reversible and re-confirmation of transactions +Vane acts as an extension product and safety layer on Ethereum, Polkadot and Bitcoin, whereby users can access Vane's features using existing chains' native tokens i.e ETH, DOT & BTC
+ +