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

Develop to Main #81

Merged
merged 5 commits into from
Dec 13, 2024
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions docs/02-quickstart/up-in-ten-minutes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ description: Connect to Polymesh

import useBaseUrl from '@docusaurus/useBaseUrl';

To get you started, let's explain what is required: From the Polymesh Wallet to getting your first POLYX, we will go through a step-by-step to be ready to work with Polymesh.
To get you started, let's explain what is required: From a supported wallet to getting your first POLYX, we will go through a step-by-step to be ready to work with Polymesh.

To have an overall starting point for all of the following, we will help you get:

- The Polymesh Wallet through the Google Chrome extension,
- A wallet that is integrated with Polymesh,
- Verified as a user, i.e. complete your identity verification to let you transact with the network, and
- Your first POLYX, so that you can begin paying transaction fees and participate in governance.

---

<OverviewBox title="Get the Wallet" linkHref="../wallet/" linkText="Get the Wallet" imgSrc={useBaseUrl("/img/tmpAssets/07_get_wallet_v2-01.svg")} floating="true">

The fastest way to begin using Polymesh is to create an account with the Polymesh Wallet Chrome Extension.
The fastest way to begin using Polymesh is to create an account with the Polymesh Wallet Chrome Extension or another wallet that supports Polymesh.

This will enable your browser to interact with the Polymesh blockchain. We will help you set up the Wallet extension and will guide you through setting up your new account with one unassigned key.

Expand Down
66 changes: 27 additions & 39 deletions docs/03-originate/dashboard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ title: Token Studio Dashboard
description: Originating assets with no code
---

<YoutubePlayer videoId="-dxy9XN98Vs" />

## Exercise

