Skip to content

Commit

Permalink
Megan misc fixes (#453)
Browse files Browse the repository at this point in the history
* remove use/user-guides

* address manage assets capitalization

* update homepage link to User Guides

* Update transak.md

* add main section overviews, and subsection cards

* fix discord and other broken links

* update Flatten function

was a plugin -> now built-in to context menu

* normalize folder structure and fix missing images

* small fixes while we are here

---------

Co-authored-by: Gregory Luneau <gregory.luneau@gmail.com>
  • Loading branch information
meganskye and gluneau authored Oct 2, 2023
1 parent 7aeb5b1 commit bd101d2
Show file tree
Hide file tree
Showing 57 changed files with 34 additions and 36 deletions.
2 changes: 1 addition & 1 deletion docs/build/EVM/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# EVM Smart Contracts
![EVM smart contracts](../assets/evm.png)
![EVM smart contracts](/docs/build/img/evm.png)

All Astar networks support EVM smart contracts except Swanky node.

Expand Down
1 change: 0 additions & 1 deletion docs/build/EVM/infra/img-verification-cookbook/img

This file was deleted.

File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/build/EVM/infra/img/flatten.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 14 additions & 15 deletions docs/build/EVM/infra/verify_smart_contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
sidebar_position: 5
---

import Figure from '/src/components/figure'

# How to verify a Solidity smart contract on Blockscout

## TL;DR
Expand Down Expand Up @@ -36,44 +38,41 @@ In the previous guide, we went through the process of using Remix IDE to deploy

Copy the deployed contract address under the `Deployed Contracts` section

![Untitled](img-verification-cookbook/Untitled.png)
<Figure src={require('./img/Untitled.png').default } width="100%" />

Search for the contract on Blockscout and click `Verify and Publish` under the `Code` page

![Untitled](img-verification-cookbook/Untitled%201.png)
<Figure src={require('./img/Untitled1.png').default } width="100%" />

Choose `Via standard input JSON`

![Untitled](img-verification-cookbook/Untitled%202.png)
<Figure src={require('./img/Untitled2.png').default } width="100%" />

Fill in the contract name and Solidity compiler version and upload the standard input JSON file
- You can find the standard input JSON file under contracts/artifacts/build-info. Only use the `input` object in the JSON file.
- You can also find the Solidity compiler version in the same JSON file under `solcVersion`

![Untitled](img-verification-cookbook/Untitled%203.png)
<Figure src={require('./img/Untitled3.png').default } width="100%" />

- Click “Verify & Publish”, then you are all set!

![Untitled](img-verification-cookbook/Untitled%204.png)
<Figure src={require('./img/Untitled4.png').default } width="100%" />


---

### Example 2: verifying smart contracts with OpenZepplin-related source contracts

Due to compiler constraints, contracts **with OpenZeppelin-related source contracts** have different verification methods to contracts **without OpenZeppelin-related source contracts.** In this section, we will go through the process of verifying a smart contract **with OpenZeppelin-related source contracts** using **Flattener** plugin.

I have already deployed an ERC20 token contract using OpenZepplin library import, and will demonstrate how to verify it on Blockscout using **Flattener** plugin in Remix IDE.
Due to compiler constraints, contracts **with OpenZeppelin-related source contracts** have different verification methods to contracts **without OpenZeppelin-related source contracts.** In this section, we will go through the process of verifying a smart contract **with OpenZeppelin-related source contracts** using **Flatten**.

- Install **Flattener** plugin in the `plugin manager`.
![Untitled](img-verification-cookbook/Untitled%205.png)
I have already deployed an ERC20 token contract using OpenZepplin library import, and will demonstrate how to verify it on Blockscout using **Flatten** in Remix IDE.

- Use **Flattener** plugin to flatten the ERC20 contract deployed.
![Untitled](img-verification-cookbook/Untitled%206.png)
- Use the **Flatten** function in the context menu to flatten the ERC20 contract deployed. Copy the flattened code.
<Figure src={require('./img/flatten.jpg').default } width="100%" />

- Go to Blockscout and on the verification page choose the `Via flattened source code` method
![Untitled](img-verification-cookbook/Untitled%207.png)
<Figure src={require('./img/Untitled7.png').default } width="100%" />

- Paste the copied flattened source code from **Flattener** into the `Enter the Solidity Contract Code`` field and click ``Verify & Publis`.
![Untitled](img-verification-cookbook/Untitled%208.png)
- Paste the flattened source code from the **Flatten** function output into the `Enter the Solidity Contract Code`` field and click ``Verify & Publish`.
<Figure src={require('./img/Untitled8.png').default } width="100%" />

2 changes: 1 addition & 1 deletion docs/build/Introduction/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Introduction
![General understanding of programming basics ](../assets/introduction.png)
![General understanding of programming basics](/docs/build/img/introduction.png)
To make use of this documentation effectively, you should possess a general understanding of programming basics. The programming languages used throughout are mainly Rust, Solidity, and JavaScript, for which previous knowledge is not necessary, but would be highly beneficial. In conjunction with improving your understanding of the material contained within these guides, we recommend additionally that you review supplemental material covering these languages, in order to improve your overall understanding of the topics, and practical code examples provided.

### Do I need blockchain knowledge to follow this documentation?
Expand Down
2 changes: 1 addition & 1 deletion docs/build/builder-guides/astar_features/use_remix.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ You will also be able to interact with the contract that you just deployed on Sh
## FAQ
Please feel free to our Discord at [https://discord.com/invite/Z3nC9U4](https://discord.com/invite/Z3nC9U4) for technical support.
Please feel free to join our Discord [here](https://discord.gg/AstarNetwork) for technical support.
## Reference
Expand Down
4 changes: 2 additions & 2 deletions docs/build/builder-guides/hacking/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ sidebar_position: 1
---

# General
![banner](../../assets/gradient5.jpg)
![banner](/docs/build/img/gradient5.jpg)

Please read the linked chapter and try to answer questions. If you cant find the answer, go to the [Astar Discord server](https://discord.com/invite/mWGt9bH59s) and ask the question in the general channel under the Developer Support category.
Please read the linked chapter and try to answer questions. If you can't find the answer, go to the [Astar Discord server](https://discord.gg/invite/AstarNetwork) and ask the question in the general channel under the Developer Support category.

## Introduction
### Polkadot Relay [Chapter](/docs/build/introduction/polkadot_relay)
Expand Down
2 changes: 1 addition & 1 deletion docs/build/builder-guides/hacking/hack_evm.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import CustomNet from './img/custom_net.png'
import Zombie from './img/zombie.png'

# Hack EVM Smart Contracts
![banner](../../assets/gradient2.jpg)
![banner](/docs/build/img/gradient2.jpg)

Read the linked chapters or use tutorials to be able to answer following questions:

Expand Down
2 changes: 1 addition & 1 deletion docs/build/builder-guides/hacking/hack_wasm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 2
---

# Hack Wasm Smart Contracts
![banner](../../assets/gradient4.jpg)
![banner](/docs/build/img/gradient4.jpg)

Read the linked chapters or use tutorials to be able to answer following questions:

Expand Down
2 changes: 1 addition & 1 deletion docs/build/builder-guides/hacking/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Astar Hacker Guide
![banner](../../assets/gradient8.jpg)
![banner](/docs/build/img/gradient8.jpg)
Welcome to Web3!
## What is this Guide all about?
This guide will navigate you through the Astar Documentation to jump start your development journey. We are aware of the complexity of the subject and want to encourage and support you on your Web3 journey.
Expand Down
2 changes: 1 addition & 1 deletion docs/build/builder-guides/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Builder Guides
![Additional information to help developing on Astar Network](../assets/builderguides.png)
![Additional information to help developing on Astar Network](/docs/build/img/builderguides.png)

```mdx-code-block
import DocCardList from '@theme/DocCardList';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ In order to collect the addresses that participated in dApp staking during a cer

## FAQ

For technical support, please contact our team of ambassadors and developers on Discord at [https://discord.com/invite/Z3nC9U4](https://discord.com/invite/Z3nC9U4). We're happy to help.
For technical support, please contact our team of ambassadors and developers on [Discord](https://discord.gg/AstarNetwork). We're happy to help.

## Reference
- [Python Substrate Interface Github](https://github.com/polkascan/py-substrate-interface)
Expand Down
2 changes: 1 addition & 1 deletion docs/build/environment/faucet.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Then, click the `I'm not a robot` checkbox, and click **Confirm**.

## Astar Discord Server

Once you join the [Discord Server](https://discord.com/invite/kvRRnvBbQn), you will be able to see the **#shibuya-faucet** channel.
Once you join the [Discord Server](https://discord.gg/AstarNetwork), you will be able to see the **#shibuya-faucet** channel.

![3](img/3.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/environment/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Set up the Development Environment
![Development Environment](../assets/environment.png)
![Development Environment](/docs/build/img/environment.png)

Before you start development, you don't need to know how to set up the required environments. However, you may find it helpful to review the following sections to learn about their purposes and specific requirements.

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion docs/build/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Build on Astar
![Documentation of all the resources builders need in order to start testing, deploying and interacting with smart contracts on the Astar network](assets/build.png)
![Documentation of all the resources builders need in order to start testing, deploying and interacting with smart contracts on the Astar network](./img/build.png)


## Why build on Astar?
Expand Down
6 changes: 3 additions & 3 deletions docs/build/wasm/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ sidebar_position: 14

# Community

## Didn't find your answer?
## Didn't find what you're looking for?

### Polkadot and Substrate Stack Exchange

Many answers can be found in the [Polkadot and Substrate Stack Exchange](https://substrate.stackexchange.com/). Feel free to ask a question if you have one, too!
Many answers can be found in the [Polkadot and Substrate Stack Exchange](https://substrate.stackexchange.com/). Feel free to ask a question if you have one, or participate in ongoing discussions.

### Astar Discord

We also have a Discord server that you can join and ask questions in [here](https://discord.com/invite/kvRRnvBbQn)!
We also have a Discord server where you can ask our developers questions directly [here](https://discord.gg/AstarNetwork) and you can also ask [Astari](https://medium.com/astar-network/your-personal-guide-to-astar-network-is-here-af4344ee8d73) in the [Astari AI channel.](https://discord.com/channels/644182966574252073/1097773162248278077)
2 changes: 1 addition & 1 deletion docs/build/wasm/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Wasm Smart Contracts

![Wasm Smart Contracts](../assets/wasm.png)
![Wasm Smart Contracts](/docs/build/img/wasm.png)

The **Wasm** section covers the Wasm stack on Astar/Shiden, some more advanced topics, and contains a few tutorials to help you build and deploy Wasm smart contracts.

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Astar is the largest smart contract platform in the Polkadot ecosystem, supporti
testing, deploying, and interacting with smart contracts on the network.
- [**EVM**](/docs/build/evm) dives deeper into EVM on Astar and explains how EVM contracts can interact with other non-EVM modules through [precompiles](https://docs.astar.network/docs/build/EVM/precompiles/).
- [**Wasm**](/docs/build/wasm) provides an overview of the [Wasm stack](https://docs.astar.network/docs/build/wasm/smart-contract-wasm) on Astar, [Wasm contract frameworks](/docs/build/wasm/dsls), and [Swanky Suite](/docs/build/wasm/swanky-suite/).
- **Nodes**(/docs/build/nodes) explains how to run full nodes, collators, indexers, and everything you need to know related to infrastructure.
- **XCM**(/docs/learn/xcm) explains how XCM is used in Astar and also how developers can use it to interact with the rest of the Polkadot network.
- **Integrations**(/docs/build/integrations/) provide relevant information about the wallets, indexers, and oracles that are integrated with the network.
- [**Nodes**](/docs/build/nodes) explains how to run full nodes, collators, indexers, and everything you need to know related to infrastructure.
- [**XCM**](/docs/learn/interoperability/xcm) explains how XCM is used in Astar and also how developers can use it to interact with the rest of the Polkadot network.
- [**Integrations**](/docs/build/integrations/) provide relevant information about the wallets, indexers, and oracles that are integrated with the network.

[cbridge]: https://cbridge.celer.network/#/transfer
Binary file added static/docs/build/img/build.png
Binary file added static/docs/build/img/builderguides.png
Binary file added static/docs/build/img/environment.png
Binary file added static/docs/build/img/evm.png
Binary file added static/docs/build/img/gradient1.jpg
Binary file added static/docs/build/img/gradient2.jpg
Binary file added static/docs/build/img/gradient3.jpg
Binary file added static/docs/build/img/gradient4.jpg
Binary file added static/docs/build/img/gradient5.jpg
Binary file added static/docs/build/img/gradient6.jpg
Binary file added static/docs/build/img/gradient7.jpg
Binary file added static/docs/build/img/gradient8.jpg
Binary file added static/docs/build/img/gradient9.jpg
Binary file added static/docs/build/img/introduction.png
Binary file added static/docs/build/img/wasm.png

0 comments on commit bd101d2

Please sign in to comment.