Skip to content

Commit

Permalink
Merge branch 'main' of github.com:AstarNetwork/astar-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PierreOssun committed Sep 15, 2023
2 parents 8d84777 + 15f54f0 commit 15110b0
Show file tree
Hide file tree
Showing 251 changed files with 501 additions and 245 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/firebase-hosting-pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# https://github.com/firebase/firebase-tools

name: Deploy to Firebase Hosting on PR
'on': pull_request_target
'on': pull_request
jobs:
build_and_preview:
if: '${{ github.event.pull_request.head.repo.full_name == github.repository }}'
Expand Down
2 changes: 1 addition & 1 deletion CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

#For Any PR related to anything outside of /i18n folder requires an approval by someone from @AstarNetwork/documentation.
#Source https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-pull-request-reviews-before-merging
* @AstarNetwork/documentation @AstarNetwork/astar-core-dev
* @AstarNetwork/documentation-maintainers @AstarNetwork/astar-core-dev

#Any PR related to /i18n/ folder can be approved by @AstarNetwork/ambassadors members (Linguistars)
/i18n/* @AstarNetwork/ambassadors
Expand Down
2 changes: 1 addition & 1 deletion docs/build/EVM/developer-tooling/banana.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,4 +338,4 @@ To learn more about Banana Wallet head over to [banana docs](https://banana-wall

Full tutorial code is available [here](https://github.com/Banana-Wallet/banana-tutorial/tree/feat/shibuya-tutorial)

If your dApp already uses Rainbowkit then you can use Banana Wallet directly on Shibuya testnet. Please refer [here](https://banana-wallet-docs.rizelabs.io/integration/sdk-integration-tutorial/banana-less-than-greater-than-shibuya) for more information.
If your dApp already uses Rainbowkit then you can use Banana Wallet directly on Shibuya testnet. Please refer [here](https://docs.bananahq.io/integration/wallet-connectors/using-rainbowkit) for more information.
4 changes: 2 additions & 2 deletions docs/build/EVM/precompiles/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The Frontier EVM used on Astar network provides several useful precompiled contr
| [Batch](batch.md) | 0x0000000000000000000000000000000000005006 |
| [assets-erc20](xc20.md) | ASSET_PRECOMPILE_ADDRESS_PREFIX |

The interface descriptions for these precompiles can be found in the `precompiles` folder: [astar-frame repo](https://github.com/AstarNetwork/astar-frame/).
The interface descriptions for these precompiles can be found in the `precompiles` folder: [Astar repo](https://github.com/AstarNetwork/Astar/).
The Addresses can be checked in the [Astar repo](https://github.com/AstarNetwork/Astar/tree/master/runtime) for each runtime in `precompile.rs` files.

# Usage Example
Expand All @@ -54,7 +54,7 @@ contract A {

Example use: check `current era` and `total staked amount` in the `pallet-dapps-staking` for Shiden Network. For this example we will use Remix.

1. Copy `DappsStaking.sol` from [astar-frame repo](https://github.com/AstarNetwork/astar-frame/) and create new contract in Remix:
1. Copy `DappsStaking.sol` from [Astar repo](https://github.com/AstarNetwork/Astar/) and create new contract in Remix:

![](https://i.imgur.com/mr0TcLq.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/EVM/precompiles/staking.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

The dApp Staking Precompile allows EVM smart contracts to access `pallet-dapps-staking` functionality.

For more information see `precompiles/dapps-staking/DappsStaking.sol` in the [`astar-frame` repository](https://github.com/AstarNetwork/astar-frame/).
For more information see `precompiles/dapps-staking/DappsStaking.sol` in the [`Astar` repository](https://github.com/AstarNetwork/Astar/).
2 changes: 1 addition & 1 deletion docs/build/EVM/precompiles/xc20.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

XC20 standard, created by the Moonbeam team, ensures compatibility between the EVM and Substrate framework that powers Polkadot via precompiles — special built-in smart contracts made to look like ERC20s. Calling functions on an XC20 invokes underlying Substrate functionality, which could be instructions to move tokens to another chain, or send them to another local address. This compatibility layer connects the world of EVM and smart contracts to advanced Substrate-based interoperability scenarios.

For XC20 overview see the following page (/docs/learn/xcm/building-with-xcm/create-xc20-assets).
For XC20 overview see the following [page](/docs/learn/interoperability/xcm/building-with-xcm/create-xc20-assets).

# See also

Expand Down
6 changes: 3 additions & 3 deletions docs/build/EVM/precompiles/xcm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ The XCM Precompile provides the following functions to handle specific XCM opera

| Function | Description |
| -------- | -------- |
| `assets_withdraw` (/docs/learn/xcm/building-with-xcm/xc-assets-withdraw) | Withdraw previously transferred assets |
| `assets_reserve_transfer` (/docs/learn/xcm/building-with-xcm/xc-reserve-transfer/) | Transfer assets to a remote chain |
| `remote_transact` (/docs/learn/xcm/building-with-xcm/xc-remote-transact/) | Execute a transaction on a remote chain |
| `assets_withdraw` (/docs/learn/interoperability/xcm/building-with-xcm/xc-assets-withdraw) | Withdraw previously transferred assets |
| `assets_reserve_transfer` (/docs/learn/interoperability/xcm/building-with-xcm/xc-reserve-transfer/) | Transfer assets to a remote chain |
| `remote_transact` (/docs/learn/interoperability/xcm/building-with-xcm/xc-remote-transact/) | Execute a transaction on a remote chain |
2 changes: 1 addition & 1 deletion docs/build/Introduction/create_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 3
---

# Create Account
If you never created a native Astar account, please follow the instructions in the [User Guide](/docs/use/Manage%20wallets/create-wallet).
If you never created a native Astar account, please follow the instructions in the [User Guide](/docs/use/manage-wallets/create-wallet).

If you are building EVM smart contracts you will need Metamask. Watch this short video to learn how.

Expand Down
2 changes: 1 addition & 1 deletion docs/build/environment/zombienet-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ For all steps, encoded call data will be provided to simplify the process for th
After completing the previous steps, cross-chain SDN and SBY wrappers are configured as payable and sufficient assets.
The following steps will explain how to execute a cross-chain remote call. `Alice` will send an instruction from `Shiden` to execute `System::remark_with_event` on `Shibuya`.

`Alice` isn't able to directly control `Alice` on the destination chain, instead a new account will be derived. More information can be found [here](/docs/learn/xcm/building-with-xcm/xc-remote-transact.md#derived-remote-accounts).
`Alice` isn't able to directly control `Alice` on the destination chain, instead a new account will be derived. More information can be found [here](/docs/learn/interoperability/xcm/building-with-xcm/xc-remote-transact.md#derived-remote-accounts).

1. Calculate `Alice's` derived account on `Shibuya` when sending instructions from `Shiden`.
```
Expand Down
6 changes: 3 additions & 3 deletions docs/build/integrations/wallets/transak.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ Follow their handy guides to get started on exploring and integrating Transak as

This guide will lay out the end-to-end steps for onboarding with Transak and integration, up to the point users are able to make live transactions:

[Onboarding and Integration Process Overview](<https://transak.gitbook.io/transak-docs/transak-partner-onboarding-process/onboarding-and-integration-process-overview>)
[Onboarding and Integration Process Overview](https://docs.transak.com/docs/onboarding-and-integration-process-overview)

### Jump right in and start playing around

Would you like to explore and see what's possible with Transak first before onboarding? Feel free to [set up an account](https://transak.gitbook.io/transak-docs/quick-guides/create-a-partner-account-and-access-the-dashboard) and [create a demo integration](https://transak.gitbook.io/transak-docs/quick-guides/testing-your-integration-and-customization-setup). They can be done in only a few minutes.
Would you like to explore and see what's possible with Transak first before onboarding? Feel free to [set up an account](https://docs.transak.com/docs/setup-your-partner-account) and [create a demo integration](https://docs.transak.com/docs/integration-options). They can be done in only a few minutes.

Additionally, there are other guides available, such as [using the Partner dashboard](https://transak.gitbook.io/transak-docs/quick-guides/using-the-partner-dashboard).
Additionally, there are other guides available, such as [using the Partner dashboard](https://dashboard.transak.com/).
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ There are two implementations: one in the runtime and one on the ink! side.

#### Runtine

Implementation of the chain extension on runtime side is available on [astar-frame repository](https://github.com/AstarNetwork/astar-frame/), under `chain-extensions` folder
Implementation of the chain extension on runtime side is available on [Astar repository](https://github.com/AstarNetwork/Astar/), under `chain-extensions` folder

#### ink! implementation

Expand Down
2 changes: 1 addition & 1 deletion docs/build/wasm/swanky-suite/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ This documentation's sub-sections on usage of [Swanky CLI](/docs/build/wasm/swan
[ink! language] repo and specification

[`pallet-contracts`]: https://github.com/paritytech/substrate/tree/master/frame/contracts
[`pallet-dapps-staking`]: https://github.com/AstarNetwork/astar-frame/tree/polkadot-v0.9.27/frame/dapps-staking
[`pallet-dapps-staking`]: https://github.com/AstarNetwork/Astar/tree/polkadot-v0.9.27/frame/dapps-staking
[`pallet-assets`]: https://github.com/paritytech/substrate/tree/master/frame/assets
[`swanky-node` github repo]: https://github.com/AstarNetwork/swanky-node
[`swanky` cli github repo]: https://github.com/AstarNetwork/swanky-cli
Expand Down
4 changes: 4 additions & 0 deletions docs/build/zkEVM/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Astar zkEVM",
"position": 9
}
5 changes: 5 additions & 0 deletions docs/build/zkEVM/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Astar zkEVM

### This is where you will find information about building on Astar zkEVM, a Layer 2 scaling solution for Ethereum powered by Polygon CDK.

More information coming soon!
3 changes: 3 additions & 0 deletions docs/learn/Proxies.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
sidebar_position: 8
---
# Proxy accounts

## Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Learn",
"position": 2
"position": 1
}
6 changes: 3 additions & 3 deletions docs/learn/accounts.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 2
---
# Accounts
## Overview
Expand All @@ -25,8 +25,8 @@ Astar EVM side allows Ethereum-style addresses (H160 format), which is 40+2 hex-


## Learn more
[Create a Substrate account](/docs/use/Manage%20wallets/create-wallet.md)
[Create a Substrate account](/docs/use/manage-wallets/create-wallet.md)

[Create an EVM account](/docs/use/EVM%20guides/setup-metamask.md)
[Create an EVM account](/docs/use/evm-guides/setup-metamask.md)

[Read about Substrate accounts](https://docs.substrate.io/learn/accounts-addresses-keys/)
2 changes: 1 addition & 1 deletion docs/learn/astar-tokens.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 3
---
# Astar Token

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/astar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
---

# What is Astar Network
# About Astar Network

[Astar Network]: https://astar.network/

Expand Down
3 changes: 3 additions & 0 deletions docs/learn/build2earn.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
sidebar_position: 4
---
# Build2Earn

## Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/glossary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 5
---

# Glossary
Expand Down
30 changes: 29 additions & 1 deletion docs/learn/index.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# Learn all about Astar Network in this Section
# Learn
Greetings! We are delighted to welcome you to the educational segment of the Astar Docs.

Whether you're an aspiring developer or a newcomer to the world of blockchain, this section provides comprehensive insights into the inner workings of Astar network. Starting from the basics such as accounts, we delve into the intricate protocols that fuel the functionality of Astar.

To expand your knowledge about building applications or utilizing various tools on Astar, we recommend exploring the [build](/docs/build) section.

## Foundations
[About Astar](/docs/learn/astar)

[Astar Tokens](docs/learn/astar-tokens)

[Account](/docs/learn/Accounts)

[Polkadot](/docs/learn/polkadot_relay)

[Build2Earn](/docs/learn/build2earn)

[Smart Contracts](/docs/learn/smart-contracts)

## Advanced
[Tokenomics](/docs/learn/tokenomics/)

[Networks](/docs/learn/networks)

[Multichain Interoperability](/docs/learn/interoperability/xcm)

[Proxy Accounts](/docs/learn/Proxies.md)

[zkEVM](/docs/learn/zkEVM)
2 changes: 1 addition & 1 deletion docs/learn/interoperability/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Interoperability",
"position": 10
"position": 11
}
4 changes: 2 additions & 2 deletions docs/learn/interoperability/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Yes. visit Polkadot.js, connect your wallet and go to Network > Balances and sel

### Q: I used XCM to transfer 5 DOT from Polkadot to Astar, but only received 4.999

Please note that the gas amount will be deducted from the amount entered, so the amount transferred should be adjusted according to account for the gas fee estimate. For more information, visit [here] (https://docs.astar.network/docs/xcm/using-xcm/xcm-transactions).
Please note that the gas amount will be deducted from the amount entered, so the amount transferred should be adjusted according to account for the gas fee estimate. For more information, visit [here] (https://docs.astar.network/docs/learn/interoperability/xcm/using-xcm/xcm-transactions).

### Q: My balance should be 1.00012 DOT but the Portal is displaying 1 DOT, where are they?

Expand All @@ -28,7 +28,7 @@ You can send back DOT/KSM to the Relay Chain using both EVM and native wallets.

### Q: Why is the XCM button for DOT/KSM disabled when I connect my wallet on the Astar Portal?

Ensure you have a non-zero balance of the native token as described in [this section] (https://docs.astar.network/docs/xcm/using-xcm/xcm-transactions).
Ensure you have a non-zero balance of the native token as described in [this section](https://docs.astar.network/docs/learn/interoperability/xcm/using-xcm/xcm-transactions).

### Q: I transferred X tokens to another account, but the amount transferred and received by the target account is greater than X. What is going on?

Expand Down
30 changes: 0 additions & 30 deletions docs/learn/interoperability/xcm.md

This file was deleted.

File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 15110b0

Please sign in to comment.