Let's explore the asset origination process using the Polymesh Wallet, a browser and the Polymesh Token Studio. It will be helpful to consider a hypothetical real-world situation.
Expand All @@ -31,47 +29,33 @@ Since this action is materially significant, Alice will have to first complete [

:::

## 1. Open the dashboard
## 1. Open the Token Studio

![dashboard](images/01-dashboard.png)
Navigate to https://tokenstudio.polymath.network/.

## 2. Navigate to origination

Choose `Token Studio` or navigate directly to https://tokenstudio.polymath.network/.
Click on `Connect Polymesh Wallet`.

![token studio dashboard](images/02-token-studio.png)
![token studio dashboard](images/01-token-studio.png)

The dashboard and the Token Studio may ask you to authorise. This allows the sites to inspect your keys, which lets the site personalise the presentation.
The Token Studio may ask you to authorise. This allows the sites to inspect your keys, which lets the site personalise the presentation.

The site wants to confirm you have access to the private key but cannot authorise signed transactions without further consent, so go ahead and authorise if the wallet prompts you.

![authorise](images/03-token-studio-authorize.png)

## 3. Register for Token Studio

You might be wondering why Token Studio is asking for your name when it is clearly displayed in your wallet.

Recall that network participants have completed [customer due diligence](/docs/quickstart/verification-with-cdd) but this doesn't reveal who they are to other network members. It is the same with Token Studio, which can see the account (when the wallet is authorised) but cannot know the name stored in the wallet (for your own reference) or the information that was provided to the customer due diligence service provider.

![register](images/04-token-studio-register.png)

Sign the transaction.

![sign](images/05-token-studio-register-sign.png)
![authorise](images/02-authorise-wallet.png)

## 4. My tokens
## 3. My tokens

The dashboard shows your tokens. Nothing has been created yet.

Click on `New Security Token`.

![create](images/06-my-tokens-dashboard.png)
![create](images/03-my-tokens.png)

The service provider marketplace is where you will choose your KYC service provider.
Click on 'Go to ticker reservation'.

For now, let's just reserve the symbol.

![reserve symbol](images/07-go-to-ticker.png)
![reserve symbol](images/04-go-to-ticker-reservation.png)

Enter the symbol you want to reserve.

Expand All @@ -91,31 +75,31 @@ You will have to get creative and enter a symbol no one else has reserved.

![available](images/10-symbol-available.png)

## 5. Send the reservation
## 4. Send the reservation

It will cost 1,000 POLYX to reserve the symbol on the blockchain.
:::info
It will cost 25 POLYX protocol fee + 500 POLYX charged by the Token Studio to reserve the symbol on the blockchain.
:::

:::tip

If you are low on POLYX, [get some free Testnet POLYX](/docs/quickstart/quickstart-polyx).
If you are low on POLYX, [get some POLYX](/docs/quickstart/quickstart-polyx).

:::

This will confirm that it is your intention to reserve the symbol and pay for the transaction with your funds.

![confirm reservation](images/12-confirm-symbol.png)
![confirm reservation](images/13-confirm-symbol2.png)

When you click `Confirm` the site will inform the wallet that a signature is needed. Even though the site is authorised to explore the public information held in the wallet, it _always_ asks for your approval before signing transactions.

Since we expected this and we trust this site, click `sign`.

![sign transaction](images/13-confirm-symbol-txn.png)
Review the transaction details presented in the wallet, enter your password, or connect your hardware wallet and click `Sign` to submit the transaction to the blockchain.

In a few moments, the symbol is reserved.

![reserved](images/14-symbol-reserved.png)
![reserved](images/14-symbol-reserved2.png)

## 6. Security token details
## 5. Security token details

You can now proceed to specifying the details of the security this token represents.

Expand All @@ -125,25 +109,29 @@ In practice, not all important business decisions will be finalised at this poin

Let's proceed with a **simple configuration**.

:::info
It will cost 2000 POLYX charged by the Token Studio to configure an asset on the blockchain.
:::

Take a moment to explore the options. This will help you understand the breadth of security tokens that can be created this way. To keep matters simple, enter just a company name, select "Equity Preferred", and leave the rest of the defaults as they are.

![details](images/17-token-details.png)

Token Studio confirms your intentions before asking the wallet to prepare a signed transaction.

![confirm details](images/18-confirm-details.png)
![confirm details](images/18-confirm-details2.png)

The wallet will ask you to sign the transaction.

![sign details txn](images/19-sign-details-txn.png)
![sign details txn](images/19-sign-details-txn2.png)

In a few moments, success! **Your token has been created.**

![success](images/20-success.png)
![success](images/20-success2.png)

Your token will be on your dashboard where you can edit properties from time to time. Take a moment to explore how you can amend and extend the configuration over time.

![success](images/21-success-2.png)
![success](images/21-success2-2.png)

## Links

Expand Down
Binary file added docs/03-originate/images/01-token-studio.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/03-originate/images/02-authorise-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 docs/03-originate/images/03-my-tokens.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/03-originate/images/13-confirm-symbol2.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/03-originate/images/14-symbol-reserved2.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/03-originate/images/18-confirm-details2.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/03-originate/images/20-success2.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/03-originate/images/21-success2-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 3 additions & 8 deletions docs/03-originate/originate-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,7 @@ description: Originating assets with Polymesh
slug: /originate/origination-process/
---

<OverviewVideoBox title="Originating an asset" videoId="Wyp6ljYhm4w">

Watch this webcast episode on the process of originating an asset. How Polymesh is built for security token issuance and what you need to do when working with securities. Adam and Nick explain how assets are originated on Polymesh and discuss the technical and business challenges Polymesh solves.

You can watch [the whole talk](/docs/resources/polymesh-webcast) in one go or pick the parts related to each section of the documentation.

</OverviewVideoBox>
## Originating an asset

Polymesh makes it exceptionally simple to originate a regulated security. There is more than one way to execute the process and your implementation decisions will usually be based on scale.

Expand All @@ -25,10 +19,11 @@ Before we go through a simple practical exercise, let's explore the overall asse

### The token type

The type of a security token asset is represented on Polymesh by its **ticker** registration. This is a 12 character-long, and unique, identifier. If the name reminds you of a ticker as found on a stockmarket, this is intentional. It is expected that certain names are more valuable than others, in the same way that `.com` domains are. Therefore, Polymesh implements an optional reservation mechanism, whereby one can reserve a ticker name for 60 days, as of the time of writing. At any time during these 60 days, the owner of this ticker reservation can cancel the reservation or create the token proper, i.e. **originate** it.
An asset on Polymesh is represented by a unique id that is automatically assigned upon asset creation. This is a 32 hex character hexadecimal string. A **ticker**, which is a unique identifier, can optionally be associated with an asset. This is a 12 character string that can be used to identify the asset in a more human readable way. If the name reminds you of a ticker as found on a stock market, this is intentional. It is expected that certain names are more valuable than others, in the same way that `.com` domains are. Therefore, Polymesh implements an optional reservation mechanism, whereby one can reserve a ticker name for 60 days, as of the time of writing. At any time during these 60 days, the owner of this ticker reservation can attach it to an asset they have created to permanently reserve it.

At origination, there are some considerations available, among others:

- the asset name,
- the asset type,
- attached **documentation** and other metadata,
- **extra compliance requirements** of eventual asset owners, and
Expand Down
161 changes: 0 additions & 161 deletions sdk-docs_versioned_docs/version-23.2.x/README.md

This file was deleted.

Loading
Loading