Skip to content

Commit

Permalink
Update zkyoto docs (#725)
Browse files Browse the repository at this point in the history
  • Loading branch information
fiexer authored Dec 30, 2024
1 parent fe18c1f commit d1a2f90
Show file tree
Hide file tree
Showing 102 changed files with 4,227 additions and 5,095 deletions.
8 changes: 0 additions & 8 deletions docs/build/environment/dev-container.md

This file was deleted.

14 changes: 0 additions & 14 deletions docs/build/environment/endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ To meet the demands of a production dApp you can run an [archive node](/docs/bui
| Parent chain | Ethereum |
| ChainID | 3776 |
| HTTPS | Startale Labs: https://rpc.startale.com/astar-zkevm |
| | Dwellir: https://astar-zkevm-rpc.dwellir.com |
| Symbol | ETH |

</TabItem>
Expand Down Expand Up @@ -103,18 +102,5 @@ To meet the demands of a production dApp you can run an [archive node](/docs/bui
| chainID | 81 |
| Symbol | SBY |

</TabItem>

<TabItem value="zKyoto" label="zKyoto Network" default>

| | Public endpoint zKyoto |
| --- |------------------------------------------------|
| Network | zKyoto (zkEVM testnet) |
| Parent chain | Sepolia |
| ChainID | 6038361 |
| HTTPS | Startale Labs: https://rpc.startale.com/zkyoto |
| | Dwellir: https://astar-zkyoto-rpc.dwellir.com|
| Symbol | ETH |

</TabItem>
</Tabs>
4 changes: 2 additions & 2 deletions docs/build/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Astar is a interoperable smart contract platform providing native access to both
✅ Flexibility to deploy dApps on the platform and ecosystem that best suits their needs, while retaining interoperability with others. <br/>
✅ Familiar Tools and Libraries (Remix, Hardhat, Open Zeppelin) <br/>
✅ Social & biometric login and recovery (Google, x.com, LINE, Kakao, [Banana](/docs/build/integrations/account-abstraction/banana/)) <br/>
✅ Gasless payments ([Gelato](/docs/build/zkEVM/integrations/account-abstraction/relayers/gelato-relay), [Safe](/docs/build/zkEVM/integrations/account-abstraction/safe--aa/))<br/>
✅ Gasless payments<br/>
✅ NFT checkout with credit/debit cards <br/>
✅ Onramp / offramp solutions (Banxa, [Transak](/docs/build/integrations/wallets/transak)) <br/>
✅ Interoperability between dApps & other blockchains ([The Graph](/docs/build/integrations/indexers/thegraph), [LayerZero](/docs/build/zkEVM/integrations/bridges-relays/AstarEVM-zkEVM)) <br/>
✅ Interoperability between dApps & other blockchains<br/>
✅ Global Standard NFT Marketplace & DEX (Dew, Rarible, Quickswap) <br/>

## Build2Earn
Expand Down
45 changes: 12 additions & 33 deletions docs/build/introduction/astar_family.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,15 @@
sidebar_position: 5
---

# Astar Network Family
# Astar Family

Prior to commencing development, it's important to understand the Astar Network family, and choose an appropriate network based on what you would like to do. Currently, there are a number of networks available, including the Local network which runs exclusively within your development environment. All networks support Substrate and EVM RPCs.

![Astar networks](img/fig4.jpg)

## Local Networks

### Substrate Node
You can clone the Astar repository and run the local node provided, or download the precompiled binary and run it, instead. Both methods are described in the [Build](/docs/build) section.

### Swanky Node

Swanky Node is a Substrate based blockchain configured to enable the smart contract module `pallet-contracts`, and other features that assist local development of Wasm smart contracts.
For more information about Swanky Node, check out the [Swanky Suite](https://docs.astar.network/docs/build/wasm/swanky-suite/) section.

### Zombienet

With Zombienet users can download arbitrary Relay Chain and parachain binaries (or use images) to setup a configurable local test network. Users will have access to all privileged actions on the Relay Chain and parachains, which simplifies testing. For more information about Zombienet, check out the [Build Environment](https://docs.astar.network/docs/build/environment/zombienet-testing) chapter.
Expand All @@ -33,40 +26,26 @@ The Shibuya native token symbol is SBY.

To obtain test tokens from the faucet, please visit the Astar Portal and connect to Shibuya. If for any reason the faucet is empty, please contact the Astar team on Discord.

### zKatana (Sepolia) - Deprecated

An early iteration of the zkEVM testnet that used zk rollup architecture. Now deprecated.

### zKyoto (Sepolia)
### zKyoto (Sepolia) (Deprecated)

zKyoto is a Validium-based network connected to the Ethereum Sepolia testnet and Polygon AggLayer. It is the testing and proving ground for dApps deployed on the Astar zkEVM.
zKyoto was connected to the Ethereum Sepolia testnet and Polygon AggLayer. Testing ground for dApps deployed on the Astar zkEVM. This testnet has now been transitioned to [Soneium Minato](https://docs.soneium.org/).

## Mainnets

Astar has three mainnets:
Astar Collective, with the ASTR token, supports three mainnets:

1. Astar zkEVM
2. Astar Parachain
3. Shiden Parachain
1. Astar Network (Parachain)
2. Astar zkEVM (soon to be deprecated)
3. Soneium

### Shiden Parachain (Substrate)

Shiden is a parachain connected to the Kusama Relay Chain, and used to deploy and test new releases of Astar runtime in a live production (canary) environment. Shiden is not considered a testnet since SDN has its own tokenomics and value, but is used to validate and stabilize new software releases and upgrades for Astar Network.

The Shiden native token symbol is SDN.

### Astar Parachain (Substrate)

By now you may have guessed that Astar parachain is connected to Polkadot Relay chain.
### Astar Network (Parachain)

Astar parachain is connected to Polkadot Relay chain supporting WASM & EVM smart contract deployments.
The Astar native token symbol is ASTR.

### Astar zkEVM

Astar zkEVM is an Ethereum Layer 2 network, powered by Polygon CDK. Technically referred to as Validium, it combines zk rollup technology with modular data availability, synthesizing the best features of each.

## Questions and Assignments:
Astar zkEVM is an Ethereum Layer 2 network, powered by Polygon CDK. Technically referred to as Validium, it combines zk rollup technology with modular data availability. Next phase for Astar zkEVM is the transition to Soneium.

1. Using the account you created in previous chapters, visit to Astar portal, connect to Shibuya testnet and claim some tokens from the faucet. You will need them later to deploy contracts on Shibuya.
2. Are you able to deduce how to transfer SDN tokens to Astar, and swap them for ASTR tokens?
3. Is there a market for buying and selling SBY tokens?
### Soneium
Soneium is a next-generation blockchain ecosystem designed to invoke emotion and empower creativity. It was founded by Sony Group Corporation, a global technology leader, and Startale, a Web3 innovator. Soneium stands as a versatile, general-purpose blockchain ready to serve diverse needs across all verticals and support users globally. Astar and it's token ASTR will play a crucial role in the ecosystem as driven asset.
6 changes: 0 additions & 6 deletions docs/build/wasm/swanky-suite/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,6 @@ The CLI can be installed and used in different ways:
Note that using the precompiled binaries, NPM, or compiling it yourself requires you to have the [local environment set up](/docs/build/environment/ink_environment.md) correctly
:::

### Dev container

Using [dev container](/docs/build/environment/dev-container) is the easiest way to use `swanky-cli`, it includes all the environment setup and will support auto-updates in the future.

To run your project in the dev container follow the steps on [swanky-dev-container Github](https://github.com/AstarNetwork/swanky-dev-container).

### Cloud based environments

Similar to using the dev container locally, GitHub will detect the `.devcontainer` config in your project and let you run the project in a cloud-based IDE.
Expand Down
67 changes: 0 additions & 67 deletions docs/build/zkEVM/bridge-to-zkevm.md

This file was deleted.

28 changes: 5 additions & 23 deletions docs/build/zkEVM/canonical-zkevm-contracts.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 10
sidebar_position: 2
title: Canonical Contracts
---
import Tabs from '@theme/Tabs';
Expand All @@ -16,7 +16,7 @@ Wrapped ETH (wETH) on Astar zkEVM contract address is [`0xE9CC37904875B459Fa5D0F
### Bridged Tokens

<Tabs>
<TabItem value="mainnet" label="Astar zkEVM Mainnet" default>
<TabItem value="mainnet" label="Astar zkEVM" default>

| Contract Name | Source | Contract Address |
| ---------------------------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -31,16 +31,12 @@ Wrapped ETH (wETH) on Astar zkEVM contract address is [`0xE9CC37904875B459Fa5D0F


</TabItem>
<TabItem value="testnet" label="zKyoto Testnet">
coming soon...
</TabItem>

</Tabs>


## Polygon CDK Validium Specific Contracts
<Tabs>
<TabItem value="mainnet" label="Astar zkEVM Mainnet" default>
<TabItem value="mainnet" label="Astar zkEVM" default>

| Contract Name | Network | Contract Address |
| ---------------------------- | ---------------- | -------------------------------------------- |
Expand All @@ -55,21 +51,13 @@ coming soon...
| PolygonZkEVMBridge | L2 (Astar zkEVM) | `0x2a3dd3eb832af982ec71669e178424b10dca2ede` |
| PolygonZkEVMGlobalExitRootL2 | L2 (Astar zkEVM) | `0xa40d5f56745a118d0906a34e69aec8c0db1cb8fa` |
</TabItem>
<TabItem value="testnet" label="zKyoto Testnet">
coming soon...
</TabItem>

</Tabs>

More documentation about the Polygon CDK Validium contracts can be found in the [cdk-validium-contracts GitHub repository](https://github.com/0xPolygon/cdk-validium-contracts)

## Ethereum Specific Precompiles

TODO - refer to a link in CDK Docs which covers which precompiles are available for CDK

### LayerZero Bridge
<Tabs>
<TabItem value="mainnet" label="Astar zkEVM Mainnet" default>
<TabItem value="mainnet" label="Astar zkEVM" default>

| Contract Name | Network | Contract Address ( Endpoint ) | endpointId |
| ---------------------------- | ------------------------------|--------------------------------------------- |--------------|
Expand All @@ -80,10 +68,4 @@ TODO - refer to a link in CDK Docs which covers which precompiles are available
| LayerZero OFT ASTR | L2 (Astar zkEVM) | `0xdf41220C7e322bFEF933D85D01821ad277f90172` | - |
| LayerZero NativeOFT ASTR | L1 (Astar EVM (Substrate)) | `0xdf41220C7e322bFEF933D85D01821ad277f90172` | - |
</TabItem>
<TabItem value="testnet" label="zKyoto Testnet">
| LayerZero endpoint V1 | L2 (Astar zKyoto) | `0x6098e96a28E02f27B1e6BD381f870F1C8Bd169d3` | 10266 |
| LayerZero endpoint V2 | L2 (Astar zKyoto) | `0x6EDCE65403992e310A62460808c4b910D972f10f` | 40266 |
</TabItem>
</Tabs>

More documentation about the LayerZero Bridge can be found in [this section](/docs/build/zkEVM/integrations/bridges-relays/AstarEVM-zkEVM.md)
</Tabs>
2 changes: 1 addition & 1 deletion docs/build/zkEVM/fee.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 3
title: Astar zkEVM Fee Calculation
sidebar_label: Fee Calculation
---
Expand Down
2 changes: 1 addition & 1 deletion docs/build/zkEVM/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Astar zkEVM is an Ethereum Layer-2 scaling solution leveraging Polygon's Chain Development Kit and cutting edge zero-knowledge cryptography to enable off-chain transaction execution, with finality and security guarantees provided by Ethereum. In coordination with our key partners, Astar zkEVM is well-positioned to take advantage of the extensive developer base and well-established toolset existing in the Ethereum ecosystem, and boasts the following key features:

- **Lower Transaction Fees compared to Ethereum** - Due to the transaction batching, as explained above.
- **Full EVM-equivalence** - Not only EVM compatibility; Equivalence. Smart contracts that work on Ethereum also work on Astar zkEVM. See the [smart contract section](/docs/build/zkEVM/smart-contracts/) for more information.
- **Full EVM-equivalence** - Not only EVM compatibility; Equivalence. Smart contracts that work on Ethereum also work on Astar zkEVM.
- **Native Account Abstraction** - The Astar zkEVM provides native features designed to revolutionize the end-user experience, and make it seamless. See the [Account Abstraction section](/docs/build/zkEVM/integrations/account-abstraction/) to learn more about how to refine the end-user experience.
- **Recognized Partners** - Established names and brands that developers trust power the Astar zkEVM. See the [integrations section](/docs/build/zkEVM/integrations/) for more information about 3rd party service providers.
- **Interoperability and Exposure** - With Astar zkEVM, we are supporting interoperability between the Ethereum and Polkadot ecosystems, uniting communities, and empowering web3 accessibility through a common Multichain vision.
Expand Down
12 changes: 0 additions & 12 deletions docs/build/zkEVM/integrations/account-abstraction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ Here you will find all the information required to refine the end-user experienc

Account Abstraction is a blockchain technology that enables users to utilize smart contracts as their accounts. While the default account for most users is an Externally Owned Account (EOA), which is controlled by an external private key, it requires users to have a considerable understanding of blockchain technology to use them securely. Fortunately, smart contract accounts can create superior user experiences.

### Using Account Abstraction

There are two primary ways users can use account abstraction: with third party Meta Transaction services or by sending ERC-4337 transactions.

#### Meta Transactions
Meta Transactions are bespoke third party services for achieving account abstraction, for example:
- [A custom `safe-sdk` that works together with Gelato Relay](/docs/build/zkEVM/integrations/account-abstraction/safe--aa/).

#### ERC-4337
ERC-4337, also known as EIP-4337.
- [Biconomy SDK Account Abstraction toolkit](/docs/build/zkEVM/integrations/account-abstraction/safe--aa/)

<br/>

import DocCardList from '@theme/DocCardList';
Expand Down
Loading

0 comments on commit d1a2f90

Please sign in to comment.