Skip to content

Commit

Permalink
sdk2 release (#176)
Browse files Browse the repository at this point in the history
* fix(doc): add to sidebar and remove alpha warnings

* docs: remove alpha
  • Loading branch information
Maksandre authored Oct 4, 2024
1 parent 08715c0 commit a765c3e
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 23 deletions.
32 changes: 16 additions & 16 deletions docs/.vuepress/configs/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,20 +56,7 @@ export const sidebar: Record<string, SidebarConfig> = {
]
},
{
text: 'SDK',
children: [
'/build/sdk/getting-started.md',
'/build/sdk/accounts.md',
'/build/sdk/collections.md',
'/build/sdk/tokens.md',
'/build/sdk/examples-nesting.md',
'/build/sdk/refungible.md',
'/build/sdk/sponsoring.md',
'/build/sdk/v2/migration.md'
]
},
{
text: 'SDK-2.0 [Alpha]',
text: 'SDK-2.0',
children: [
'/build/sdk/v2/quick-start.md',
'/build/sdk/v2/balances.md',
Expand All @@ -81,6 +68,19 @@ export const sidebar: Record<string, SidebarConfig> = {
'/build/sdk/v2/dapps.md',
]
},
{
text: 'SDK-1.0',
children: [
'/build/sdk/getting-started.md',
'/build/sdk/accounts.md',
'/build/sdk/collections.md',
'/build/sdk/tokens.md',
'/build/sdk/examples-nesting.md',
'/build/sdk/refungible.md',
'/build/sdk/sponsoring.md',
'/build/sdk/v2/migration.md'
]
},
{
text: 'EVM',
children: [
Expand All @@ -103,8 +103,8 @@ export const sidebar: Record<string, SidebarConfig> = {
{
text: 'Tech Concepts',
children: [
'/about/tech-concepts/addresses',
'/about/tech-concepts/balances/index.md',
'/build/tech-concepts/addresses',
'/build/tech-concepts/balances/index.md',
]
}
],
Expand Down
5 changes: 2 additions & 3 deletions docs/build/sdk/v2/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,18 @@ All transactions require a fee so that you can use Opal tokens for test purposes

Install `@unique-nft/sdk` for Unique Network interaction and `@unique-nft/sr25519` for account management.

<!-- TODO remove alpha after release -->
<CodeGroup>
<CodeGroupItem title="NPM" active>

```bash:no-line-numbers
npm install @unique-nft/sdk@alpha @unique-nft/sr25519
npm install @unique-nft/sdk @unique-nft/sr25519
```

</CodeGroupItem>
<CodeGroupItem title="YARN">

```bash:no-line-numbers
yarn add @unique-nft/sdk@alpha @unique-nft/sr25519
yarn add @unique-nft/sdk @unique-nft/sr25519
```

</CodeGroupItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
An address represents an identity - usually of a person or an organization - capable of making transactions or holding funds.
Although addresses are most often used to represent a person, that doesn't have to be the case. An address can be used to perform operations
on behalf of a user or another entity or to perform operations autonomously. In addition, any single person or entity could have multiple
addresses for different purposes. All [our networks](../../networks.md) are Substrate-based blockchains, and you can have specialized addresses for holding funds that
addresses for different purposes. All [our networks](../../../about/networks.md) are Substrate-based blockchains, and you can have specialized addresses for holding funds that
are separate from addresses used for making transactions.

### Substrate addresses
Expand Down Expand Up @@ -39,7 +39,7 @@ Address.substrate.decode('yGJ7zjEaVLKPVVM39VoHt1YQtwU2VCfGeRGHX4j2Ap8WzzB6L')

The result is the following. Please note that both calls give the same result since we receive a public key, which is the same in both addresses; they are equal, just presented in different formats (Unique and Quartz).

![public key](../../images/array-address.png)
![public key](../../../about/images/array-address.png)

Now, let's use another decoder that will provide not only a public key as a result.

Expand All @@ -56,9 +56,9 @@ array will be 42). This depends on how many bites are needed to store a prefix v
Checksum is calculated using both prefix and public key. Thus, these values depend
on the chain prefix, as well.

![full address](../../images/array-full.png)
![full address](../../../about/images/array-full.png)

![prefix 42](../../images/prefix42.png)
![prefix 42](../../../about/images/prefix42.png)

The reverse operation will show that the encoding and decoding work in both directions.

Expand Down
File renamed without changes.
File renamed without changes

0 comments on commit a765c3e

Please sign in to comment.