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

merge dev updates to master #122

Merged
merged 2 commits into from
Jun 12, 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
3 changes: 3 additions & 0 deletions docs/n3/develop/tool/sdk/contract.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/tool/sdk/introduction.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/tool/sdk/monitor.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/tool/sdk/rpc.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/tool/sdk/transaction.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/tool/sdk/wallet.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/write/1_dotnet.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/write/basics.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
sidebar_position: 1
---
# Smart Contract Writing Basics

In this tutorial, you will learn the basics of developing a smart contract.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/write/difference.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/write/framework.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/write/manifest.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/write/nep11.md
Original file line number Diff line number Diff line change
@@ -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#.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/write/nep17.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/develop/write/update.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/foundation/Cryptography/MerkleTree.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/foundation/Cryptography/encode_algorithm.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_label: 'Encoding Algorithm'
sidebar_position: 0
---
# Encoding Algorithm

## Base58
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/foundation/Cryptography/encryption_algorithm.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_label: 'Encryption Algorithm'
sidebar_position: 2
---
# Encryption Algorithm

## ECC Algorithm
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/foundation/Cryptography/hash_algorithm.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 5 additions & 1 deletion docs/n3/foundation/consensus/consensus_algorithm.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_label: 'Consensus Algorithm'
sidebar_position: 1
---
# dBFT 2.0 Algorithm

## Terms
Expand Down Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/foundation/consensus/consensus_protocol.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_label: 'Consensus Protocol'
sidebar_position: 2
---
# Consensus Protocol

## Consensus Message Format
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/foundation/consensus/dbft.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_label: 'Overview'
sidebar_position: 0
---
# Consensus Mechanism

## Overview
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/foundation/consensus/vote_validator.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/gettingstarted/deploy.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/gettingstarted/develop.md
Original file line number Diff line number Diff line change
@@ -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#.
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/gettingstarted/enviroment.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_label: 'Setting up local network'
sidebar_position: 2
---
# Setting up local network

## Setting up a private chain
Expand Down
4 changes: 4 additions & 0 deletions docs/n3/gettingstarted/prerequisites.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/node/cli/cli.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/node/cli/config.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/node/cli/setup.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
sidebar_position: 0
---
# Installing Neo-CLI

You can choose one of the following ways to install Neo-CLI:
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/reference/scapi/framework/native.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/n3/reference/scapi/framework/services.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
sidebar_position: 2
---
# Neo.SmartContract.Framework.Services

## Class
Expand Down
Loading