From f84a5f7220435e0b517ab509b659dcef77e6cd15 Mon Sep 17 00:00:00 2001 From: Celia18305 Date: Wed, 12 Jun 2024 17:33:26 +0800 Subject: [PATCH] reorganize index --- docs/n3/develop/tool/sdk/contract.md | 3 +++ docs/n3/develop/tool/sdk/introduction.md | 3 +++ docs/n3/develop/tool/sdk/monitor.md | 3 +++ docs/n3/develop/tool/sdk/rpc.md | 3 +++ docs/n3/develop/tool/sdk/transaction.md | 3 +++ docs/n3/develop/tool/sdk/wallet.md | 3 +++ docs/n3/develop/write/1_dotnet.md | 3 +++ docs/n3/develop/write/basics.md | 3 +++ docs/n3/develop/write/difference.md | 3 +++ docs/n3/develop/write/framework.md | 3 +++ docs/n3/develop/write/manifest.md | 3 +++ docs/n3/develop/write/nep11.md | 3 +++ docs/n3/develop/write/nep17.md | 3 +++ docs/n3/develop/write/update.md | 3 +++ docs/n3/foundation/Cryptography/MerkleTree.md | 4 ++++ docs/n3/foundation/Cryptography/encode_algorithm.md | 4 ++++ docs/n3/foundation/Cryptography/encryption_algorithm.md | 4 ++++ docs/n3/foundation/Cryptography/hash_algorithm.md | 4 ++++ docs/n3/foundation/consensus/consensus_algorithm.md | 6 +++++- docs/n3/foundation/consensus/consensus_protocol.md | 4 ++++ docs/n3/foundation/consensus/dbft.md | 4 ++++ docs/n3/foundation/consensus/vote_validator.md | 4 ++++ docs/n3/gettingstarted/deploy.md | 4 ++++ docs/n3/gettingstarted/develop.md | 4 ++++ docs/n3/gettingstarted/enviroment.md | 4 ++++ docs/n3/gettingstarted/prerequisites.md | 4 ++++ docs/n3/node/cli/cli.md | 3 +++ docs/n3/node/cli/config.md | 3 +++ docs/n3/node/cli/setup.md | 3 +++ docs/n3/reference/scapi/framework/native.md | 3 +++ docs/n3/reference/scapi/framework/services.md | 3 +++ 31 files changed, 106 insertions(+), 1 deletion(-) diff --git a/docs/n3/develop/tool/sdk/contract.md b/docs/n3/develop/tool/sdk/contract.md index a6fc551..bc6f3cc 100644 --- a/docs/n3/develop/tool/sdk/contract.md +++ b/docs/n3/develop/tool/sdk/contract.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 5 +--- # Deploying and Invoking Contracts In Neo N3 most of the functions are provided by contracts. ScriptHash is the unique identifier of the contract, and it is usually a necessary parameter for invoking contracts. diff --git a/docs/n3/develop/tool/sdk/introduction.md b/docs/n3/develop/tool/sdk/introduction.md index 604a0ef..84c6563 100644 --- a/docs/n3/develop/tool/sdk/introduction.md +++ b/docs/n3/develop/tool/sdk/introduction.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 0 +--- # About RpcClient `RpcClient` is a C# dependency library that can be used to develop various applications on Neo, such as wallet clients, games, etc. This project can help you easily invoke Neo RPC interfaces, construct transactions, and invoke contracts. diff --git a/docs/n3/develop/tool/sdk/monitor.md b/docs/n3/develop/tool/sdk/monitor.md index daee96a..cb8dc1a 100644 --- a/docs/n3/develop/tool/sdk/monitor.md +++ b/docs/n3/develop/tool/sdk/monitor.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 2 +--- # Getting Blockchain Information The `RPC` module provides methods to get basic information of blockchain data and status, such as block height, block content, transaction details, and contracts. diff --git a/docs/n3/develop/tool/sdk/rpc.md b/docs/n3/develop/tool/sdk/rpc.md index d233d0d..ed7b3cf 100644 --- a/docs/n3/develop/tool/sdk/rpc.md +++ b/docs/n3/develop/tool/sdk/rpc.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 1 +--- # RPC Invocation Methods The `RpcClient` encapsulates all the interfaces provided by RpcServer. You can send RPC requests in your code through the standard methods provided in this module. You only need to pass in the corresponding parameters, the SDK will construct the corresponding JSON-RPC requests and then get the data returned by the node. diff --git a/docs/n3/develop/tool/sdk/transaction.md b/docs/n3/develop/tool/sdk/transaction.md index 408a32a..a6166ff 100644 --- a/docs/n3/develop/tool/sdk/transaction.md +++ b/docs/n3/develop/tool/sdk/transaction.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 4 +--- # Transaction Construction `RpcClient` encapsulates the transaction construction module, which allows you to construct transactions in Neo N3 with specific parameters and methods to personalize your functions. This document introduces the relevant methods. diff --git a/docs/n3/develop/tool/sdk/wallet.md b/docs/n3/develop/tool/sdk/wallet.md index 6e994c2..3f5d149 100644 --- a/docs/n3/develop/tool/sdk/wallet.md +++ b/docs/n3/develop/tool/sdk/wallet.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 3 +--- # Wallet Interfaces Most operations in Neo blockchain are related to accounts. A wallet is the collection of accounts that includes one or multiple accounts. This document contains the following topics： diff --git a/docs/n3/develop/write/1_dotnet.md b/docs/n3/develop/write/1_dotnet.md index ae72420..49b11e7 100644 --- a/docs/n3/develop/write/1_dotnet.md +++ b/docs/n3/develop/write/1_dotnet.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 0 +--- # Using Neo Devpack Dotnet Designed for developers, Neo Devpack Dotnet is a comprehensive toolkit for creating Neo contracts using .net. It offers convenient contract project templates and a compiler. diff --git a/docs/n3/develop/write/basics.md b/docs/n3/develop/write/basics.md index de063ca..a037f9e 100644 --- a/docs/n3/develop/write/basics.md +++ b/docs/n3/develop/write/basics.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 1 +--- # Smart Contract Writing Basics In this tutorial, you will learn the basics of developing a smart contract. diff --git a/docs/n3/develop/write/difference.md b/docs/n3/develop/write/difference.md index f81cfd0..54d2a14 100644 --- a/docs/n3/develop/write/difference.md +++ b/docs/n3/develop/write/difference.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 7 +--- # Differences between Neo N3 and Neo Legacy This document describes the main differences in writing smart contracts between Neo N3 and Neo Legacy. Developers who want to migrate Neo Legacy contracts to Neo N3 need to be aware of these changes. Since Neo N3 is still being updated, here we only list significant changes and the document will be updated continuously. diff --git a/docs/n3/develop/write/framework.md b/docs/n3/develop/write/framework.md index f6e8eee..98fe6f6 100644 --- a/docs/n3/develop/write/framework.md +++ b/docs/n3/develop/write/framework.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 6 +--- # Smart Contract Framework (C#) The .NET framework is an encapsulation of the Smart Contract API, which helps .NET programmers obtain the blockchain data, persistent storage data, and NeoVM execution status easily using the classes, methods, and properties of the core Neo module. diff --git a/docs/n3/develop/write/manifest.md b/docs/n3/develop/write/manifest.md index c8544b9..b6f5783 100644 --- a/docs/n3/develop/write/manifest.md +++ b/docs/n3/develop/write/manifest.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 4 +--- # NEF and Manifest Files Neo N3 uses the NEF (NEO Executable Format) and Manifest files as a replacement of the AVM and ABI files in Neo Legacy. diff --git a/docs/n3/develop/write/nep11.md b/docs/n3/develop/write/nep11.md index 54696cc..d48dbe9 100644 --- a/docs/n3/develop/write/nep11.md +++ b/docs/n3/develop/write/nep11.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 2 +--- # NEP-11 The NEP-11 proposal outlines the standard for writing NFT (Non-fungible token) contracts. This document will explain how to write a simple NFT contract using C#. diff --git a/docs/n3/develop/write/nep17.md b/docs/n3/develop/write/nep17.md index 3dc9e21..4a98b73 100644 --- a/docs/n3/develop/write/nep17.md +++ b/docs/n3/develop/write/nep17.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 3 +--- # NEP-17 The NEP-17 proposal is a replacement of the original NEP5 proposal, which outlines a token standard for the Neo blockchain that will provide systems with a generalized interaction mechanism for tokenized Smart Contracts. diff --git a/docs/n3/develop/write/update.md b/docs/n3/develop/write/update.md index 2b654de..a1d7340 100644 --- a/docs/n3/develop/write/update.md +++ b/docs/n3/develop/write/update.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 5 +--- # Contract Update and Destroy Smart contracts support to be updated or destroyed after release. Before you can do that you need to implement the Update and Destroy interfaces in the old contracts. diff --git a/docs/n3/foundation/Cryptography/MerkleTree.md b/docs/n3/foundation/Cryptography/MerkleTree.md index 5a86317..fcf9803 100644 --- a/docs/n3/foundation/Cryptography/MerkleTree.md +++ b/docs/n3/foundation/Cryptography/MerkleTree.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Merkle Tree' +sidebar_position: 3 +--- # Merkle Tree A Merkle tree is a kind of binary tree: It's able to quickly check and induce massive data and verify the completeness of block transaction records. Neo uses Merkle tree to construct block model. Neo's block head stores the Merkle root of all transactions within the block. The block data area stores transaction array. diff --git a/docs/n3/foundation/Cryptography/encode_algorithm.md b/docs/n3/foundation/Cryptography/encode_algorithm.md index 7d7f9c7..7de86e3 100644 --- a/docs/n3/foundation/Cryptography/encode_algorithm.md +++ b/docs/n3/foundation/Cryptography/encode_algorithm.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Encoding Algorithm' +sidebar_position: 0 +--- # Encoding Algorithm ## Base58 diff --git a/docs/n3/foundation/Cryptography/encryption_algorithm.md b/docs/n3/foundation/Cryptography/encryption_algorithm.md index c4d6641..a2f9a87 100644 --- a/docs/n3/foundation/Cryptography/encryption_algorithm.md +++ b/docs/n3/foundation/Cryptography/encryption_algorithm.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Encryption Algorithm' +sidebar_position: 2 +--- # Encryption Algorithm ## ECC Algorithm diff --git a/docs/n3/foundation/Cryptography/hash_algorithm.md b/docs/n3/foundation/Cryptography/hash_algorithm.md index 9520f6c..5f84dae 100644 --- a/docs/n3/foundation/Cryptography/hash_algorithm.md +++ b/docs/n3/foundation/Cryptography/hash_algorithm.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Hash Algorithm' +sidebar_position: 1 +--- # Hash Algorithm Hash function, or hash algorithm, is a method creating digital finger print from any kind of data. Hash function compresses message or data into a digested version to shrink the data into a fixed data size. This function disorganizes and remixes data, rebuilding a data fingerprint as a hash value. Hash value is always represented by a short string consisting of random letters and digits. diff --git a/docs/n3/foundation/consensus/consensus_algorithm.md b/docs/n3/foundation/consensus/consensus_algorithm.md index 77f7007..43e86b7 100644 --- a/docs/n3/foundation/consensus/consensus_algorithm.md +++ b/docs/n3/foundation/consensus/consensus_algorithm.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Consensus Algorithm' +sidebar_position: 1 +--- # dBFT 2.0 Algorithm ## Terms @@ -76,7 +80,7 @@ A normal algorithm flow is shown below. - For delegates: - In case of receiving Prepare Request from the speaker before timeout: - + 1. Verify the validity of the message and whether it conforms to the local consensus context 2. Prolong local timeout by ![](../images/consensus/5.png) diff --git a/docs/n3/foundation/consensus/consensus_protocol.md b/docs/n3/foundation/consensus/consensus_protocol.md index 7db8388..16aa7f8 100644 --- a/docs/n3/foundation/consensus/consensus_protocol.md +++ b/docs/n3/foundation/consensus/consensus_protocol.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Consensus Protocol' +sidebar_position: 2 +--- # Consensus Protocol ## Consensus Message Format diff --git a/docs/n3/foundation/consensus/dbft.md b/docs/n3/foundation/consensus/dbft.md index d8ecaeb..ca4ce1d 100644 --- a/docs/n3/foundation/consensus/dbft.md +++ b/docs/n3/foundation/consensus/dbft.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Overview' +sidebar_position: 0 +--- # Consensus Mechanism ## Overview diff --git a/docs/n3/foundation/consensus/vote_validator.md b/docs/n3/foundation/consensus/vote_validator.md index a001268..4e2f264 100644 --- a/docs/n3/foundation/consensus/vote_validator.md +++ b/docs/n3/foundation/consensus/vote_validator.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Election' +sidebar_position: 3 +--- # Consensus Nodes Election Neo is an open and transparent blockchain network where anyone can either initiate a transaction to apply for being a validator candidate or vote to decide which validator candidate can become a consensus node. The committee members and validators are elected based on the voting result. diff --git a/docs/n3/gettingstarted/deploy.md b/docs/n3/gettingstarted/deploy.md index 5bf1cf8..d19fbf5 100644 --- a/docs/n3/gettingstarted/deploy.md +++ b/docs/n3/gettingstarted/deploy.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Deploying and invoking contract' +sidebar_position: 4 +--- # Deploying and invoking contract In the previous section we have compiled an NEP17 contract file (NEP17.nef) and contract descriptive file (NEP17.manifest.json), next we will move on to deployment and invocation of the contract with Neo-CLI. diff --git a/docs/n3/gettingstarted/develop.md b/docs/n3/gettingstarted/develop.md index a71b9a5..36d3a37 100644 --- a/docs/n3/gettingstarted/develop.md +++ b/docs/n3/gettingstarted/develop.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Developing a contract' +sidebar_position: 3 +--- # Developing a contract We have completed setting up the private chain and configuring the node. In this section we will walk you through configuring the environment, writing, and compiling an NEP17 contract using C#. diff --git a/docs/n3/gettingstarted/enviroment.md b/docs/n3/gettingstarted/enviroment.md index 3e33209..07093fe 100644 --- a/docs/n3/gettingstarted/enviroment.md +++ b/docs/n3/gettingstarted/enviroment.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Setting up local network' +sidebar_position: 2 +--- # Setting up local network ## Setting up a private chain diff --git a/docs/n3/gettingstarted/prerequisites.md b/docs/n3/gettingstarted/prerequisites.md index 64507fe..05a7e8b 100644 --- a/docs/n3/gettingstarted/prerequisites.md +++ b/docs/n3/gettingstarted/prerequisites.md @@ -1,3 +1,7 @@ +--- +sidebar_label: 'Before You Begin' +sidebar_position: 1 +--- # Before You Begin In this tutorial, we will work you through an example of how to release an NEP17 asset on Neo blockchain, which includes the tasks of setting up and configuring the development environment, compiling, deploying and invoking the smart contract on a private Neo chain. diff --git a/docs/n3/node/cli/cli.md b/docs/n3/node/cli/cli.md index f15339d..ad32bbc 100644 --- a/docs/n3/node/cli/cli.md +++ b/docs/n3/node/cli/cli.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 2 +--- # CLI Command Reference Open the command line, navigate to the directory where Neo-CLI is located, and enter the following code to start the command line Neo node. diff --git a/docs/n3/node/cli/config.md b/docs/n3/node/cli/config.md index 17c2f95..f257d2a 100644 --- a/docs/n3/node/cli/config.md +++ b/docs/n3/node/cli/config.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 1 +--- # Configuring and Starting Neo-CLI After installation of Neo-CLI, this section we will walk you through the necessary configurations before running Neo-CLI and the steps to start Neo-CLI using commands. diff --git a/docs/n3/node/cli/setup.md b/docs/n3/node/cli/setup.md index 24bcfd3..22eff75 100644 --- a/docs/n3/node/cli/setup.md +++ b/docs/n3/node/cli/setup.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 0 +--- # Installing Neo-CLI You can choose one of the following ways to install Neo-CLI: diff --git a/docs/n3/reference/scapi/framework/native.md b/docs/n3/reference/scapi/framework/native.md index c7be498..6c44b8e 100644 --- a/docs/n3/reference/scapi/framework/native.md +++ b/docs/n3/reference/scapi/framework/native.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 0 +--- # Neo.SmartContract.Framework.Native A series of native contract methods that can be invoked in the smart contract. diff --git a/docs/n3/reference/scapi/framework/services.md b/docs/n3/reference/scapi/framework/services.md index 2fadbd1..fea890d 100644 --- a/docs/n3/reference/scapi/framework/services.md +++ b/docs/n3/reference/scapi/framework/services.md @@ -1,3 +1,6 @@ +--- +sidebar_position: 2 +--- # Neo.SmartContract.Framework.Services ## Class