Skip to content

Commit

Permalink
Merge branch 'develop' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreyKortosov authored Nov 4, 2024
2 parents b5505f6 + 59a57de commit a075d96
Show file tree
Hide file tree
Showing 61 changed files with 276 additions and 46 deletions.
14 changes: 5 additions & 9 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ export default withMermaid(
{ text: "Create an Address", link: "create-an-address" },
{ text: "Account Security", link: "account-security" },
{ text: "Connect Wallet", link: "polkaswap-connect-wallet" },
{ text: "Connect with Google", link: "polkaswap-connect-with-google" },
{
text: "Send & Receive",
link: "send-and-receive",
Expand All @@ -189,7 +190,7 @@ export default withMermaid(
},
{ text: "Transfer Assets", link: "transfer" },
{ text: "Check Balance", link: "check-balance" },
{ text: "Register an Asset", link: "register-an-asset" },
{ text: "Create token in SORA", link: "create-token" },
{ text: "On-ramp", link: "on-ramp" },
{
text: "Staking",
Expand Down Expand Up @@ -298,14 +299,9 @@ export default withMermaid(
collapsed: false,
items: [
{ text: "Overview", link: "participate" },
{
text: "Connect Wallet",
link: "polkaswap-connect-wallet",
},
{
text: "Send & Receive",
link: "send-and-receive-polkaswap",
},
{ text: "Connect Wallet", link: "polkaswap-connect-wallet", },
{ text: "Connect with Google", link: "polkaswap-connect-with-google" },
{ text: "Send & Receive", link: "send-and-receive-polkaswap", },
{
text: "Explore the Ecosystem",
items: [
Expand Down
Binary file modified src/.gitbook/assets/choose-wallet-to-connect.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 src/.gitbook/assets/connect-account-tg.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 src/.gitbook/assets/connect-wallet-tg.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 modified src/.gitbook/assets/connect-wallet.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 src/.gitbook/assets/connect-with-sora-tg.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 src/.gitbook/assets/connect-with-wc-tg.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 modified src/.gitbook/assets/convert-address-subscan-converter.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 modified src/.gitbook/assets/convert-address-transform.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 modified src/.gitbook/assets/create-address-app-add-account.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 modified src/.gitbook/assets/create-address-app-authorize.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 modified src/.gitbook/assets/create-address-app-mnemonic.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 modified src/.gitbook/assets/create-address-app-name-password.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 modified src/.gitbook/assets/create-address-app-save.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 modified src/.gitbook/assets/create-address-app-synced.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 modified src/.gitbook/assets/create-address-app-view-accounts.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.
Binary file modified src/.gitbook/assets/create-address-browser-create.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 modified src/.gitbook/assets/create-address-browser-mnemonic.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 modified src/.gitbook/assets/create-address-browser-name-password.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 modified src/.gitbook/assets/create-address-cn-prefix.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 modified src/.gitbook/assets/create-address-sora-biometry-auth.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 modified src/.gitbook/assets/create-address-sora-confirm-mnemonic.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 modified src/.gitbook/assets/create-address-sora-create.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 modified src/.gitbook/assets/create-address-sora-enter-name.png
Binary file modified src/.gitbook/assets/create-address-sora-enter-pin.png
Binary file modified src/.gitbook/assets/create-address-sora-options.png
Binary file added src/.gitbook/assets/import-sora-tg.png
Binary file modified src/.gitbook/assets/restore-account-biometry-auth.png
Binary file modified src/.gitbook/assets/restore-account-enter-mnemonic.png
Binary file modified src/.gitbook/assets/restore-account-import.png
Binary file modified src/.gitbook/assets/restore-account-restored.png
Binary file modified src/.gitbook/assets/restore-account-setup.png
Binary file modified src/.gitbook/assets/restore-account-sora-enter-mnemonic.png
Binary file modified src/.gitbook/assets/restore-account-sora-enter-pin.png
Binary file modified src/.gitbook/assets/restore-account-sora-import.png
Binary file added src/.gitbook/assets/restore-account-tg-import.png
Binary file added src/.gitbook/assets/use-wallet-connect.png
Binary file added src/assets/account-button-create.jpg
Binary file added src/assets/button-create-token.jpg
Binary file added src/assets/confrim-create-token.jpg
Binary file added src/assets/create-token.jpg
Binary file added src/assets/new-token-details.jpg
Binary file added src/assets/new-token-in-portfolio.jpg
92 changes: 77 additions & 15 deletions src/create-an-address.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,13 @@ Here we provide you with instruction on account creation:
- [via polkadot.js browser plugin](#via-polkadotjs-browser-plugin)
- [via polkadot.js application](#via-polkadotjs-app-ui)
- [via SORA mobile application](#via-sora-mobile-application)
- [via Polkaswap Telegram
application](#via-polkaswap-telegram-application)

::: tip
You can also create a SORA account using [Google](/polkaswap-connect-with-google.md)
:::
::: tip

We recommend using the SORA testnet for practice exercises. Here are the Testnet links:

Expand All @@ -47,29 +52,29 @@ Use a Chrome or Firefox browser.

2. Open the extension and confirm that you understand the disclaimer.

<center><img src="/.gitbook/assets/create-address-browser-polkadot-confirm.png" width="400"></center>
![](.gitbook/assets/create-address-browser-polkadot-confirm.png)

3. Create the account. You should click on the `+` button

<center><img src="/.gitbook/assets/create-address-browser-create.png" width="400"></center>
![](.gitbook/assets/create-address-browser-create.png)

You'll see the mnemonic. **Never share it with anyone** and don't use the same one as the screenshot (_this is just a demonstration, you will be assigned another_). **Keep this passphrase secure because it's the only way to restore your account.**

<center><img src="/.gitbook/assets/create-address-browser-mnemonic.png" width="400"></center>
![](.gitbook/assets/create-address-browser-mnemonic.png)

4. Click the checkbox and move on to the next step.

5. Enter an account name and password then proceed

<center><img src="/.gitbook/assets/create-address-browser-name-password.png" width="400"></center>
![](.gitbook/assets/create-address-browser-name-password.png)

The new account is now created

<center><img src="/.gitbook/assets/create-address-browser-account-created.png" width="400"></center>
![](.gitbook/assets/create-address-browser-account-created.png)

6. Now you should change the address format so that it begins with `cn`. Open Settings and select Displayed Address format. It should be SORA network.

<center><img src="/.gitbook/assets/create-address-browser-change-to-sora-network.png" width="400"></center>
![](.gitbook/assets/create-address-browser-change-to-sora-network.png)

Great job! Now you have an address with the `cn` prefix

Expand All @@ -81,31 +86,31 @@ Use a Chrome or Firefox browser.

If you've already installed the Polkadot browser plugin, it will request authorization to sync data. You can do it, as it will make account management easier.

![](.gitbook/assets/create-address-app-authorize.png)
![](.gitbook/assets/create-address-app-authorize.png)

2. Open the [Accounts](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fws.stage.sora2.soramitsu.co.jp#/accounts) page.

If you allow the Polkadot browser plugin to sync, then your accounts will appear in the Polkadot.js app.

![](.gitbook/assets/create-address-app-synced.png)
![](.gitbook/assets/create-address-app-synced.png)

You can create a new account.
You can create a new account.

3. Click Add account:

![](.gitbook/assets/create-address-app-add-account.png)
![](.gitbook/assets/create-address-app-add-account.png)

4. Save the mnemonic phrase, **make sure to keep it safe, and don't share it**. Confirm that you've saved the mnemonic and click Next.

![](.gitbook/assets/create-address-app-mnemonic.png)

5. Enter a name and a password for the account, then click Next.

![](.gitbook/assets/create-address-app-name-password.png)
![](.gitbook/assets/create-address-app-name-password.png)

6. After the confirmation click Save.

![](.gitbook/assets/create-address-app-save.png)
![](.gitbook/assets/create-address-app-save.png)

Now you have two accounts. One was injected from the Polkadot browser plugin and the second one was created in the Polkadot js app.

Expand Down Expand Up @@ -141,7 +146,7 @@ When you install the application you'll be able to create an account.

::: tip

The passphrase is the only way to recover the account in case of changing the mobile phone, logging out of the application, or other emergency cases.
Your passphrase is the only way to recover the account in case you change/lose your mobile phone, log out of the application, or other emergency cases.

:::

Expand All @@ -157,7 +162,48 @@ When you install the application you'll be able to create an account.

![](.gitbook/assets/create-address-sora-biometry-auth.png)

#### Restoring account from mnemonic in different applications
## Via Polkaswap Telegram Application

You can create an account on SORA with Style and Freedom using the
[Polkaswap Telegram app](https://t.me/polkaswap_io_bot/app).

1. Follow the
[connect wallet
flow](/polkaswap-connect-wallet.md#polkaswap-telegram-app) until the
SORA account options.

![](.gitbook/assets/connect-with-sora-tg.png)

2. Pick the create account section.
::: tip
Have a pen and paper handy to save the mnemonic phrase somewhere
safe. Ideally keep it offline.
:::

![](.gitbook/assets/create-address-sora-tg-passphrase.png)

3. After writing down your mnemonic or copying it, click next step and
input the phrase to confirm. (_You can also chose to skip this
option, the outcome is the same_)

![](.gitbook/assets/create-address-sora-tg-confirm.png)

4. Then, give your account a name and set a unique password. You can
also toggle the switch to allow JSON export to restore your
account. Fill in the information and finally click/tap create account.
::: info
If you chose to enable JSON exports, make sure you keep your JSON file
safe and do not share it with anyone.
:::

![](.gitbook/assets/create-address-sora-tg-details.png)

5. After creating your account, you will be able to use it immediately
on the Polkaswap Telegram application!

![](.gitbook/assets/create-address-sora-tg-success.png)

## Restoring account from mnemonic in different applications

The only way to restore the account in all applications is a mnemonic passphrase. The Polkadot.js browser plugin supports more options, however, the mobile application only supports a mnemonic passphrase. You can use a mnemonic passphrase from the mobile application in order to get access to [polkaswap.io](http://polkaswap.io) or [test.polkaswap.io](http://test.polkaswap.io) and vice-versa.

Expand Down Expand Up @@ -201,7 +247,23 @@ The process is the same for the mobile application:

![](.gitbook/assets/restore-account-biometry-auth.png)

#### Converting the address format
To restore an account using the Telegram App, the process is very
easy.

1. In the Connect with SORA Wallet section, click Import Account

![](.gitbook/assets/connect-with-sora-tg.png)

2. Input your mnemonic phrase or draag&drop/choose a JSON account file.

![](.gitbook/assets/restore-account-tg-import.png)

3. Give you account a name and password, then tap
import. Congratulations, you have restored your account.

![](.gitbook/assets/restore-account-tg-rename.png)

## Converting the address format

As mentioned before, Substrate networks use different address prefixes for generating addresses. However, the key pair is the same. If you create an account, but get the address without the `cn` prefix, then you can convert it using the [Subscan address converter](https://sora.subscan.io/tools/ss58_transform).

Expand Down
77 changes: 77 additions & 0 deletions src/create-token.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: "Create a new token in SORA Network | SORA Docs"
head:
- - meta
- name: description
content: Explore the process of creating a token on the SORA network. Learn how community members can create a new token and contribute to the development of the SORA ecosystem by submitting their ideas and collaborating with the SORA team.
- - meta
- name: keywords
content: adding tokens, Polkaswap, SORA network, listing tokens, requirements, procedures, blockchain networks, whitelist, create token, create a new token, register a new token
---

# How to Create a Token on the SORA Network

## TL;DR

- This guide provides a step-by-step process for creating tokens on the SORA network, ensuring a smooth and straightforward experience.
- As a decentralized network, SORA invites everyone to participate in the growth of the new economy, and creating a new token is one of the many ways to get involved.

## Connect Your Wallet

Before creating a new token, you need to connect your crypto wallet with Polkaswap. Please follow the instructions on this page: [Connect Your Wallet to Polkaswap](./polkaswap-connect-wallet.md)

Alternatively, you can create an account and wallet on the SORA network using your Google account. Instructions for this process are available here: [Connect With Google](./polkaswap-connect-with-google.md)

We recommend to add XOR to the account to pay the fee for token creation. For that, you can [move either XOR or another ERC-20 token](https://wiki.sora.org/guides/how-to-transfer-from-ethereum-mainnet-to-sora-v2-hashi-bridge), such as ETH or DAI, that you can then exchange to XOR on [Polkaswap](https://polkaswap.io/#/swap).

## Create a New Token

Open the Account page from the menu on the right. In the top-right corner of the central panel, find and click the "Create" button, which is represented by a star icon.

![](./assets/account-button-create.jpg)

A new panel will appear where you can select your token and enter the required information. Fill in the following details:

- `Token Symbol`: A unique identifier for the token, which can be between 1 and 7 characters.
- `Token Name`: The name of the token, which can be between 1 and 33 characters.
- `Token Supply`: The total number of tokens you will receive upon creation.

::: info
If you want the option to mint more tokens in the future, enable the **Extensible Supply** toggle. Otherwise, leave it turned off.
:::

![](./assets/create-token.jpg)

Below the "Create" button, you will see the Network Fee displayed in XOR, calculated based on the current USD price.

![](./assets/button-create-token.jpg)

After clicking the "Create" button, a central panel will display a confirmation of your action along with all the information you provided.

![](./assets/confrim-create-token.jpg)

The process of creating and minting your new token will begin. Within a few seconds, your token will appear in your portfolio and will have an address on the SORA network.

![](./assets/new-token-in-portfolio.jpg)

Open your token to view its details, operation history, and available functions such as send, swap, add liquidity, bridge transfer, and QR code transactions.

![](./assets/new-token-details.jpg)

Note: Initially, your token might display a question mark instead of an icon, and it may lack additional information. Follow the next steps to address this.

## Next Steps

After creating your new token on the SORA network, you need to add it to Polkaswap. For detailed instructions, please refer to this page: [Whitelist a Token on Polkaswap](./whitelist-token-to-polkaswap.md)

::: info
Please note that adding token to SORA network does not mean that it
will automatically be allowed to be transferred through the HASHI
bridge. To add your token to the HASHI bridge, please, check out
[Adding a Token to the HASHI Bridge](../snippets/../adding-tokens-to-hashi-bridge).
:::

## Learn More

- [Whitelist a Token on Polkaswap](./whitelist-token-to-polkaswap.md)
- [SORA Builders Programme](/sora-builders)
8 changes: 0 additions & 8 deletions src/kensetsu-vaults.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,6 @@ The stability fee that will be charged from these vaults will be used in a stabi

![](/.gitbook/assets/ken-vaults-intro.png)

::: info
Kensetsu has not been released on the mainnet yet. You can test the features on the [Polkaswap Testnet](https://test.polkaswap.io/#/vaults/).
:::

![](/.gitbook/assets/ken-vaults-borrow.png)

The vault creation interface has several input fields:
Expand Down Expand Up @@ -102,10 +98,6 @@ These are the parameters visible on the Open Position interface:

Congratulations, you have successfully set up your Kensetsu vault.

:::info
The images provided in this tutorial correspond to the Kensetsu Testnet and may be subject to change once released on the mainnet.
:::

## Learn More

- [KEN Tokenomics](/ken.md)
Expand Down
76 changes: 65 additions & 11 deletions src/polkaswap-connect-wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,80 @@ head:

# Connect Your Wallet to Polkaswap

With the constant improvements making Polkaswap more stylish and free,
there are more ways to connect your account. In this section, we will
cover how to connect your account to the web app and Telegram mini
app.

## Polkaswap Web App

1. Go to [Polkaswap.io](https://polkaswap.io) and click on the "Connect account" button at the top of the page.

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

2. You will see a list of supported wallet options to connect, including [Fearless Wallet](https://fearlesswallet.io), Polkadot.js, Subwallet, and Talisman.
2. You will see a list of supported wallet options to connect,
including an account created on [Google](/polkaswap-connect-with-google.md), [Fearless Wallet](https://fearlesswallet.io),
Polkadot.js, as well as Wallet Connect and other
[Polkadot-compatible
wallets](https://wiki.polkadot.network/docs/wallets-and-extensions)
that support SORA.

![](.gitbook/assets/choose-wallet-to-connect.png)
![](.gitbook/assets/choose-wallet-to-connect.png)

3. Select the wallet extension installed on your browser. For example, if you are using Fearless Wallet, click on the Fearless Wallet option.
4. A pop-up window will appear from your selected wallet extension, asking you to confirm the connection to Polkaswap. Click "Confirm" to proceed.
5. After the connection has been established, you will see a list of your available accounts displayed on the Polkaswap page. Choose the account you want to use and click on it.
4. A pop-up window will appear from your selected wallet extension,
asking you to confirm the connection to Polkaswap. Click "Confirm"
to proceed.
5. If you chose Wallet Connect, a popup with a QR code will appear for
you to scan with your mobile wallet, otherwise you can copy the link.

![](.gitbook/assets/use-wallet-connect.png)

6. After the connection has been established, you will see a list of your available accounts displayed on the Polkaswap page. Choose the account you want to use and click on it.

![](.gitbook/assets/select-an-account.png)

7. Once the connection is complete, you will be able to see your
account balance and manage your funds on Polkaswap.

## Polkaswap Telegram App

1. Access the [Polkaswap Telegram app](https://t.me/polkaswap_io_bot/app) and
launch the bot.

![](.gitbook/assets/connect-wallet-tg.png)

2. Click on the wallet icon on the top right or the connect account
button on the main screen.

![](.gitbook/assets/connect-account-tg.png)

3. You can either connect a SORA account or use Wallet Connect. If you
chose to connect a SORA account, you have the option to create a
new account directly in the interface or import an existing account
with your mnemonic phrase or a json file.

::: info
Follow the [Create an Address
flow](/create-an-address.md#via-polkaswap-telegram-application) if you
do not have a SORA address yet, or [restore an existing address](create-an-address.md#restoring-account-from-mnemonic-in-different-applications) if you already have one.
:::

![](.gitbook/assets/connect-with-sora-tg.png)

![](.gitbook/assets/import-sora-tg.png)

4. If you choose to use Wallet Connect, the interface is very similar
to the web app, where you can scan the QR or copy the code for your
wallet.

![](.gitbook/assets/connect-with-wc-tg.png)

![](.gitbook/assets/select-an-account.png)
Congratulations, you have successfully connected your wallet! Now you can stake, provide liquidity, trade, and much more with style and freedom on Polkaswap!

6. Once the connection is complete, you will be able to see your account balance and manage your funds on Polkaswap.
Congratulations, you have successfully connected your wallet! Now you can stake, provide liquidity, trade, and much more with style and freedom on Polkaswap!
Remember to always do your own research before making any financial
decisions.
_Remember to always do your own research before making any financial decisions._

## Learn More
## Learn More

- [Create an Address](/create-an-address.md)
- [Account Security](/account-security.md)
Loading

0 comments on commit a075d96

Please sign in to comment.