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

Added videos to existing pages #362

Merged
merged 5 commits into from
Jan 17, 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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions docs/core/build/token-standards.md

This file was deleted.

14 changes: 14 additions & 0 deletions docs/core/getting-started/funding-your-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,20 @@ displayed_sidebar: coreSidebar

Are you a new user of Conflux blockchain? Or are you a developer planning to develop a Dapp on Conflux? Then you may need some CFX to interact with the Conflux network. We provide the testnet CFX faucet dApp, which allows users to claim testnet CFX and experience it in the Conflux testnet environment.

## Video Tutorial

For a quick demo on how to use the Conflux Faucets, please refer to the following video tutorial:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="youtube" label="Conflux Faucets Video">
<iframe width="560" height="315" src="https://www.youtube.com/embed/MyQi99-fEM4?si=PPPJLlUHFEofnnv2" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>
</Tabs>


## Faucet dApp

We have developed a [Faucet Dapp](https://faucet.confluxnetwork.org/), which not only can be used to claim `CFX` but also tokens, currently includes `FC`, `cUSDT`.
Expand Down
2 changes: 2 additions & 0 deletions docs/core/tutorials/hardhat-conflux-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ The Hardhat-Conflux plugin is built on top of `js-conflux-sdk`, making its usage

If you are not familiar with Hardhat, please refer to the [Hardhat documentation](https://hardhat.org/getting-started/).



## Installation

After installing Hardhat, you can install the plugin with:
Expand Down
13 changes: 13 additions & 0 deletions docs/espace/build/jsonrpc-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@ displayed_sidebar: eSpaceSidebar

Conflux eSpace implements the Web3 JSON-RPC protocol.

Check out the following video to get a quick overview of this topic:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


<Tabs>
<TabItem value="youtube" label="JSON-RPC Compatibility Video">
<iframe width="560" height="315" src="https://www.youtube.com/embed/svpqUAjzdk0?si=j6Ia3OEi8Go5DTPq" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>
</Tabs>


## Methods

| Method | Status | Note |
Expand Down
2 changes: 1 addition & 1 deletion docs/espace/tutorials/deployContract/brownie.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 4
title: Deploying an ERC-20 Token Using Brownie
title: Brownie
description: Learn how to deploy an ERC-20 Token using Brownie.
keywords:
- Brownie
Expand Down
30 changes: 26 additions & 4 deletions docs/espace/tutorials/deployContract/hardhatAndFoundry.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
sidebar_position: 1
title: Deploying contract using hardhat and foundry
description: Deploying contract using hardhat and foundry
title: Hardhat and Foundry
description: Deploying smart contracts using Hardhat and Foundry
displayed_sidebar: eSpaceSidebar
---

The eSpace Testnet allows anyone to deploy a smart contract on eSpace. In this tutorial, you will learn how to deploy a contract on eSpace Testnet using common tools for developing on Ethereum. This [demo repo](https://github.com/conflux-fans/espace-contract-guide) illustrates contract deployment with [Hardhat](https://hardhat.org/) and [Foundry](https://github.com/foundry-rs/foundry).

Before you start deploying the contract, you need to request test tokens from a [eSpace faucet](https://efaucet.confluxnetwork.org/).

## Deploy contracts with Hardhat


## Deploying smart contracts with Hardhat

1. If you haven't already, install [nodejs](https://nodejs.org/en/download/) and [yarn](https://classic.yarnpkg.com/lang/en/docs/install).
2. Clone the repo and install dependencies:
Expand All @@ -28,7 +30,27 @@ Before you start deploying the contract, you need to request test tokens from a

6. Run `yarn test` for hardhat tests.

## Deploy contracts with Foundry

### Video Guides

To learn more about smart contract deployment using Hardhat, please refer to the following videos:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="overview" label="Hardhat Overview">
<iframe width="560" height="315" src="https://www.youtube.com/embed/p0Bzc2Y_0Kc?si=sfchFwTtSHlHyK4w" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>

<TabItem value="tutorial" label="Hardhat Tutorial">
<iframe width="560" height="315" src="https://www.youtube.com/embed/SBzhyV3TSGg?si=HXxu0XdHAsNNJPkf" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>

</Tabs>


## Deploying smart contracts with Foundry

1. Clone the repo:

Expand Down
15 changes: 14 additions & 1 deletion docs/espace/tutorials/deployContract/remix.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 2
title: Deploying an ERC-20 Token using Remix IDE
title: Remix IDE
description: Deploying an ERC-20 Token using Remix IDE
displayed_sidebar: eSpaceSidebar
---
Expand Down Expand Up @@ -118,3 +118,16 @@ If you transferred to another MetaMask account you hold then you can follow the

![MetaMask-add-token-account2](../img/mm-token-balance-changed-c59c6e2434009c0dcb6e03ef79ba5e60.png)


## Video Tutorial

For an on-hands demonstration of how to deploy a smart contract using Remix IDE, please refer to the following video:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="youtube" label="Remix IDE Video Tutorial">
<iframe width="560" height="315" src="https://www.youtube.com/embed/WLbUXQ1FS8M?si=kJD-6-QN3ZqFf0_v" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>
</Tabs>
17 changes: 16 additions & 1 deletion docs/espace/tutorials/deployContract/thirdweb.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 3
title: Deploying contract using thirdweb
title: thirdweb
description: Deploying contract using thirdweb
displayed_sidebar: eSpaceSidebar
---
Expand Down Expand Up @@ -90,3 +90,18 @@ Deploy allows you to deploy a smart contract to any EVM compatible network witho
For additional information on Deploy, please reference [thirdweb’s documentation](https://portal.thirdweb.com/deploy).

If you have any further questions or encounter any issues during the process, please reach out to thirdweb support at [support.thirdweb.com](http://support.thirdweb.com/).


## Video Tutorial

In the following video, you can find a hands-on demonstration on how to use thirdweb to deploy smart contracts on Conflux eSpace:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


<Tabs>
<TabItem value="youtube" label="thirdweb tutorial">
<iframe width="560" height="315" src="https://www.youtube.com/embed/Ilkj3ay0Uu4?si=CJmPLankHKlPgkAy" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>
</Tabs>
2 changes: 1 addition & 1 deletion docs/general/build/nfts/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "NFTs",
"position": 2,
"position": 3,
"link": {
"type": "generated-index",
"description": "This section provides documentation related to NFT development."
Expand Down
17 changes: 17 additions & 0 deletions docs/general/build/nfts/pinata.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,21 @@ Pinning prevents important data from being deleted from your node. You and only

Once your file is pinned to IPFS, you have full control to share, distribute, monetize and share your files however you’d like.

## Video Tutorial

For a hands-on demonstration on how to use pinata to store your Web3 files, please check out the following video:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


<Tabs>
<TabItem value="youtube" label="Pinata Video Tutorial">
<iframe width="560" height="315" src="https://www.youtube.com/embed/9y2NK85Z6Hk?si=0TsnWNR40f9mz4Wo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>
</Tabs>


## Getting the Images Ready

This guide will focus on creating a single NFT, but if you want to make more, feel free to do so. The image being used can be found here if you'd like to utilize it.
Expand Down Expand Up @@ -115,3 +130,5 @@ Now, repeat the folder upload process to add the metadata to Pinata. Follow the
![6.png](./img/6.png)

Click on the metadata folder to be directed to the IPFS gateway and save the URL. This URL will be your base URL and won't need the direct file links. The smart contract will append the necessary file information for each NFT as needed. For example, our URL is **`https://gateway.pinata.cloud/ipfs/QmewVNwWYW27gKTrwhDG1Ge1ABqyQGxACCAdpx9a47d3sm`**.


2 changes: 1 addition & 1 deletion docs/general/build/node-development/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Node Development",
"position": 1,
"position": 5,
"link": {
"type": "generated-index",
"description": "Documents related to Node Development."
Expand Down
8 changes: 8 additions & 0 deletions docs/general/build/smart-contracts/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Smart Contracts",
"position": 1,
"link": {
"type": "generated-index",
"description": "Documents related to Smart Contracts Development."
}
}
53 changes: 53 additions & 0 deletions docs/general/build/smart-contracts/token-standards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
sidebar_position: 2
title: Token Standards
displayed_sidebar: generalSidebar
---

:::info

This document page is currently under construction. As an open-source project, we rely on the collaboration of our contributors to create comprehensive and up-to-date content.

To track the progress of this page or get involved, please visit the corresponding GitHub issue: [Complete core/build/token-standards page](https://github.com/Conflux-Chain/conflux-documentation/issues/109). If you're interested in contributing to the completion of this page, feel free to **leave a comment under the issue**.

We plan to issue POAP NFTs as a token of appreciation to contributors who help with the documentation. Your involvement in the project will be recognized and rewarded.

Thank you for your interest in Conflux. We look forward to sharing the completed content with you.

:::

## Related Links

Here are some links relating to this topic:

- [ERC-20](https://eips.ethereum.org/EIPS/eip-20)
- [ERC-721](https://eips.ethereum.org/EIPS/eip-721)
- [ERC-1155](https://eips.ethereum.org/EIPS/eip-1155)
- [CIP-1820](https://github.com/Conflux-Chain/CIPs/blob/master/CIPs/cip-1820.md)


## Educational Videos

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


<Tabs>

<TabItem value="overview" label="Overview">
<iframe width="560" height="315" src="https://www.youtube.com/embed/s-xAwQ-UtzM?si=unn8Ug1issImJsq6" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>

<TabItem value="erc20" label="ERC-20">
<iframe width="560" height="315" src="https://www.youtube.com/embed/Re1OXraH-Ag?si=VjW2XidCXUBwlQ9N" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>

<TabItem value="erc721" label="ERC-721">
<iframe width="560" height="315" src="https://www.youtube.com/embed/V7s0g8y5O78?si=j8IH8qzZ24ZybQeC" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>

<TabItem value="erc1155" label="ERC-1155">
<iframe width="560" height="315" src="https://www.youtube.com/embed/jLsmgsrrfVM?si=YvXkEdZbegDJCHtO" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>

</Tabs>
2 changes: 1 addition & 1 deletion docs/general/build/tools/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Tools",
"position": 1,
"position": 2,
"link": {
"type": "generated-index",
"description": "Documents related to General Tools for Building on Conflux Network."
Expand Down
15 changes: 15 additions & 0 deletions docs/general/conflux-basics/transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@ This section introduces transaction concepts from a high level. For more details

:::

## Conflux Transaction Video

To learn about transactions in Conflux Network you can start with the following video:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


<Tabs>
<TabItem value="youtube" label="Transactions on Conflux Network">
<iframe width="560" height="315" src="https://www.youtube.com/embed/GIeD2khbbXs?si=cTRZo6DalLkLguXi" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>
</Tabs>

## Concept of Transaction

A transaction is a single instruction composed by an external actor with a Conflux account, and this instruction is cryptographically signed using the sender account’s private key. A transaction can involve a simple transfer of CFX (the native currency of Conflux), a transfer of tokens (such as ERC20 or ERC721), a deployment of a new smart contract, or an execution of a function on an existing smart contract. Transactions are the only way to store or update data on the blockchain.
Expand Down Expand Up @@ -62,3 +76,4 @@ The following are the main stages of a transaction from construction to confirma
6. **Waiting for PoS chain Finalization -> Finalized**: This is the final stage where transactions are finalized after specific PoW block being referenced by Conflux's [PoS chain](./consensus-mechanisms/proof-of-stake/pos_overview.md). Conflux's PoS chain periodically refers a stable PoW block to provide finality for transactions. A finalized transaction means that it has zero probability of being reverted unless the attacker possesses more than 67% of the CFX staked in PoS. It takes approximately 4-5 minutes to finalize a transaction since it is included in a block (after [CIP-113](https://github.com/Conflux-Chain/CIPs/blob/master/CIPs/cip-113.md) activation).

![Transaction](./img/transaction-stages)

14 changes: 13 additions & 1 deletion docs/general/conflux-basics/what-is-conflux.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,20 @@ Conflux employs a hybrid [consensus mechanism](./consensus-mechanisms/consensus-

The Conflux network comprises two distinct [spaces](./spaces.md): Conflux [Core Space](../../core/Overview.md) and Conflux [eSpace](../../espace/build/cip90.md). The Core Space is the primary blockchain network that utilizes the hybrid consensus mechanism and features a [contract sponsorship mechanism](../../core/core-space-basics/internal-contracts/sponsor-whitelist-control.md). The sponsorship mechanism allows project users to interact with contracts without a balance, lowering the threshold for blockchain usage and expanding the user base. The eSpace is fully compatible with the Ethereum Virtual Machine (EVM), enabling developers to easily migrate their existing Ethereum smart contracts to Conflux eSpace and benefit from its high performance and scalability. Conflux Core Space and eSpace can communicate with each other via the [CrossSpaceCall](../../core/core-space-basics/internal-contracts/crossSpaceCall.md) contract, which facilitates atomic transfer of funds and atomic execution of smart contract calls between the two spaces.

If you want to learn more about Conflux, check out this video covering its unique Tree-Graph Algorithm, GHAST, Spaces, and the Hybrid PoW + PoS Consensus Mechanism:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="youtube" label="What is Conflux?">
<iframe width="560" height="315" src="https://www.youtube.com/embed/5JwUO3v2sW0?si=lNvkMZqhHKnzBNIm" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>
</Tabs>


:::tip

We warmly welcome you to the Conflux documentation site, your starting point for learning about Conflux's basic concepts and development. Happy exploring!

:::
:::
2 changes: 1 addition & 1 deletion docs/general/run-a-node/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs>
<TabItem value="youtube" label="Video source: YouTube">
<TabItem value="youtube" label="Running a Conflux Node">
<iframe width="560" height="315" src="https://www.youtube.com/embed/ocsbQRkL9fQ?si=wRmI5Aa6Ewfv-BCx" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen>
</iframe>
</TabItem>
Expand Down
8 changes: 0 additions & 8 deletions docs/general/tutorials/transferring-funds/_category_.json

This file was deleted.

28 changes: 28 additions & 0 deletions docs/general/tutorials/transferring-funds/transferring-funds.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
sidebar_position: 1
title: Transferring Funds
displayed_sidebar: generalSidebar
---

In this section, you will find tutorials related to transferring funds accross chains and spaces.


If you want to learn more about this topic, please checkout the following video:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


<Tabs>
<TabItem value="youtube" label="Transferring Funds Video Tutorial">
<iframe width="560" height="315" src="https://www.youtube.com/embed/BA2pfVK7pmU?si=kIXns4ePU9dNkHG3" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</TabItem>
</Tabs>



```mdx-code-block
import DocCardList from '@theme/DocCardList';

<DocCardList />
```
Loading