Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add metalswap project documentation #174

Merged
merged 1 commit into from
Jun 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/metalswap/active-swap-managing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/metalswap/active-swaps-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/metalswap/get-test-tokens.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/metalswap/liquidity-pools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/metalswap/swap-execute-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/metalswap/swap-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/metalswap/tokens-faucet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions docs/use-linea/explore/use-asmatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ sidebar_position: 1
---

# Task on Galxe
AsMatch - Mint zkPioneer (zkSBT) , enter Proof Key in AsMatch profile, link Metamask

Mint zkPioneer (zkSBT) on Manta Network NPO website to get ZK Proof Key, enter Proof Key in AsMatch profile, link Metamask address on AsMatch official Website.
AsMatch - Mint zkPioneer (zkSBT) , enter Proof Key in AsMatch profile, link Metamask

Mint zkPioneer (zkSBT) on Manta Network NPO website to get ZK Proof Key, enter Proof Key in AsMatch profile, link Metamask address on AsMatch official Website.

MAKE SURE YOU READ THE DOCUMENT LINKED HERE

Expand All @@ -25,4 +26,5 @@ MAKE SURE YOU READ THE DOCUMENT LINKED HERE
**Note**: Make sure to connect your zkPioneer-minted wallet address when you login to the official [AsMatch website](https://asmatch.app) to be eligible to participate in this campaign.

## Call-to-Action:

https://npo.manta.network/calamari/sbt/projects/zkLinea
35 changes: 11 additions & 24 deletions docs/use-linea/explore/use-battlemon.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ sidebar_position: 1

# Battlemon

A GameFi ecosystem built around interactive 3D NFTs with utilities and on-chain mechanics with outcome probabilities.
Mix, craft, play, stake - and get rewarded.
A GameFi ecosystem built around interactive 3D NFTs with utilities and on-chain mechanics with outcome probabilities. Mix, craft, play, stake - and get rewarded.

Before you begin, ensure your wallet is:

Expand All @@ -29,28 +28,26 @@ Go to https://battlemon.com/city/mint

![activationСode](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/311f64ce-0105-4520-8878-4539c163065b)

1. Join the [Discord server](https://discord.gg/battlemon) and [get verification](https://discordapp.com/channels/893433519110488064/1086617965279068311)
2. Copy the string containing "/activate code: *yourcode*"
3. Go to the [Discord special channel](https://discordapp.com/channels/893433519110488064/1116478869118144532)
1. Join the [Discord server](https://discord.gg/battlemon) and [get verification](https://discordapp.com/channels/893433519110488064/1086617965279068311)
2. Copy the string containing "/activate code: _yourcode_"
3. Go to the [Discord special channel](https://discordapp.com/channels/893433519110488064/1116478869118144532)

Activate your code

![activate](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/4a768a55-07e7-4088-ae10-29ebe2c90d63)
1. Paste the string from step 2 "/activate code: *yourcode*".
2. Send the command to the bot.
3. Wait for the bot's answer.

1. Paste the string from step 2 "/activate code: _yourcode_".
2. Send the command to the bot.
3. Wait for the bot's answer.

![botAnswer](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/e5b05e78-1a47-4823-9e10-ef8fe3077c7f)

Go to https://battlemon.com/city/mint and mint your NFT: "Key-pass"

![minKeyPass](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/75807067-1f64-4068-949e-b48c1711be9c)


![mint-key](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/079db208-72d5-475e-9acd-5ad8abb439cb)


## Mint NFT: "Pickaxe"

Go to https://battlemon.com/city/launchpad and press button: "0.01 ETH"
Expand All @@ -61,46 +58,36 @@ Go to https://battlemon.com/city/launchpad and press button: "0.01 ETH"

![gemLvl1](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/921196cf-fda0-4b21-8ee4-d670a5a5d078)

Go to https://battlemon.com/city/labs
Go to https://battlemon.com/city/labs

![nft Gem lvl1](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/a7ad22ae-1587-4ae2-a568-21ca05caf607)

Press button: "Mint"


![MintGem](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/40ddc7af-ffd4-414b-8b0c-b94184e9ebaa)



## Mint NFT: "Gem third level (Yellow)"

![gemLvl3](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/512053f1-d628-4745-a5e5-fce51ef32a76)

Go to https://battlemon.com/city/labs
Go to https://battlemon.com/city/labs

![craftGems](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/b6bc2402-993e-4c38-afa0-daff02b7ecb5)


Mint more NFT: "Gem first level (Green)"

![gemLvl1](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/22fd83d1-5bd1-4f24-bf97-4d8d82d69548)


Craft NFT: "Gem second level (Blue)"

![gemLvl2](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/3882e5ce-a230-4f5e-8e20-05000c8b0ed9)


Craft NFT: "Gem third level (Yellow)"

![gemLvl3](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/da004793-2663-4e57-914d-80702e4ea4fa)


![craft](https://github.com/d-lol-b/doc.zk-evm/assets/78548938/0c9a0f87-dd96-49c6-8a3f-20c9929eb4d0)


## Social

[Discord](https://discord.gg/battlemon)
[Twitter](https://twitter.com/BATTLEM0N)
[Medium](https://medium.com/@Battlemon)
[Discord](https://discord.gg/battlemon) [Twitter](https://twitter.com/BATTLEM0N) [Medium](https://medium.com/@Battlemon)
8 changes: 4 additions & 4 deletions docs/use-linea/explore/use-cataclysm.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ To complete the tasks of the game "Cataclysm: Zero Mission" for the Linea Voyage

![img1](../../assets/cataclysm/connect-wallet.png)

Once on the game page, users will see two options: "Connect Metamask" and "Wallet Connect". They can click on either button to connect their wallet. ***Please note that this step is mandatory to play “Cataclysm: Zero Mission”.***
Once on the game page, users will see two options: "Connect Metamask" and "Wallet Connect". They can click on either button to connect their wallet. **_Please note that this step is mandatory to play “Cataclysm: Zero Mission”._**

![img2](../../assets/cataclysm/start-game.png)

After connecting their wallet, users will be ready to start playing. There are two available tasks for the Linea Voyage Quest: the first one is in the ***endless run*** mode, and the second one is in the ***arcade*** mode.
After connecting their wallet, users will be ready to start playing. There are two available tasks for the Linea Voyage Quest: the first one is in the **_endless run_** mode, and the second one is in the **_arcade_** mode.

In the endless run mode, waves of robots relentlessly swarm the game, testing the player's endurance and reflexes. Each wave becomes increasingly challenging, requiring quick thinking and precise movements to survive.

Expand All @@ -36,14 +36,14 @@ Once the token has been redeemed, a confirmation pop-up will appear to confirm t
![img5](../../assets/cataclysm/redeem-complete.png)

At this point, the user can take three actions:

1. Close the pop-up and the page
2. Close the pop-up and continue playing
3. Click on the CTA (Call to Action) that will take them to join the Cataclysm Discord

## How to complete the task in the Arcade mode

**In the arcade mode, the objective of the task is to kill at least 10 enemies.**
Once the 10 enemies are defeated and the game comes to an end, regardless of whether the users win or lose, a pop-up will appear confirming their victory. Afterward, they can proceed with the same steps described in the endless run mode to mint the token.
**In the arcade mode, the objective of the task is to kill at least 10 enemies.** Once the 10 enemies are defeated and the game comes to an end, regardless of whether the users win or lose, a pop-up will appear confirming their victory. Afterward, they can proceed with the same steps described in the endless run mode to mint the token.

![img6](../../assets/cataclysm/aracade-quest.png)

Expand Down
1 change: 1 addition & 0 deletions docs/use-linea/explore/use-linea-l2-domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ In this guide, we'll walk you through how to buy a username!
Before you begin, ensure your wallet is [configured to use Linea](../set-up-your-wallet.md).

## Buy a Username

1. First, navigate to the [Linea L2 Domains](https://www.lineal2.domains/) website and connect your wallet.

![LineaL2 domains shot 1](../../assets/patch/domain-1.png)
Expand Down
13 changes: 6 additions & 7 deletions docs/use-linea/explore/use-mendi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Mendi Finance lending protocol is deployed on Linea testnet. Use the [Mendi app

## Supply collateral

1. Navigate to the [Mendi app](https://testnet.mendi.finance/) and select the Linea network in your MetaMask wallet. (You might need to click on *show/hide test networks* to have testnets appear in the list)
1. Navigate to the [Mendi app](https://testnet.mendi.finance/) and select the Linea network in your MetaMask wallet. (You might need to click on _show/hide test networks_ to have testnets appear in the list)

![Metamask Linea testnet](../../assets/mendi/metamask.png)

Expand All @@ -33,11 +33,11 @@ Mendi Finance lending protocol is deployed on Linea testnet. Use the [Mendi app

![Supply Approve](../../assets/mendi/supply_approve.png)

3. Click **Supply** to confirm and approve the transaction.
1. Click **Supply** to confirm and approve the transaction.

## Borrow tokens

1. Navigate to the [Mendi app](https://testnet.mendi.finance/) and select the Linea network in your MetaMask wallet. (You might need to click on *show/hide test networks* to have testnets appear in the list)
1. Navigate to the [Mendi app](https://testnet.mendi.finance/) and select the Linea network in your MetaMask wallet. (You might need to click on _show/hide test networks_ to have testnets appear in the list)

![Metamask Linea testnet](../../assets/mendi/metamask.png)

Expand All @@ -47,12 +47,11 @@ Mendi Finance lending protocol is deployed on Linea testnet. Use the [Mendi app

1. Select the **Lending** tab. Make sure your supplied assets can be used as **Collateral**!

![Lending Tab](../../assets/mendi/lending.png)
![Collateral](../../assets/mendi/collateral.png)

![Lending Tab](../../assets/mendi/lending.png) ![Collateral](../../assets/mendi/collateral.png)

1. Select USDC/USDT/WETH to borrow from the protocol and click on it.
1. Enter the amount you want to borrow.

![Borrow](../../assets/mendi/borrow2.png)

1. Click **Borrow** to confirm and approve the transaction.
1. Click **Borrow** to confirm and approve the transaction.
41 changes: 16 additions & 25 deletions docs/use-linea/explore/use-mesprotocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ sidebar_position: 1

# MES Protocol

Linea DeFi Week Tutorial
MES Protocol is a cross-rollup orderbook DEX, you can learn more about it [here](https://www.mesprotocol.com/). This guide would walk you through how to complete the tasks. Before you begin, make sure your wallet is [configured to use Linea](https://docs.linea.build/use-linea/set-up-your-wallet), and your wallet is [funded with the Linea faucet](https://docs.linea.build/use-linea/fund).
Linea DeFi Week Tutorial MES Protocol is a cross-rollup orderbook DEX, you can learn more about it [here](https://www.mesprotocol.com/). This guide would walk you through how to complete the tasks. Before you begin, make sure your wallet is [configured to use Linea](https://docs.linea.build/use-linea/set-up-your-wallet), and your wallet is [funded with the Linea faucet](https://docs.linea.build/use-linea/fund).

## Tasks

Expand All @@ -17,40 +16,35 @@ MES Protocol is a cross-rollup orderbook DEX, you can learn more about it [here]
## Switch to Linea Testnet

1. Navigate to [MES Protocol app](https://app.mesprotocol.com/)
2. Switch to Testnet
![mes1](../../assets/mesprotocol/mes1.png)
2. Switch to Testnet ![mes1](../../assets/mesprotocol/mes1.png)
3. Connect wallet
4. Select Linea Testnet and confirm to switch to Linea at your wallet
![mes2](../../assets/mesprotocol/mes2.png)
4. Select Linea Testnet and confirm to switch to Linea at your wallet ![mes2](../../assets/mesprotocol/mes2.png)

## Deposit

1. Click on “Deposit/Withdraw Tokens” and you will be navigated to the Portfolio page
![mes3](../../assets/mesprotocol/mes3.jpeg)
1. Click on “Deposit/Withdraw Tokens” and you will be navigated to the Portfolio page ![mes3](../../assets/mesprotocol/mes3.jpeg)
2. Click on the "Deposit" button at the row of token you want to deposit
3. Input the amount of token you want to deposit and proceed to the next step
4. Approve a spending limit if it is your first time interacting with our contract. Select a suitable spending limit that you are comfortable with. If you have no idea what spending limit to set, just simply use the default setting
5. The Metamask window will pop up again, you can double check the amount and adjust the gas fee if needed; confirm this transaction if everything is fine, a few seconds later you’ll be able to see your token balance updated

## Place an Order (Spot Trading)

1. Tap and choose the cryptocurrency pairs you want to trade.
![mes4](../../assets/mesprotocol/mes4.jpeg)
1. Tap and choose the cryptocurrency pairs you want to trade. ![mes4](../../assets/mesprotocol/mes4.jpeg)
2. Choose to trade in “Single Chain Mode” or “Cross-rollup Mode”, this is what differentiates MES from other DEXs.
- In Single Chain Mode - your order placed is matched and settled with other orders on Linea (your currently connected chain) only.
- In Cross-Rollup Mode, your order could match and settle with orders on any chains supported by MES. You enjoy deeper liquidity in this mode, but you may need to bridge the assets when you withdraw.
![mes5](../../assets/mesprotocol/mes5.png)

- In Single Chain Mode - your order placed is matched and settled with other orders on Linea (your currently connected chain) only.
- In Cross-Rollup Mode, your order could match and settle with orders on any chains supported by MES. You enjoy deeper liquidity in this mode, but you may need to bridge the assets when you withdraw. ![mes5](../../assets/mesprotocol/mes5.png)

3. Choose the order direction to buy or sell the token
4. Choose to place a Market Order or Limit Order
5. Fill in the Limit Price (applicable to Limit Orders only) and the quantity, then place the order.

## Place an Order (MES Convert)

1. Navigate to MES Convert page by selecting “MES Convert” under “Trade”
![mes6](../../assets/mesprotocol/mes6.png)
1. Navigate to MES Convert page by selecting “MES Convert” under “Trade” ![mes6](../../assets/mesprotocol/mes6.png)
2. Select order type - Market Order or Limit Order
3. Select the source chain and token, and the destination chain and token (Linea would be the source and destination chains in this event)
![mes7](../../assets/mesprotocol/mes7.jpeg)
3. Select the source chain and token, and the destination chain and token (Linea would be the source and destination chains in this event) ![mes7](../../assets/mesprotocol/mes7.jpeg)
4. Fill in the amount to send
5. Click “Preview Conversion”
6. The conversion rate is displayed, it is for reference only and the actual settlement rate is subject to the price movement. You can adjust the conversion rate here if you are placing a Limit Order. Click "Submit" if you confirm the details of your trade
Expand All @@ -59,17 +53,14 @@ MES Protocol is a cross-rollup orderbook DEX, you can learn more about it [here]

1. Same as deposit, navigate to the trading page and click on “Deposit/Withdraw Tokens”
2. Click on the "Withdraw" button at the row of token you want to withdraw
3. Choose a withdrawal mode - “Withdraw Linea Balance Only” allows you to withdraw assets on Linea only, or “Withdraw Cross-chain Balance” that aggregates your assets into Linea then and withdraw.
![mes8](../../assets/mesprotocol/mes8.png)
3. Choose a withdrawal mode - “Withdraw Linea Balance Only” allows you to withdraw assets on Linea only, or “Withdraw Cross-chain Balance” that aggregates your assets into Linea then and withdraw. ![mes8](../../assets/mesprotocol/mes8.png)
4. Single Chain Withdrawal - input the withdrawal amount and proceed to withdraw
5. Sign the message on your wallet to confirm the withdrawal
6. Click on “Go to Transfer Records” at the prompt message
![mes9](../../assets/mesprotocol/mes9.png)
7. Claim token to your wallet at “Pending Transfer” page
![mes10](../../assets/mesprotocol/mes10.png)
6. Click on “Go to Transfer Records” at the prompt message ![mes9](../../assets/mesprotocol/mes9.png)
7. Claim token to your wallet at “Pending Transfer” page ![mes10](../../assets/mesprotocol/mes10.png)

## Withdraw Cross-chain Balance
1. Select Linea as the destination chain
![mes11](../../assets/mesprotocol/mes11.png)

1. Select Linea as the destination chain ![mes11](../../assets/mesprotocol/mes11.png)
2. You are then navigated to “MES Convert” page to bridge your selected asset to Linea
3. After you have aggregated your assets to Linea, you can follow Step 4 above to withdraw the assets under Single Chain Withdrawal Mode.
Loading