diff --git a/.gitignore b/.gitignore index b2d6de3..57d381d 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ npm-debug.log* yarn-debug.log* yarn-error.log* +.vscode/ diff --git a/docs/Moonchain-Design/Low-Scale-Certification.md b/docs/Moonchain-Design/Low-Scale-Certification.md index 9e119c0..c08f5c3 100644 --- a/docs/Moonchain-Design/Low-Scale-Certification.md +++ b/docs/Moonchain-Design/Low-Scale-Certification.md @@ -35,10 +35,10 @@ LPWAN offers cost-effective and energy-efficient connectivity solutions for vari Low Scale Certification Graphic -### 1.2 MXC Blockchain +### 1.2 Moonchain Blockchain is a decentralized, open-source blockchain platform specifically designed to support the Internet of Things (IoT) ecosystem and machine-to-machine (M2M) communication. -By leveraging the benefits of distributed ledger technology, MXC aims to create a more efficient, secure, and transparent environment for IoT devices and applications. The platform enables device interoperability, facilitates data sharing, and ensures secure data transactions among connected devices. Additionally, MXC Blockchain incentivizes users through its native cryptocurrency, the MXC token, which can be utilized for various purposes within the network, such as device registration, data transactions, and participation in network governance. +By leveraging the benefits of distributed ledger technology, Moonchain aims to create a more efficient, secure, and transparent environment for IoT devices and applications. The platform enables device interoperability, facilitates data sharing, and ensures secure data transactions among connected devices. Additionally, Moonchain Blockchain incentivizes users through its native cryptocurrency, the MXC token, which can be utilized for various purposes within the network, such as device registration, data transactions, and participation in network governance. ### 1.3 Low Scale Certification @@ -72,7 +72,7 @@ By requiring a quorum, distributed networks can prevent malicious actors from ta Quorum mechanisms contribute to the overall trust and reliability of a distributed system by ensuring that decisions and transactions are made with broad consensus among the participating nodes. -A quorum in a consensus group refers to the minimum number of participants or nodes required to reach an agreement on the state of the blockchain. Establishing a quorum ensures that decisions are made collectively and that a single entity or a small group of nodes cannot manipulate or control the network. Quorums play a crucial role in maintaining the integrity, security, and decentralization of the MXC blockchain. +A quorum in a consensus group refers to the minimum number of participants or nodes required to reach an agreement on the state of the blockchain. Establishing a quorum ensures that decisions are made collectively and that a single entity or a small group of nodes cannot manipulate or control the network. Quorums play a crucial role in maintaining the integrity, security, and decentralization of the Moonchain blockchain. ### 1.6 2.4 GHz Miners @@ -82,11 +82,11 @@ These miners operate in the 2.4 GHz frequency band, which is a globally availabl NEO GHz Miner -2.4 GHz LPWAN Miners contribute to the MXC network by verifying and validating transactions, maintaining the blockchain ledger, and facilitating secure communication between devices. +2.4 GHz LPWAN Miners contribute to the Moonchain network by verifying and validating transactions, maintaining the blockchain ledger, and facilitating secure communication between devices. They are optimized for energy efficiency and long-range connectivity, making them suitable for IoT applications and remote monitoring scenarios. -The 2.4 GHz LPWAN miners contribute to the MXC ecosystem by validating transactions, participating in consensus groups, and maintaining the seamless connection between the physical world and the metaverse. +The 2.4 GHz LPWAN miners contribute to the Moonchain ecosystem by validating transactions, participating in consensus groups, and maintaining the seamless connection between the physical world and the metaverse. ### 1.7 sub GHz Miners @@ -96,17 +96,17 @@ Sub GHz LPWAN Miners are particularly well-suited for applications requiring mor sub GHz Miners -Like their 2.4 GHz counterparts, Sub GHz LPWAN Miners contribute to the MXC network by verifying transactions, maintaining the blockchain ledger, and enabling secure communication between devices. They are also optimized for energy efficiency and extended connectivity, making them an ideal choice for IoT applications and remote monitoring situations. +Like their 2.4 GHz counterparts, Sub GHz LPWAN Miners contribute to the Moonchain network by verifying transactions, maintaining the blockchain ledger, and enabling secure communication between devices. They are also optimized for energy efficiency and extended connectivity, making them an ideal choice for IoT applications and remote monitoring situations. Similar to the 2.4 GHz LPWAN miners, Sub GHz LPWAN miners also participate in validating transactions, consensus groups, and maintaining the connection between the physical world and the metaverse. ### 1.8 MXC Hexagons -MXC Hexagons are a conceptual model used within the MXC ecosystem to bridge the physical world and the metaverse by representing the geographical distribution and coverage of LPWAN Miners, such as the 2.4 GHz and Sub GHz devices discussed earlier. This hexagonal grid layout serves as an efficient way to organize and visualize the network coverage provided by these miners, ensuring optimal connectivity and data transmission for IoT devices and applications on Earth while simultaneously mirroring the Earth's grid in the metaverse. +Moonchain Hexagons are a conceptual model used within the Moonchain ecosystem to bridge the physical world and the metaverse by representing the geographical distribution and coverage of LPWAN Miners, such as the 2.4 GHz and Sub GHz devices discussed earlier. This hexagonal grid layout serves as an efficient way to organize and visualize the network coverage provided by these miners, ensuring optimal connectivity and data transmission for IoT devices and applications on Earth while simultaneously mirroring the Earth's grid in the metaverse. -By connecting the Earth and the metaverse through MXC Hexagons, the MXC ecosystem can seamlessly integrate the benefits of both worlds, enabling a more comprehensive and immersive experience for users and network participants. This interconnected model allows for the development and deployment of innovative IoT applications and services that leverage the strengths of both the physical and virtual domains, unlocking new possibilities for communication, data exchange, and resource management. +By connecting the Earth and the metaverse through Moonchain Hexagons, the Moonchain ecosystem can seamlessly integrate the benefits of both worlds, enabling a more comprehensive and immersive experience for users and network participants. This interconnected model allows for the development and deployment of innovative IoT applications and services that leverage the strengths of both the physical and virtual domains, unlocking new possibilities for communication, data exchange, and resource management. -MXC Hexagons can be used to address various network planning and deployment challenges, such as: +Moonchain Hexagons can be used to address various network planning and deployment challenges, such as: #### 1.8.1 Coverage Optimization: By arranging LPWAN Miners in a hexagonal pattern, network planners can ensure optimal coverage and signal strength for IoT devices within the network. The hexagonal grid provides a more uniform and consistent coverage area compared to other shapes, like squares or circles, minimizing coverage gaps and signal degradation. Each hexagon is around 2 kilometer in diameter @@ -115,19 +115,19 @@ By arranging LPWAN Miners in a hexagonal pattern, network planners can ensure op The hexagonal model allows for easy expansion and scalability of the network as new LPWAN Miners are deployed. As the network grows, additional hexagons can be added to the grid, seamlessly integrating with the existing coverage areas and maintaining optimal connectivity. #### 1.8.3 Resource Allocation: -MXC Hexagons can be used to allocate resources and responsibilities among LPWAN Miners within the network. By dividing the coverage area into hexagonal zones, network operators can assign specific tasks or roles to the miners within each hexagon, such as data processing, transaction validation, or network synchronization, optimizing the overall performance and efficiency of the system. +Moonchain Hexagons can be used to allocate resources and responsibilities among LPWAN Miners within the network. By dividing the coverage area into hexagonal zones, network operators can assign specific tasks or roles to the miners within each hexagon, such as data processing, transaction validation, or network synchronization, optimizing the overall performance and efficiency of the system. #### 1.8.4 Network Visualization: -The hexagonal grid provides an intuitive and easy-to-understand representation of the network's coverage and connectivity. Network operators, IoT device manufacturers, and end-users can quickly grasp the network layout, signal strength, and Miner distribution by examining the MXC Hexagons, aiding in network planning, troubleshooting, and device deployment decisions. +The hexagonal grid provides an intuitive and easy-to-understand representation of the network's coverage and connectivity. Network operators, IoT device manufacturers, and end-users can quickly grasp the network layout, signal strength, and Miner distribution by examining the Moonchain Hexagons, aiding in network planning, troubleshooting, and device deployment decisions. #### 1.8.5 Hexagons and Consensus Groups: -MXC Hexagons also play a vital role in the formation and operation of Consensus Groups within the MXC ecosystem. By organizing the LPWAN Miners into hexagonal zones, the network can more effectively distribute the responsibility for validating transactions and maintaining the blockchain ledger among the miners. +MXC Hexagons also play a vital role in the formation and operation of Consensus Groups within the Moonchain ecosystem. By organizing the LPWAN Miners into hexagonal zones, the network can more effectively distribute the responsibility for validating transactions and maintaining the blockchain ledger among the miners. Each hexagon can be associated with a specific Consensus Group, consisting of miners located within that hexagonal zone. This localized approach allows for faster and more efficient consensus decision-making, as miners within a given hexagon are likely to have stronger connectivity and lower latency compared to miners spread across the entire network. Furthermore, the hexagonal organization promotes network resilience and security. In the event of a miner failure or malicious activity, the impact on the network is localized to the affected hexagon, preventing the issue from spreading throughout the entire system. This structure also makes it more challenging for an attacker to compromise the network, as they would need to target multiple hexagons and Consensus Groups simultaneously to have a significant impact. -By integrating MXC Hexagons with the Consensus Group structure, the MXC ecosystem can ensure robust network performance, security, and reliability while maintaining the decentralization and democratic decision-making principles that underpin the blockchain technology. +By integrating Moonchain Hexagons with the Consensus Group structure, the Moonchain ecosystem can ensure robust network performance, security, and reliability while maintaining the decentralization and democratic decision-making principles that underpin the blockchain technology. ## Chapter 2: Design Aims @@ -188,16 +188,16 @@ Precise synchronization plays a vital role in ensuring the overall performance a ### 2.3 Trustworthy Location #### 2.3.1 Importance of accurate location -Ensuring the accurate representation of a device's location in both the real world and the metaverse is crucial for maintaining the integrity of the network and the seamless connection between the two domains. Accurate location information helps protect the network from potential attacks, in which malicious actors may attempt to disrupt the system by providing false location data for devices. Moreover, as the hexagon grid plays a vital role in the consensus group, accurate location data is essential for the proper functioning of the MXC blockchain and LPWAN devices. +Ensuring the accurate representation of a device's location in both the real world and the metaverse is crucial for maintaining the integrity of the network and the seamless connection between the two domains. Accurate location information helps protect the network from potential attacks, in which malicious actors may attempt to disrupt the system by providing false location data for devices. Moreover, as the hexagon grid plays a vital role in the consensus group, accurate location data is essential for the proper functioning of the Moonchain blockchain and LPWAN devices. #### 2.3.2 Goal of accurate location -The system aims to establish a secure and reliable connection between the metaverse, the devices using the network (such as LPWAN miners), and the MXC blockchain. By providing accurate and untampered location data through the use of hexagons as a representation of the metaverse grid, the system ensures that location information can be checked, traced, and trusted by the public. This approach makes it more challenging for attackers to compromise the network, as the location data is transparent and verifiable, promoting a more secure environment for users and network participants. Through this method, the system reinforces the trustworthiness of the connection between the physical world and the metaverse, fostering a reliable foundation for the development of innovative applications and services. +The system aims to establish a secure and reliable connection between the metaverse, the devices using the network (such as LPWAN miners), and the Moonchain blockchain. By providing accurate and untampered location data through the use of hexagons as a representation of the metaverse grid, the system ensures that location information can be checked, traced, and trusted by the public. This approach makes it more challenging for attackers to compromise the network, as the location data is transparent and verifiable, promoting a more secure environment for users and network participants. Through this method, the system reinforces the trustworthiness of the connection between the physical world and the metaverse, fostering a reliable foundation for the development of innovative applications and services. #### 2.3.3 Trustworthy Location Verification Techniques Several techniques can be employed to ensure accurate and trustworthy location data in the network. These may include time difference of arrival (TDoA), received signal strength indicator (RSSI), and signal-to-noise ratio (SNR) measurements. Combining multiple location verification techniques can further improve location accuracy and reliability, making it more challenging for attackers to manipulate or falsify the data. #### 2.3.4 The Role Of The Consensus Group In Maintaining Trustworthy Location Data -The consensus group plays an essential part in maintaining trustworthy location data in the MXC blockchain. By participating in the validation and confirmation of location information, the consensus group members help ensure that the data remains accurate and consistent throughout the network. This collaborative approach, in conjunction with the use of blockchain technology, provides a transparent, decentralized, and secure environment for location data management. Consequently, it upholds the seamless connection between the physical world and the metaverse and the overall integrity of the network. +The consensus group plays an essential part in maintaining trustworthy location data in the Moonchain blockchain. By participating in the validation and confirmation of location information, the consensus group members help ensure that the data remains accurate and consistent throughout the network. This collaborative approach, in conjunction with the use of blockchain technology, provides a transparent, decentralized, and secure environment for location data management. Consequently, it upholds the seamless connection between the physical world and the metaverse and the overall integrity of the network. ### 2.4 Trustworthy Physical Existence @@ -213,7 +213,7 @@ Establishing trustworthiness in proving the physical existence of objects is cru The challenge lies in devices made by third-party manufacturers wanting to connect to the network. Ensuring that these devices meet the necessary requirements and standards for proving their physical existence can be a complex and resource-intensive process. #### 2.4.3 Goal of Physical Existence Verification -The primary goal of physical existence verification is to provide proof of physicality that is verifiable, traceable, and trusted by the public. By establishing trustworthy proof of existence, we can protect the network from fake devices that might disturb the network's functionality and security. This helps maintain the seamless connection between the physical world and the metaverse and ensures the integrity and reliability of the MXC network. +The primary goal of physical existence verification is to provide proof of physicality that is verifiable, traceable, and trusted by the public. By establishing trustworthy proof of existence, we can protect the network from fake devices that might disturb the network's functionality and security. This helps maintain the seamless connection between the physical world and the metaverse and ensures the integrity and reliability of the Moonchain network. ## Chapter 3 LSC of physical existence for miners and sensors @@ -232,12 +232,12 @@ is the process of establishing a shared secret key between the device and the cl Our method for LSC device provisioning involves three steps: - **Generate the PID:** -The PID is created by the Device owner on the Super Node using the MEP. The PID costs a fee. The SuperNode then creates an NFT on the blockchain with the PID attached to a secret, only visible to the owner of the NFT. The NFT is then sent to the Creator's wallet. +The PID is created by the Device owner on the Supernode using the MEP. The PID costs a fee. The SuperNode then creates an NFT on the blockchain with the PID attached to a secret, only visible to the owner of the NFT. The NFT is then sent to the Creator's wallet. Provisioning ID Overview - **Program the PID into the device:** -The owner needs to flash the PID into the sensor device it wants to produce. They also need to print a label with the PID so the device can be added to the Data Dash app by scanning it. +The owner needs to flash the PID into the sensor device it wants to produce. They must also print a label with the PID so that the device can be added to the desired application by scanning. - **Device provisioning:** PID is just an authenticator of the device; to join, the device needs to perform self-provisioning after it is manufactured. @@ -288,11 +288,11 @@ By implementing the decentralized LSC solution, the system can establish a seaml ## Chapter 4: LSC of Location and Consensus Group -### 4.1 Consensus Group in MXC Blockchain +### 4.1 Consensus Group in Moonchain Blockchain -In the MXC Blockchain, a consensus group is formed when miners collaborate to confirm transactions and record them on the blockchain. This section will explore how this process unfolds, from the initial registration of a miner to the formation and expansion of a consensus group. +In the Moonchain Blockchain, a consensus group is formed when miners collaborate to confirm transactions and record them on the blockchain. This section will explore how this process unfolds, from the initial registration of a miner to the formation and expansion of a consensus group. -#### 4.1.1 Flow of Consensus Group in MXC Blockchain +#### 4.1.1 Flow of Consensus Group in Moonchain Blockchain The process begins when a miner registers within a specific geographical area, known as a hexagon, through the blockchain. The miner's existence is verified using its Provisioning Identifier (PID), and its location is confirmed by linking it to a specific hexagon. This location is then cross-verified by other miners through a process called peer listening. @@ -331,10 +331,10 @@ The tokens in the tank are not only a sign of the miner's authenticity but also ### 4.2 Consensus Group Ground Rules: #### 4.2.1 Definitions -A Consensus Group serves as the collective consciousness of the MXC blockchain, following established protocols and formed under certain conditions. It represents a group of Miners, bound by the law of Quorum, which governs decision-making and merging dynamics within the group. +A Consensus Group serves as the collective consciousness of the Moonchain blockchain, following established protocols and formed under certain conditions. It represents a group of Miners, bound by the law of Quorum, which governs decision-making and merging dynamics within the group. #### 4.2.2 Commitment to Implementation: -The Consensus Group plays a pivotal role in the MXC blockchain, with responsibilities that include overseeing LPWAN devices and enforcing network rules and procedures. +The Consensus Group plays a pivotal role in the Moonchain blockchain, with responsibilities that include overseeing LPWAN devices and enforcing network rules and procedures. A core component of these rules is the establishment of certain prerequisites that every miner must meet to qualify for membership in a consensus group. diff --git a/docs/Moonchain-Design/Moonchain Supernode.md b/docs/Moonchain-Design/Moonchain Supernode.md index 04e106a..3b292af 100644 --- a/docs/Moonchain-Design/Moonchain Supernode.md +++ b/docs/Moonchain-Design/Moonchain Supernode.md @@ -10,7 +10,7 @@ In our zkEVM SupernodeV2, there are two important parts to a Moonchain Supernode - mxc-client ## MXC geth -The [mxc-geth](https://github.com/MXCzkEVM/mxc-geth) repository is a customized version of [taiko-geth](https://github.com/taikoxyz/taiko-geth) tailored to integrate MXprotocol specifications. Functioning as an IoT Web3 platform, it interfaces with an LPWAN cluster as described [here](/docs/Moonchain-Design/LPWAN%20Protocol) previously. Similar to Ethereum's L1/L2 execution engines, mxc-geth monitors and processes new IoT transactions within the network. These transactions are ececuted on the EVM, maintaining the latest state and comprehensive database of current IoT data. Subsequently, it submits proofs using Zero-Knowledge cryptography for enhanced security and privacy. +The [mxc-geth](https://github.com/MXCzkEVM/mxc-geth) repository is a customized version of [taiko-geth](https://github.com/taikoxyz/taiko-geth) tailored to integrate Moonchain's specifications. Functioning as an IoT Web3 platform, it interfaces with an LPWAN cluster as described [here](/docs/Moonchain-Design/LPWAN%20Protocol) previously. Similar to Ethereum's L1/L2 execution engines, mxc-geth monitors and processes new IoT transactions within the network. These transactions are ececuted on the EVM, maintaining the latest state and comprehensive database of current IoT data. Subsequently, it submits proofs using Zero-Knowledge cryptography for enhanced security and privacy. ## MXC client diff --git a/docs/Moonchain-Design/XSD.md b/docs/Moonchain-Design/XSD.md index ccceefc..e6cd411 100644 --- a/docs/Moonchain-Design/XSD.md +++ b/docs/Moonchain-Design/XSD.md @@ -4,18 +4,18 @@ sidebar_position: 11 # Moonchain Stablecoin -MXC will be the largest Layer-3 IoT solution on Arbitrum ecosystem, bringing tremendous real-world items to NFT world and data to the blockchain. Undoubtedly each real-world item and each piece of data has its own value, and this kind of value is not from pure financial speculations, the value comes from real economy that serves our food, sports, transportation every day. +Moonchain will be the largest Layer-3 IoT solution on Arbitrum ecosystem, bringing tremendous real-world items to NFT world and data to the blockchain. Undoubtedly each real-world item and each piece of data has its own value, and this kind of value is not from pure financial speculations, the value comes from real economy that serves our food, sports, transportation every day. -MXC is going to leverage the real-world economy to build the first stable coin backed by items like Gin, Bike sensors, Nike shoes etc. Along with the tokens created on zkEVM like Ride token, Park token and MXC, BTC, the MXC stable coin has a basket ranging from NFT to tokens to back the stable coin from the real-world economy. +Moonchain is going to leverage the real-world economy to build the first stable coin backed by items like Gin, Bike sensors, Nike shoes etc. Along with the tokens created on zkEVM like Ride token, Park token and MXC. XSD - The Moonchain stable coin has a basket ranging from NFT to tokens to back the stable coin from the real-world economy. -XSD, in conjunction with MXC and ISO projects, aims to empower individuals and companies to generate and circulate XSD within their unique economic systems, supporting their specific business requirements. The objective is to transform the existing financial landscape, where the majority of stable coins and fiat currencies rely on the backing of US treasury bonds. With a staggering 30 trillion USD in US treasury bonds and only 4 trillion in gold and other reserves held by the US Treasury and Federal Reserve, this initiative seeks to establish a more decentralized and diverse foundation for global financial systems. +XSD, in conjunction with Moonchain and ISO projects, aims to empower individuals and companies to generate and circulate XSD within their unique economic systems, supporting their specific business requirements. The objective is to transform the existing financial landscape, where the majority of stable coins and fiat currencies rely on the backing of US treasury bonds. With a staggering 30 trillion USD in US treasury bonds and only 4 trillion in gold and other reserves held by the US Treasury and Federal Reserve, this initiative seeks to establish a more decentralized and diverse foundation for global financial systems. -As IoT [Swap](https://swap.mxc.com/) shows, the IoT tokens like Ride token would be the major applications that use MXC network and ISO projects to build their own data economy. These Ride and Park token can be swapped in MXC Swap conveniently, through XSD trading pair. XSD will be the first IoT stable coin that are backed by real-world assets and data values, meanwhile serving for the digital and real-world economy. +As IoT [Swap](https://swap.mxc.com/) shows, the IoT tokens like Ride token would be the major applications that use Moonchain network and ISO projects to build their own data economy. These Ride and Park token can be swapped in Moonchain Swap conveniently, through XSD trading pair. XSD will be the first IoT stable coin that are backed by real-world assets and data values, meanwhile serving for the digital and real-world economy. -MXProtocol design and its ecosystem both are aimed for validating the XSD stable coin，which is pegged to US dollars at start in 1:2 manner. Along with the NFC, LoraWAN and Satellite technologies, users are able to verify and validate the value of XSD are backed by collateral like Gin 1689 NFTs, and MXC/DG/Ride tokens. +Moonchain's design and its ecosystem both are aimed for validating the XSD stable coin，which is pegged to US dollars at start in 1:2 manner. Along with the NFC, LoraWAN and Satellite technologies, users are able to verify and validate the value of XSD are backed by collateral like Gin 1689 NFTs, and MXC/DG/Ride tokens. IoT NFTs need to reach a minimal IoT NFT transactions, in the initial roll-out is three transactions in order to become a collateral. This is to raise the attacking cost to enter the XSD mint basket. @@ -56,9 +56,9 @@ In this case, the users will try to redeem one Gin 1689 NFT to get 100USD worth ## Insurance -The goal of XSD and MXC is to enable every person/company to create XSD and circulate in their own economy to support their business logic, eventually it is to change the current situation that all the stable coins and Fiat currencies are backed by US treasury bonds, while US treasury bonds are like 30 trillion USD and US treasury and Fed Reserve only got 4 trillion gold or other reserves. +The goal of Moonchain and XSD is to enable every person/company to create XSD and circulate in their own economy to support their business logic, eventually it is to change the current situation that all the stable coins and Fiat currencies are backed by US treasury bonds, while US treasury bonds are like 30 trillion USD and US treasury and Fed Reserve only got 4 trillion gold or other reserves. -We need to peg this world better with the assets created by people and used by people. Also we need to deal with systematic risks if the de-peg happens. Central banks proposes to print more money to solve the problem. MXC DAO proposes that we should add a 10% insurance on the top of the every XSD mint to deal with the systematic risks. +We need to peg this world better with the assets created by people and used by people. Also we need to deal with systematic risks if the de-peg happens. Central banks proposes to print more money to solve the problem. Moonchain DAO proposes that we should add a 10% insurance on the top of the every XSD mint to deal with the systematic risks. This 10% insurance can be paid every year to make sure even if the depeg happened like the collateral is gone or the overall overall collateral price is reduced due to a certain black swan event. @@ -66,7 +66,7 @@ The insurance should be an option at the end of the minting process. ## XSD exchange rate with USD -When the XSD economy is getting bigger and bigger, the MXC DAO should see the 1:2 exchange rate will fluctuate due to the demand of XSD is higher than USD and people lose trust in USD. +When the XSD economy is getting bigger and bigger, the Moonchain DAO should see the 1:2 exchange rate will fluctuate due to the demand of XSD is higher than USD and people lose trust in USD. This is due to the volatility of the Fed Reserve to create more balance sheet and run-off the balance sheet without any anchor, XSD holder should aim for a certain development that the unit price of the collateral like watch, shoes, wines are defined by the unit of a XSD and no longer will be a USD. @@ -77,7 +77,7 @@ Every time the XSD is mint will need to follow the most updated conversion rate ::: ## Lending use cases -It is expected that people will borrow XSD and lend XSD to generate stable APY, there are a lot of similar lending protocols like AAVE will move to MXC zkEVM to enable XSD economy active. +It is expected that people will borrow XSD and lend XSD to generate stable APY, there are a lot of similar lending protocols like AAVE will move to Moonchain zkEVM to enable XSD economy active. ## Use case of XSD @@ -93,9 +93,9 @@ This chapter introduces XSD minting: a peer-to-peer perpetual lending protocol t XSD mint matches users who want to borrow against their real-world collateral with whatever lender is willing to offer the most competitive rate, using a sophisticated off-chain offer protocol. -By default, XSD mint loans have fixed rates **(0% interest rate)** and never expire. Borrowers can repay at any time, while XSD mint won't exit. Howevery, MXC DAO can trigger a referedum to exit any positions by triggering a Dutch auction to find a new lender at a new rate. If that auction fails, the borrower is liquidated and the XSD mint takes possession of the collateral. +By default, XSD mint loans have fixed rates **(0% interest rate)** and never expire. Borrowers can repay at any time, while XSD mint won't exit. Howevery, Moonchain DAO can trigger a referedum to exit any positions by triggering a Dutch auction to find a new lender at a new rate. If that auction fails, the borrower is liquidated and the XSD mint takes possession of the collateral. -XSD mint has been implemented by MXC Core Contributors. In their implementation, some protocol parameters, such as protocol fees, are controlled by MXC DAO governance. +XSD mint has been implemented by Moonchain Core Contributors. In their implementation, some protocol parameters, such as protocol fees, are controlled by Moonchain DAO governance. ## No Oracles @@ -156,7 +156,7 @@ Once the auction hits some defined max rate (like 1000%) without letting XSD min Also the insurance in this case should repay the difference amounts to the borrower if the liquidation is faield. -Except for MXC DAO referendum can trigger a liquidation event, borrower usually won't repay if the interest rate is 0% or even in some cases can be below 0%. +Except for Moonchain DAO referendum can trigger a liquidation event, borrower usually won't repay if the interest rate is 0% or even in some cases can be below 0%. ## Optimistic Auctions @@ -178,7 +178,7 @@ This lets us drop the concept of expiration times and loan periods. By default, A borrower can repay at any time. If a borrower wants to change the amount they have borrowed or get a better interest rate, they can atomically take out a new loan against the collateral and use the new principal to repay the old loan. -If a referendum in MXC DAO wants to get out of a certain XSD mint loan, they can trigger a refinancing auction, as discussed above. All timelines and deadlines during refinancing events can be defined relative to the time the refinancing was initiated. +If a referendum in Moonchain DAO wants to get out of a certain XSD mint loan, they can trigger a refinancing auction, as discussed above. All timelines and deadlines during refinancing events can be defined relative to the time the refinancing was initiated. Alternatively, if the interest rate is adjusted by the XSD mint, the current lend can skip the auction by submitting the other offer to the vault to get out of their loan. @@ -198,4 +198,4 @@ XSD mint basket: The selection of the Sensor Tokens and IoT NFTs that can use to Minimal IoT NFT transactions: The minimal trading transactions that an IoT NFT can be used as a collateral. -In MXC's implementation of XSD, after a 180-day waiting period, these parameters can be managed by MXC governance to ensure optimal performance and adapt to changing market conditions in a decentralized way. +In MXC's implementation of XSD, after a 180-day waiting period, these parameters can be managed by Moonchain governance to ensure optimal performance and adapt to changing market conditions in a decentralized way. diff --git a/docs/Testnet-Tutorials/Deploying-A-Contract.md b/docs/Testnet-Tutorials/Deploying-A-Contract.md index 3364648..e48ae07 100644 --- a/docs/Testnet-Tutorials/Deploying-A-Contract.md +++ b/docs/Testnet-Tutorials/Deploying-A-Contract.md @@ -15,7 +15,6 @@ This guide will help you deploy a smart contract on Moonchain (Geneva Testnet) u - You have the private key handy to an account that has `Test $MXC Tokens` on Moonchain Geneva (to pay the transaction fee for deploying the contract). - [Retrieve the private key with MetaMask](https://support.metamask.io/managing-my-wallet/secret-recovery-phrase-and-private-keys/how-to-export-an-accounts-private-key/). - [Generate wallet keys with OpenSSL](https://gist.github.com/miguelmota/3793b160992b4ea0b616497b8e5aee2f). - - [Generate wallet keys with ethereumjs-wallet](https://piyopiyo.medium.com/how-to-generate-ethereum-private-key-and-address-in-local-offline-environment-90294308593c). - Have some Test $MXC Tokens on Moonchain Geneva: - [Request Test $MXC Tokens](/docs/Testnet-Tutorials/Moonchain-Faucet) from the faucet. diff --git a/docs/Testnet-Tutorials/Run-Moonchain-Supernode.md b/docs/Testnet-Tutorials/Run-Moonchain-Supernode.md index 0410098..2be9458 100644 --- a/docs/Testnet-Tutorials/Run-Moonchain-Supernode.md +++ b/docs/Testnet-Tutorials/Run-Moonchain-Supernode.md @@ -9,9 +9,9 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import GrafanaDashboard from '/img/GrafanaDashboard.png'; -# Running a Moonchain Supernode +# Running a Moonchain supernode -## Operating a Moonchain Supernode with simple-mxc-node +## Operating a Moonchain supernode with simple-mxc-node This guide will walk you through the process of operating a Moonchain supernode using simple-mxc-node. By following these steps, you will be able to: - Run a Moonchain supernode easily from the command line on Windows, Mac, and Linux. @@ -86,7 +86,7 @@ You can get an Arbitrum L1 endpoint from various providers such as: Make sure you select the RPC as **Arbitrum Sepolia Testnet**, and not the Ethereum Mainnet. ::: -### Set Permissions and Create Folders +### Defining authorizations and creating folders Create the necessary directories and set the permissions so that the Docker containers can access and write to them: ```sh @@ -94,33 +94,33 @@ mkdir -p ./data/l2_execution_engine_data ./data/zkevm_chain_prover_rpcd_data ./d sudo chmod -R 777 ./data ./docker ``` -### Enable your Supernode as a Prover (optional) +### Enable your supernode as a prover (optional) For more detailed information, please see [Enable a prover](./Enable-a-Prover). :::important[NOTE] -Synchronizing from the genesis block may take some time. You can monitor this progress through logs or by using the local Grafana Dashboard. Additionally, you can check the latest L2 chain status in the [MXC Geneva Block Explorer](https://geneva-explorer.moonchain.com/). +Synchronizing from the genesis block may take some time. You can monitor this progress through logs or by using the local Grafana Dashboard. Additionally, you can check the latest L2 chain status in the [Moonchain Geneva Block Explorer](https://geneva-explorer.moonchain.com/). ::: -**1. Ensure Docker is Running**: Make sure that the Docker is installed an actively running on your system. +**1. Ensure Docker is running**: Make sure that the Docker is installed an actively running on your system. -**2. Run the following command to start the Supernode**: +**2. Run the following command to start the supernode**: ```sh docker compose up ``` -**3. Run the Supernode in the Background (Detached Mode)**: If you prefer to run the supernode in the background, add the `-d` flag to the command: +**3. Run the supernode in the background (Detached Mode)**: If you prefer to run the supernode in the background, add the `-d` flag to the command: ```sh docker compose up -d ``` -### Stopping a Supernode +### Stopping a supernode To shut down the supernode while retaining all volumes (so it won't need to synchronize from the genesis block again upon restart), use the following command: ```sh docker compose down ``` -### Removing a Supernode +### Removing a supernode To completely remove the supernode, including all volumes used by each container, execute the following commands: **1. Stop and remove containers along with volumes**: @@ -132,13 +132,13 @@ docker compose down -v rm -f .env ``` -### Updating a Supernode +### Updating a supernode To update the simple-mxc-supernode Docker images, use the following command: ```sh docker compose pull ``` -### Viewing the Supernode's Logs +### Viewing the supernode's Logs To monitor and view logs from the Docker containers, use the following commands: **1. View all logs**: @@ -154,7 +154,7 @@ docker compose logs -f mxc_client_prover_relayer docker compose logs -f l2_execution_engine ``` -### Viewing Live Data Streams of Your Running Containers +### View live data streams of your running containers To see the CPU and memory usage percentage, as well as the resource consumption of your machine, use the following command: ```sh @@ -165,7 +165,7 @@ For displaying statistics for all containers, add the prefix `-a` : docker stats -a ``` -### View the Supernode's Status Dashboard +### View the supernode's status dashboard To view the Supernode's Status Dashboard, which utilizes Grafana with a Prometheus datasource, follow these steps: @@ -174,11 +174,11 @@ Open your web browser and navigate to the following URL: ``` http://localhost:3000/d/L2ExecutionEngine/l2-execution-engine-overview?orgId=1&refresh=10s ``` -**2. Dashboard Details**: +**2. Dashboard details**: - This URL points directly to the Grafana dashboard designed for monitoring the L2 execution engine's real-time status. - It uses Prometheus as the datasource, providing comprehensive insights into the performance and metrics of your supernode. -**3. Monitor in Real Time**: +**3. Monitor in real time**: The dashboard will update automatically every 10 seconds `(refresh=10s parameter in the URL)`. You can customize the dashboard views and metrics as needed using Grafana's features.