Skip to content

Commit

Permalink
Merge pull request #128 from chenzhitong/rpc-catalogue
Browse files Browse the repository at this point in the history
Simplifying the directory paths of rpc documents
  • Loading branch information
Celia18305 authored Aug 12, 2024
2 parents c566c2c + dc592a3 commit d844e14
Show file tree
Hide file tree
Showing 56 changed files with 292 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/n3/develop/deploy/invoke.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can query a contract details using Neo-CLI or Neo-GUI, such as the contract

### Querying using Neo-CLI

Use the RPC API [getcontractstate method](../../reference/rpc/latest-version/api/getcontractstate.md) to query the contract information.
Use the RPC API [getcontractstate method](../../reference/rpc/getcontractstate.md) to query the contract information.

### Querying using Neo-GUI

Expand All @@ -31,7 +31,7 @@ You can choose one of the following ways to invoke the contract using Neo-CLI:

For more information refer to [invoke](../../node/cli/cli.md#invoke).

- Use the RPC API [invokefunction](../../reference/rpc/latest-version/api/invokefunction.md) or [invokescript](../../reference/rpc/latest-version/api/invokescript.md). The former is recommended.
- Use the RPC API [invokefunction](../../reference/rpc/invokefunction.md) or [invokescript](../../reference/rpc/invokescript.md). The former is recommended.

### Invoking a contract using Neo-GUI

Expand Down Expand Up @@ -108,7 +108,7 @@ The key statement is `Contract.Call(scriptHash, method, flags, params)`, where:

### Invocation permission

Three fields related to the contract invocation permission are defined in the contract manifest file, as shown in the following table. The wallet decides whether to give a security warning to the user based on the setting in the Groups and Trusts fields. Permissions and signature scopes determine whether contracts can be called by each other. For more information about signature scopes, refer to parameters description in [invokefunction method](../../reference/rpc/latest-version/api/invokefunction.md).
Three fields related to the contract invocation permission are defined in the contract manifest file, as shown in the following table. The wallet decides whether to give a security warning to the user based on the setting in the Groups and Trusts fields. Permissions and signature scopes determine whether contracts can be called by each other. For more information about signature scopes, refer to parameters description in [invokefunction method](../../reference/rpc/invokefunction.md).

| Fields | Type | Description |
| ------------- | ----------------------------- | ------------------------------------------------------------ |
Expand Down
2 changes: 1 addition & 1 deletion docs/n3/exchange/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ There are two methods to generate deposit addresses:

- When the user deposit (NEO/GAS) for the first time, the program dynamically generates a NEO address. The advantage is that there is no need to generate addresses at fixed time intervals, while the disadvantage is that it's not convenient for backup.

To develop the program to dynamically generate addresses, use the RpcServer API [getnewaddress Method](../reference/rpc/latest-version/api/getnewaddress). The created address is returned.
To develop the program to dynamically generate addresses, use the RpcServer API [getnewaddress Method](../reference/rpc/getnewaddress). The created address is returned.

- The exchange creates a batch of NEO addresses in advance. When the user charges (NEO/GAS) for the first time, the exchange assigns a NEO address to him or her. The advantage is the convenience to backup the wallet, while the disadvantage is the need to generate NEO addresses manually.
To generate addresses in batch, run the NEO- CLI command `create address [n]`. The addresses are exported automatically to the address.txt file.
Expand Down
2 changes: 1 addition & 1 deletion docs/n3/exchange/gas.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The following RPC method can be used to help exchanges query users' GAS informat

| Method | Description |
| ------------------------------------------------------------ | ------------------------------------------------------- |
| [getunclaimedgas](../reference/rpc/latest-version/api/getunclaimedgas.md) | Returns the unclaimed GAS amount in the current wallet. |
| [getunclaimedgas](../reference/rpc/getunclaimedgas.md) | Returns the unclaimed GAS amount in the current wallet. |

## Claiming GAS

Expand Down
6 changes: 3 additions & 3 deletions docs/n3/node/cli/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The following table lists all the plugins:

|Plugin|Description|API Included||
|--- |--- |--- |--- |
|ApplicationLogs|Synchronizes the smart contract log with the NativeContract log (Notify)|[getapplicationlog](../../reference/rpc/latest-version/api/getapplicationlog)|Recommended|
|ApplicationLogs|Synchronizes the smart contract log with the NativeContract log (Notify)|[getapplicationlog](../../reference/rpc/getapplicationlog)|Recommended|
|DBFTPlugin|dBFT consensus plugin||Mandatory when served as a consensus node|
|LevelDBStore|Uses LevelDB to store the blockchain data||Mandatory|
|MPTTrie|Uses LevelDB to store the MPT data||Mandatory when served as a StateRoot consensus node|
Expand All @@ -115,8 +115,8 @@ The following table lists all the plugins:
|RpcServer|Enables RPC for the node|[RPC API](../../reference/rpc/latest-version/api)|Mandatory|
|SQLiteWallet|A SQLite-based wallet provider that supports wallet files with .db3 suffix||Optional|
|StatesDumper|Exports Neo-CLI status data.||Optional|
|StateService|StateRoot consensus service plugin|[getstateroot](../../reference/rpc/latest-version/api/getstateroot) [getproof](../../reference/rpc/latest-version/api/getproof) [verifyproof](../../reference/rpc/latest-version/api/verifyproof.md) [getstateheight](../../reference/rpc/latest-version/api/getstateheight.md) |Mandatory when served as a StateRoot consensus node|
|TokensTracker|Enquiries NEP-11 and NEP-17 assets balance and transactions history of accounts through RPC|[getnep11balances](../../reference/rpc/latest-version/api/getnep11balances) [getnep11properties](../../reference/rpc/latest-version/api/getnep11properties) [getnep11transfers](../../reference/rpc/latest-version/api/getnep11transfers) [getnep17balances](../../reference/rpc/latest-version/api/getnep17balances) [getnep17transfers](../../reference/rpc/latest-version/api/getnep17transfers) |Recommended|
|StateService|StateRoot consensus service plugin|[getstateroot](../../reference/rpc/getstateroot) [getproof](../../reference/rpc/getproof) [verifyproof](../../reference/rpc/verifyproof.md) [getstateheight](../../reference/rpc/getstateheight.md) |Mandatory when served as a StateRoot consensus node|
|TokensTracker|Enquiries NEP-11 and NEP-17 assets balance and transactions history of accounts through RPC|[getnep11balances](../../reference/rpc/getnep11balances) [getnep11properties](../../reference/rpc/getnep11properties) [getnep11transfers](../../reference/rpc/getnep11transfers) [getnep17balances](../../reference/rpc/getnep17balances) [getnep17transfers](../../reference/rpc/getnep17transfers) |Recommended|

You can choose one of the following ways to install plugins:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ You can modify the port in config.json in the RpcServer folder.
| [getrawtransaction](api/getrawtransaction.md) | <txid\> [verbose=0] | Returns the transaction information with the specified hash value. |
| [getstorage](api/getstorage.md) | <script_hash\> <key\> | Returns the value with the contract script hash and the key. |
| [gettransactionheight](api/gettransactionheight.md) | <txid\> | Returns the transaction height with the specified transaction hash. |
| [findStorage](api/findStorage.md) | <script_hash / contract_id\> \<storage key prefix> | Finds storage items by contract ID or script hash and prefix. |


### Node
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit d844e14

Please sign in to comment.