Skip to content

Commit

Permalink
Merge pull request #90 from neo-project/fix-broken-links
Browse files Browse the repository at this point in the history
fix broken links
  • Loading branch information
Celia18305 authored Jan 9, 2024
2 parents f59a5e9 + 1e4977a commit 2339894
Show file tree
Hide file tree
Showing 10 changed files with 41 additions and 40 deletions.
2 changes: 1 addition & 1 deletion docs/n3/develop/deploy/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ From the programming language perspective, only when a smart contract will be us

Smart contracts are deployed by invoking APIs. Usually we use Neo-CLI or Neo-GUI to deploy smart contracts.

Deploying and invoking smart contracts cost fees. For more information, refer to [Fees](../../reference/fees.md).
Deploying and invoking smart contracts cost fees. For more information, refer to [Fees](../../fees.md).

## Before you start
Make sure you have done the following:
Expand Down
2 changes: 1 addition & 1 deletion docs/n3/develop/deploy/invoke.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ The key statement is `Contract.Call(scriptHash, method, flags, params)`, where:

- `scriptHash` is the script hash of the contract invoked. It is ByteArray type and little endian.
- `method` is the method of the contract invoked, such as `name`, `balanceOf`, or `transfer`. String type.
- `flags` defines special behaviors allowed when invoking smart contracts. See [CallFlags Enumerator](https://docs.neo.org/docs/zh-cn/reference/scapi/framework/services/CallFlags.html#%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E) for details.
- `flags` defines special behaviors allowed when invoking smart contracts. See [CallFlags Enumerator](../../reference/scapi/framework/services/CallFlags.md) for details.
- `params` is the parameter list of the method of the invoked contract. Array type.

### Invocation permission
Expand Down
2 changes: 1 addition & 1 deletion docs/n3/develop/write/framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ Neo.SmartContract.Framework mainly provides the following API methods:

- A series of native contract methods that can be invoked in the smart contract,see [Neo.SmartContract.Framework.Native](https://developers.neo.org/docs/n3/reference/scapi/framework/native).
- Interoperability services layer methods, see [Neo.SmartContract.Framework.Service](https://developers.neo.org/docs/n3/reference/scapi/framework/services).
- Methods provided by the framework,see [Neo.SmartContract.Framework](https://developers.neo.org/docs/n3/reference/scapi/framework/framework).
- Methods provided by the framework,see [Neo.SmartContract.Framework](https://developers.neo.org/docs/n3/reference/scapi/framework).

2 changes: 1 addition & 1 deletion docs/n3/exchange/transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -664,6 +664,6 @@ After sending the request, you will get the following response:

## See Also

[NEP17 Token Standard](https://github.com/neo-project/proposals/blob/nep-17/nep-17.mediawiki)
[NEP17 Token Standard](https://github.com/neo-project/proposals/blob/master/nep-17.mediawiki)

[Neo3 Data Conversion](https://neo.org/converter/index)
26 changes: 13 additions & 13 deletions docs/n3/fees.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ System fees include:
| 0.00000001 | ASSERT, NOP, PUSH0, PUSH1, PUSH10, PUSH11, PUSH12, PUSH13, PUSH14, PUSH15, PUSH16, PUSH2, PUSH3, PUSH4, PUSH5, PUSH6, PUSH7, PUSH8, PUSH9, PUSHINT16, PUSHINT32, PUSHINT64, PUSHINT8, PUSHM1, PUSHNULL, PUSHT, PUSHF |
| 0 | ABORT, RET, SYSCALL |

Reference: [ApplicationEngine.OpCodePrices.cs](https://github.com/neo-project/neo/blob/master/src/neo/SmartContract/ApplicationEngine.OpCodePrices.cs)
Reference: [ApplicationEngine.OpCodePrices.cs](https://github.com/neo-project/neo/blob/master/src/Neo/SmartContract/ApplicationEngine.OpCodePrices.cs)

### System call fee

Expand Down Expand Up @@ -76,17 +76,17 @@ Reference: [ApplicationEngine.OpCodePrices.cs](https://github.com/neo-project/ne

Reference:

[ApplicationEngine.Contract.cs](https://github.com/neo-project/neo/blob/master/src/neo/SmartContract/ApplicationEngine.Contract.cs)
[ApplicationEngine.Contract.cs](https://github.com/neo-project/neo/blob/master/src/Neo/SmartContract/ApplicationEngine.Contract.cs)

[ApplicationEngine.Crypto.cs](https://github.com/neo-project/neo/blob/master/src/neo/SmartContract/ApplicationEngine.Crypto.cs)
[ApplicationEngine.Crypto.cs](https://github.com/neo-project/neo/blob/master/src/Neo/SmartContract/ApplicationEngine.Crypto.cs)

[ApplicationEngine.Contract.cs](https://github.com/neo-project/neo/blob/master/src/neo/SmartContract/ApplicationEngine.Contract.cs)
[ApplicationEngine.Contract.cs](https://github.com/neo-project/neo/blob/master/src/Neo/SmartContract/ApplicationEngine.Contract.cs)

[ApplicationEngine.Iterator.cs](https://github.com/neo-project/neo/blob/master/src/neo/SmartContract/ApplicationEngine.Iterator.cs)
[ApplicationEngine.Iterator.cs](https://github.com/neo-project/neo/blob/master/src/Neo/SmartContract/ApplicationEngine.Iterator.cs)

[ApplicationEngine.Runtime.cs](https://github.com/neo-project/neo/blob/master/src/neo/SmartContract/ApplicationEngine.Runtime.cs)
[ApplicationEngine.Runtime.cs](https://github.com/neo-project/neo/blob/master/src/Neo/SmartContract/ApplicationEngine.Runtime.cs)

[ApplicationEngine.Storage.cs](https://github.com/neo-project/neo/blob/master/src/neo/SmartContract/ApplicationEngine.Storage.cs)
[ApplicationEngine.Storage.cs](https://github.com/neo-project/neo/blob/master/src/Neo/SmartContract/ApplicationEngine.Storage.cs)

### Native contract execution fee

Expand All @@ -110,7 +110,7 @@ Reference:

The fee for other native contract methods not listed is 0.00032768 GAS.

Reference: [neo/SmartContract/Native](https://github.com/neo-project/neo/tree/master/src/neo/SmartContract/Native)
Reference: [neo/SmartContract/Native](https://github.com/neo-project/neo/tree/master/src/Neo/SmartContract/Native)

### Storage fee

Expand All @@ -126,7 +126,7 @@ For the key data written to the storage, the fee charged for the first time writ
| Subsequent write in. New data size > Old data size | The same as above line | The value modified as `hello neo3.0 preview5`, totally 21 bytes | 0.005 + (21-12)×0.001 = **0.014** GAS |
| The value removed | 0 | The value removed | **0** GAS |

Reference: [ApplicationEngine.Storage.cs](https://github.com/neo-project/neo/blob/master/src/neo/SmartContract/ApplicationEngine.Storage.cs)
Reference: [ApplicationEngine.Storage.cs](https://github.com/neo-project/neo/blob/master/src/Neo/SmartContract/ApplicationEngine.Storage.cs)

## Network fee

Expand All @@ -141,9 +141,9 @@ By default the network byte fee is 0.00001 GAS / Byte. Committee members can dyn

Reference:

[PolicyContract.cs](https://github.com/neo-project/neo/blob/master/src/neo/SmartContract/Native/PolicyContract.cs)
[PolicyContract.cs](https://github.com/neo-project/neo/blob/master/src/Neo/SmartContract/Native/PolicyContract.cs)

[Transaction.cs#L302](https://github.com/neo-project/neo/blob/ee898bf41667cdbe3b836b3bd08c2d3199046c2e/src/neo/Network/P2P/Payloads/Transaction.cs#L302)
[Transaction.cs#L302](https://github.com/neo-project/neo/blob/master/src/Neo/Network/P2P/Payloads/Transaction.cs#L302)

### Script verification fee

Expand All @@ -165,7 +165,7 @@ The script verification fee for a standard address is (OpCode.PUSHDATA1 + OpCode

Reference:

[PolicyContract.cs](https://github.com/neo-project/neo/blob/master/src/neo/SmartContract/Native/PolicyContract.cs)
[PolicyContract.cs](https://github.com/neo-project/neo/blob/master/src/Neo/SmartContract/Native/PolicyContract.cs)

[Transaction.cs#L302](https://github.com/neo-project/neo/blob/ee898bf41667cdbe3b836b3bd08c2d3199046c2e/src/neo/Network/P2P/Payloads/Transaction.cs#L302)
[Transaction.cs#L302](https://github.com/neo-project/neo/blob/master/src/Neo/Network/P2P/Payloads/Transaction.cs#L302)

4 changes: 2 additions & 2 deletions docs/n3/foundation/Transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The system fee depends on the transaction's script, i.e., its size, number and t

![](images/transaction/system_fee.png)

where *OpcodeSet* is opcode set, *OpcodePrice<sub>i</sub>* is the cost of opcode i, *n<sub>i</sub>* is the execution times of instruction i in the contract script. For each opcode fee refer to [Fees for Instructions](../../reference/fees.md#fees-for-instructions).
where *OpcodeSet* is opcode set, *OpcodePrice<sub>i</sub>* is the cost of opcode i, *n<sub>i</sub>* is the execution times of instruction i in the contract script. For each opcode fee refer to [Fees for Instructions](../Advances/Neo VM instructions.md).

### netfee

Expand Down Expand Up @@ -88,7 +88,7 @@ By repeating this step, the invocation script can push multiple signatures for t

#### Verification Script

Verification script, commonly known as address script, includes normal address script and multi-signature address script. The address script can be directly obtained from the wallet account. For information about the construction refer to [Wallets](wallets.md#address).
Verification script, commonly known as address script, includes normal address script and multi-signature address script. The address script can be directly obtained from the wallet account. For information about the construction refer to [Wallets](Wallets.md).

It can also be used as a custom authentication contract script.

Expand Down
6 changes: 3 additions & 3 deletions docs/n3/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The script hash is generated from the smart contract script with the RIPEMD-160

#### Opcode

Opcodes are similar to instructions in assembly language. For all OpCode, refer to [OpCode source](https://github.com/neo-project/neo-vm/blob/master/src/neo-vm/OpCode.cs).
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).

#### Cryptographic private key

Expand All @@ -55,15 +55,15 @@ The NEP-17 proposal outlines a token standard for the Neo blockchain that will p

#### SysCall

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`.
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`.

#### Dynamic Call

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).

#### Storage

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).
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).

#### NEF

Expand Down
2 changes: 1 addition & 1 deletion docs/n3/node/gui/blockchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ You can view the following information by switching tabs in this page:
- **Transaction**: Displays the basic information of the transaction, such as the block, size, time stamp, as well as the transaction transfer record and the witness of the transaction.
- **Notifications**: Displays the execution log of the smart contract in the transaction, including information such as whether the NEP-17 transfer was successful.

For information about the basic concept of transactions refer to [Transaction](../../basic/concept/transaction.md).
For information about the basic concept of transactions refer to [Transaction](../../foundation/Transactions.md).

## Assets

Expand Down
32 changes: 16 additions & 16 deletions docs/n3/reference/governance_api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ An address can be registered as candidate or unregistered afterwards. Correspond

| Method | Parameters | Fee in GAS |
| ---- | ------------------------------------ | ---- |
| [`RegisterCandidate`](../smart_contract_api/framework/native/Neo/RegisterCandidate) | ECPoint publicKey | Adjustable, initially 0.00001 |
| [`UnregisterCandidate`](../smart_contract_api/framework/native/Neo/UnregisterCandidate) | ECPoint publicKey | 0.00065536 (CpuFee) |
| [`RegisterCandidate`](../scapi/framework/native/Neo/RegisterCandidate) | ECPoint publicKey | Adjustable, initially 0.00001 |
| [`UnregisterCandidate`](../scapi/framework/native/Neo/UnregisterCandidate) | ECPoint publicKey | 0.00065536 (CpuFee) |

:::note
Registering / unregistering candidate requires signature. It means candidate registering / unregistering is only self-determined.
Expand All @@ -30,13 +30,13 @@ Voting contract method is as follows. Please not that voter's signature will be

| Method | Parameters | Fee in GAS |
| ---- | ------------------------------------ | ---- |
| [`Vote`](../smart_contract_api/framework/native/Neo/Vote) | UInt160 account, byte[] voteTo | 0.00065536 (CpuFee) |
| [`Vote`](../scapi/framework/native/Neo/Vote) | UInt160 account, byte[] voteTo | 0.00065536 (CpuFee) |

As voters' votes & held NEO, as well as registered candidates keep changing, candidate set and their votes are re-calculated in every block.

| Method | Parameters | Fee in GAS |
| ---- | ------------------------------------ | ---- |
| [`GetCandidates`](../smart_contract_api/framework/native/Neo/GetCandidates) | null | 0 |
| [`GetCandidates`](../scapi/framework/native/Neo/GetCandidates) | null | 0 |

## Committee

Expand Down Expand Up @@ -79,13 +79,13 @@ Furthermore, corresponding reading methods are also supported:

| Method | Parameters | Fee in GAS | Contract |
| ---- | ------------------------------------ | ---- | ---- |
| [`GetDesignatedByRole`](../smart_contract_api/framework/native/RoleManagement/GetDesignatedByRole) | Role role, uint index | 0.00032768 (CpuFee) | RoleManagement |
| [`GetFeePerByte`](../smart_contract_api/framework/native/Policy/GetFeePerByte) | null | 0.00032768 (CpuFee) | PolicyContract |
| GetExecFeeFactor | null | 0.00032768 (CpuFee) | PolicyContract |
| GetStoragePrice | null | 0.00032768 (CpuFee) | PolicyContract |
| [`IsBlocked`](../smart_contract_api/framework/native/Policy/IsBlocked) | UInt160 account | 0.00032768 (CpuFee) | PolicyContract |
| [`GetDesignatedByRole`](../scapi/framework/native/RoleManagement/GetDesignatedByRole) | Role role, uint index | 0.00032768 (CpuFee) | RoleManagement |
| [`GetFeePerByte`](../scapi/framework/native/Policy/GetFeePerByte) | null | 0.00032768 (CpuFee) | PolicyContract |
| [GetExecFeeFactor](../scapi/framework/native/Policy/GetExecFeeFactor) | null | 0.00032768 (CpuFee) | PolicyContract |
| [GetStoragePrice](../scapi/framework/native/Policy/GetStoragePrice) | null | 0.00032768 (CpuFee) | PolicyContract |
| [`IsBlocked`](../scapi/framework/native/Policy/IsBlocked) | UInt160 account | 0.00032768 (CpuFee) | PolicyContract |
| GetPrice | null | 0.00032768 (CpuFee) | OracleContract |
| [`GetGasPerBlock`](../smart_contract_api/framework/native/Neo/GetGasPerBlock) | null | 0.00032768 (CpuFee) | NeoToken |
| [`GetGasPerBlock`](../scapi/framework/native/Neo/GetGasPerBlock) | null | 0.00032768 (CpuFee) | NeoToken |
| GetRegisterPrice | null | 0.00032768 (CpuFee) | NeoToken |
| GetMinimumDeploymentFee | null | 0.00032768 (CpuFee) | ContractManagement |

Expand All @@ -99,7 +99,7 @@ Committee members are refreshed every 21 blocks.

| Method | Parameters | Fee in GAS | Return value |
| ---- | ------------------------------------ | ---- | ---- |
| [`GetCommittee`](../smart_contract_api/framework/native/Neo/GetCommittee) | null | 0.04194304 (CpuFee) | Current committee members in format of ECPoint[] |
| [`GetCommittee`](../scapi/framework/native/Neo/GetCommittee) | null | 0.04194304 (CpuFee) | Current committee members in format of ECPoint[] |

## Consensus Nodes

Expand All @@ -117,7 +117,7 @@ Similar to committee members, consensus nodes are refreshed every 21 blocks.

| Method | Parameters | Fee in GAS | Return value |
| ---- | ------------------------------------ | ---- | ---- |
| [`GetNextBlockValidators`](../smart_contract_api/framework/native/Neo/GetNextBlockValidators) | null | 0.04194304 (CpuFee) | Consensus nodes by persisting block in format of ECPoint[] |
| [`GetNextBlockValidators`](../scapi/framework/native/Neo/GetNextBlockValidators) | null | 0.04194304 (CpuFee) | Consensus nodes by persisting block in format of ECPoint[] |

## Token Distribution

Expand All @@ -133,12 +133,12 @@ NEO and GAS are [Nep17](https://github.com/neo-project/proposals/blob/master/nep
| ---- | ---- | ---- | ---- |
| [`symbol`](symbol) | null | 0 | Token symbol in String |
| [`decimals`](decimals) | null | 0 | Token decimals in UInt |
| [`TotalSupply`](../smart_contract_api/framework/native/Neo/TotalSupply) | null | 0.00032768 (CpuFee) | Token total supply in BigInteger |
| [`BalanceOf`](../smart_contract_api/framework/native/Neo/BalanceOf) | UInt160 account | 0.00032768 (CpuFee) | account balance in BigInteger |
| [`Transfer`](../smart_contract_api/framework/native/Neo/Transfer) | UInt160 from, UInt160 to, BigInteger amount | 0.00131072 (CpuFee) + 0.0000005 (StorageFee) | Send specified amount of token from Address *from* to Address *to*. Please note that it will check *from*'s signature, whether caller is *from*, whether *to* is payable, whether *from*'s balance is enough |
| [`TotalSupply`](../scapi/framework/native/Neo/TotalSupply) | null | 0.00032768 (CpuFee) | Token total supply in BigInteger |
| [`BalanceOf`](../scapi/framework/native/Neo/BalanceOf) | UInt160 account | 0.00032768 (CpuFee) | account balance in BigInteger |
| [`Transfer`](../scapi/framework/native/Neo/Transfer) | UInt160 from, UInt160 to, BigInteger amount | 0.00131072 (CpuFee) + 0.0000005 (StorageFee) | Send specified amount of token from Address *from* to Address *to*. Please note that it will check *from*'s signature, whether caller is *from*, whether *to* is payable, whether *from*'s balance is enough |

Contract methods by NEO:

| Method | Parameters | Fee in GAS | Return value |
| ---- | ------------------------------------ | ---- | ---- |
| [`UnclaimedGas`](../smart_contract_api/framework/native/Neo/UnclaimedGas) | UInt160 account | 0.00131072 (CpuFee) | unclaimed GAS amount of this address in uint |
| [`UnclaimedGas`](../scapi/framework/native/Neo/UnclaimedGas) | UInt160 account | 0.00131072 (CpuFee) | unclaimed GAS amount of this address in uint |
Loading

0 comments on commit 2339894

Please sign in to comment.