Skip to content

Commit ce1e309

Browse files
committed
update
1 parent e30ef39 commit ce1e309

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+321
-269
lines changed

docs/n3/develop/tool/sdk/rpc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ RpcClient client = new RpcClient(new Uri("http://localhost:20332"), null, null,
2727
## Blockchain data
2828

2929
### GetBestBlockHashAsync
30+
3031
Gets the hash of the highest block in the blockchain:
3132

3233
```cs
@@ -36,6 +37,7 @@ UInt256 hash256 = UInt256.Parse(hexString);
3637
```
3738

3839
### GetBlockAsync
40+
3941
Gets the detailed block information by the block hash or block index.
4042

4143
```cs

docs/n3/develop/write/difference.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ using Neo.SmartContract.Framework;
3838
using Neo.SmartContract.Framework.Services.Neo;
3939
using System;
4040
```
41+
4142
Neo N3:
4243

4344
```cs
@@ -114,6 +115,7 @@ Neo N3 adds a new security method. You can execute the contract in a read-only m
114115
Neo N3 introduces a large number of native contracts, moving massive interoperable services from Neo Legacy to native contracts. The major changes are as follows.
115116

116117
- Upgraded the Blockchain class to a Ledger native contract, e.g. `Blockchain.GetBlock()` changed to `Ledger.GetBlock()`.
118+
117119
- Added the ContractManagement native contract to query contracts and manage their updating and destruction.
118120

119121
- Moved the contract part of the Blockchain class to the ContractManagement native contract, e.g. `Blockchain.GetContract()` changed to `ContractManagement .GetContract()`.
@@ -133,8 +135,8 @@ Neo N3 introduces a large number of native contracts, moving massive interoperab
133135
- The Transaction class has been extensively updated to fit the data structure of Neo N3 transactions.
134136
- Added a new Crypto class and moved some of the methods provided by the SmartContract class to this class.
135137
- Moved a number of classes:
136-
- Account
137-
- Asset
138+
- Account
139+
- Asset
138140
- Header
139141
- InvocationTransaction
140142
- TransactionAttribute

docs/n3/develop/write/nep11.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ By now we have completed a simple NFT contract.
130130

131131
The base class `Nep11Token` also provides the following methods and events:
132132

133-
#### NEP-11 methods
133+
### NEP-11 methods
134134

135135
| Name | Parameters | Returns | Description |
136136
| ----------- | ---------------------------------------------- | ---------------- | ------------------------------------------------------------ |
@@ -144,13 +144,13 @@ The base class `Nep11Token` also provides the following methods and events:
144144
| tokensOf | Hash160(owner) | InteropInterface | Returns all of the token ids owned by the specified address |
145145
| transfer | Hash160(to) ByteArray(tokenId) Any(data) | Boolean | It transfers an amount of NFT with TokenId. This method requires the signature of NFT owner. |
146146

147-
#### Events
147+
### Events
148148

149149
| Name | Parameters | Returns | Description |
150150
| -------- | ------------------------------------------------------------ | --------------- | ------------------------------------------------------------ |
151151
| transfer | Hash160(from) Hash160(to) Integer(amount) ByteArray(tokenId) | Transfer event | When the `from` address is set to `null` tokens are created; When the `to` address set to `null`tokens are burned. |
152152

153-
#### Compatibility check
153+
### Compatibility check
154154

155155
Compatibility checks will be activated for any contract that includes the `[SupportedStandards("NEP-17")]` or `[SupportedStandards("NEP-11")]` attribute.
156156
The Compatibility Check reviews method names, parameters, return values, events, and similar elements to ensure they comply with the standard, and alerts about any failures in the check.

docs/n3/exchange/client.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ sidebar_label: 'Using Neo-CLI'
33
sidebar_position: 2
44
---
55

6-
## Using Neo-CLI
6+
# Using Neo-CLI
77

88
The Neo-CLI client works as a node in the P2P network and meanwhile a cross-platform wallet handling various assets transactions.
99

10-
### Neo-CLI Security Policies
10+
## Neo-CLI Security Policies
1111

1212
:::caution
1313

@@ -23,7 +23,7 @@ Neo-CLI does not provide the function to remotely switching on/off the wallet, a
2323
| P2P | 10333 | 20333 |
2424
| websocket | 10334 | 20334 |
2525

26-
### About Neo-CLI
26+
## About Neo-CLI
2727

2828
Neo-CLI is a command-line client (wallet) for developers. Developers have two ways to interact with it:
2929

@@ -59,7 +59,7 @@ Neo-CLI provides the following features:
5959
- Provides transaction information of NEP-17 assets.
6060

6161

62-
### Creating a Wallet
62+
## Creating a Wallet
6363

6464
The exchange needs to create an online wallet to manage the deposit addresses of users. A wallet is used to store the information of the accounts (both public keys and private keys) and the contracts. It is the most important proof that the user holds. Users must keep the wallet files and the wallet passwords secure. They must not lose or disclose these data. Exchanges do not have to create a wallet for every address. An online wallet usually keeps all deposit addresses of users. A cold wallet (offline wallet) is another storage option which provides better security.
6565

@@ -76,7 +76,7 @@ To create a wallet, do the following:
7676

7777
2. Set a password for the wallet.
7878

79-
### Generating Deposit Addresses
79+
## Generating Deposit Addresses
8080

8181
A wallet can store multiple addresses. The exchange needs to generate a deposit address for each user.
8282

docs/n3/exchange/deploynode.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ install RpcNep17Tracker
3838

3939
- The RpcServer plug-in must be installed before you can use the RpcNep17Tracker plug-in.
4040
- You must install the plugins ApplicationLogs and RpcNep17Tracker before synchronizing the Neo client, otherwise the log in the blocks synchronized before will be lost.
41+
4142
:::
4243

4344
## Modifying configuration files

docs/n3/exchange/gas.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,10 @@ In Neo N3 every time a NEO transfer transaction occurs in the address, GASs gene
1818
Claimed *GAS = f(neo_amount, Δt_const)*
1919

2020
Δt_const = t_end - t_start
21-
- t_end = the current time that Neo is transferred into or out of the address.
22-
- t_start = the last time that Neo was transferred into or out of the address.
21+
22+
- t_end = the current time that Neo is transferred into or out of the address.
23+
24+
- t_start = the last time that Neo was transferred into or out of the address.
2325

2426
Δt_const is fixed, thus the claimed Gas is of a fixed amount too. And this amount depends on the amount of Neo held by the user and the duration between the moments that the user transferred this amount of Neo into and out of his or her address.
2527

docs/n3/exchange/transaction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -422,11 +422,11 @@ The exchange can choose one of the following way to send assets to users:
422422

423423
### Neo-CLI Command: send
424424

425-
##### Syntax
425+
#### Syntax
426426

427427
`send <id|alias> <address> <amount>|all [from=null] [signerAccounts=null]`
428428

429-
##### Parameters
429+
#### Parameters
430430

431431
- `id|alias`: asset ID or asset abbreviations, e.g. neo, gas
432432
- `address`: address to transfer assets to
@@ -437,7 +437,7 @@ The exchange can choose one of the following way to send assets to users:
437437

438438
This command verifies the wallet password.
439439

440-
##### Example
440+
#### Example
441441

442442
Transfer 100 Neo to the address NYxb4fSZVKAz8YsgaPK2WkT3KcAE9b3Vag:
443443

docs/n3/foundation/Transactions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,10 @@ In Neo all variable-length integer types except IP addresses and port numbers ar
103103
| `systemFee` | - |
104104
| `networkFee` | - |
105105
| `validUntilBlock` | - |
106-
| `signers` | Need to serializes `WriteVarInt(length) `first and then other elements of the array |
106+
| `signers` | Need to serializes `WriteVarInt(length)` first and then other elements of the array |
107107
| `attributes` | Need to serializes `WriteVarInt(length)` first and then other elements of the array |
108-
| `script` | Need to serializes `WriteVarInt(length) `first and then the byte array |
109-
| `witnesses` | Need to serializes `WriteVarInt(length) `first and then other elements of the array |
108+
| `script` | Need to serializes `WriteVarInt(length)` first and then the byte array |
109+
| `witnesses` | Need to serializes `WriteVarInt(length)` first and then other elements of the array |
110110

111111

112112
:::note

docs/n3/foundation/Wallets.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,11 @@ The address script in Neo N3 has changed not using the Opcode.CheckSig and OpCod
7878

7979
![Account Address](images/wallets/account_address_script_checksign.png)
8080

81-
2. Calculate script hash of the contract (20 bytes, make once SHA256 and RIPEMD160 of the script).
81+
1. Calculate script hash of the contract (20 bytes, make once SHA256 and RIPEMD160 of the script).
8282

83-
3. Add the version prefix in the hash (Currently, the Neo protocol version is 53 and the corresponding byte is `0x35`).
83+
2. Add the version prefix in the hash (Currently, the Neo protocol version is 53 and the corresponding byte is `0x35`).
8484

85-
4. Make Base58Check encoding for the above byte data.
85+
3. Make Base58Check encoding for the above byte data.
8686

8787
Example:
8888

docs/n3/glossary.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@ sidebar_label: 'Glossary'
44

55
# Glossary
66

7-
#### Block
7+
## Block
88

99
A block in a Blockchain contains a number of transaction records. Blocks are paired up with the previous block according to the timestamp and the cryptographic hash of the previous block contained in each block header, thereby creating a chain of blocks, or a blockchain.
1010

11-
#### Wallet
11+
## Wallet
1212

1313
A wallet is a cryptographic public/private key pair which is used to sign and authenticate database transactions that occur on the Neo network.
1414

15-
#### Account (Address)
15+
## Account (Address)
1616

1717
Similar to your bank account, a blockchain account is used to transfer or receive assets in a transaction. The address is generated by the script hash through some operations, and can be converted back to the script hash. In Neo Legacy, the address starts with A, and in Neo N3, the address starts with N.
1818

19-
#### Private Key/Public Key
19+
## Private Key/Public Key
2020

2121
The private key is a 256-bit random number that is kept by users themselves, without disclosing to others. It is a proof of the user's right to use the account and ownership of assets in the account. Each private key has a public key paired with it.
2222

23-
#### Transaction
23+
## Transaction
2424

2525
A Neo transaction is a signed data package with an instruction for the network, for example a user indicating that he wants to transfer assets to another address. Each Neo block in the blockchain ledger contains one or more transactions, making each block a transaction batch.
2626

27-
#### Script
27+
## Script
2828

2929
A script is a piece of code that consists of opcodes and operands. Each account is a contract with a script. A standard account script is composed of the public key and the OpCode that verifies the signature. The format is as follows
3030

@@ -33,39 +33,39 @@ PUSHDATA1 03ac765294075da6f7927c96bfe3d3f64ae3680c5eb50f82f55170a9f1bea59dad
3333
SYSCALL Neo.Crypto.VerifyWithECDsaSecp256r1
3434
```
3535

36-
#### Script Hash
36+
## Script Hash
3737

3838
The script hash is generated from the smart contract script with the RIPEMD-160 algorithm. Each script has a unique script hash. Any change made in the script of the contract will cause the script hash to change. The script hash length is 20 bytes (160 bits). The script hash is generated unidirectionally by the script, and cannot be reversed to the script. The script hash and address can be converted to each other.
3939

40-
#### Opcode
40+
## Opcode
4141

4242
Opcodes are similar to instructions in assembly language. For all OpCode, refer to [OpCode source](https://github.com/neo-project/neo/blob/master/src/Neo.VM/OpCode.cs).
4343

44-
#### Cryptographic private key
44+
## Cryptographic private key
4545

4646
Cryptographic private key refers to the encryption of the private key through the wallet password, which is more secure than the plaintext private key. In this way, you can write the cryptographic private key on paper and keep the password in your mind.
4747

48-
#### Smart Contract
48+
## Smart Contract
4949

5050
From the blockchain perspective, a smart contract is a set of promises, specified in digital form, including protocols within which the parties perform on these promises.
5151

52-
#### NEP-17
52+
## NEP-17
5353

5454
The NEP-17 proposal outlines a token standard for the Neo blockchain that will provide systems with a generalized interaction mechanism for tokenized smart contracts.
5555

56-
#### SysCall
56+
## SysCall
5757

5858
The system call is a special operation code, through which you can call the interoperable service layer interface. By calling the interoperable service layer interface, NeoVM can access data such as block, transaction , contract, and asset information that are required for running smart contracts. For more information refer to the files in [Neo smart contract module](https://github.com/neo-project/neo/tree/master/src/Neo/SmartContract) starting with `ApplicationEngine.` , such as `ApplicationEngine.Contract.cs`, `ApplicationEngine.Blockchain.cs`.
5959

60-
#### Dynamic Call
60+
## Dynamic Call
6161

6262
A special system call that invokes another contract within a contract. It can be wrote as `Contract.Call(scriptHash, method, params)`. For more information refer to [Invoking Smart Contracts](develop/deploy/invoke).
6363

64-
#### Storage
64+
## Storage
6565

6666
Each smart contract deployed on the Neo blockchain has a private storage area for storing application data. When creating a smart contract or transaction to use this contract, the contract code needs to read and write its storage. Each contract can declare a storage area. For more information refer to [Storage](reference/scapi/framework/services/Storage.md).
6767

68-
#### NEF
68+
## NEF
6969

7070
NEF is short for Neo Executable Format. The smart contract compiler compiles the source code and eventually generate NEF files and Manifest files (see below).
7171

0 commit comments

Comments
 (0)