`[New]` `RestServer` Plugin #3390

cschuchardt88 · 2024-07-02T18:58:38Z

Description

In this section you will learn about RestServer plugin and how it works.

Checkout the docs in ./docs/RestServer folder.

Dependencies

Microsoft.AspNetCore.JsonPatch.dll Required
Microsoft.AspNetCore.Mvc.NewtonsoftJson.dll Required
Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer.dll Required
Microsoft.AspNetCore.Mvc.Versioning.dll Required
Microsoft.OpenApi.dll Required
Newtonsoft.Json.Bson.dll Required
Newtonsoft.Json.dll Required
System.ServiceProcess.ServiceController.dll linux maybe
Microsoft.AspNetCore.Mvc.Versioning.dll Required
Microsoft.AspNetCore.Mvc.Versioning.dll Required
Microsoft.AspNetCore.Mvc.Versioning.dll Required
Microsoft.OpenApi.dll Swagger (optional)
Swashbuckle.AspNetCore.Swagger.dll Swagger (optional)
Swashbuckle.AspNetCore.SwaggerGen.dll Swagger (optional)
Swashbuckle.AspNetCore.SwaggerUI.dll Swagger (optional)
Swashbuckle.AspNetCore.Newtonsoft.dll Swagger (optional)
RestServer.xml Swagger UI (optional)

In Docker

RestServer
|   |   |-- Microsoft.AspNetCore.JsonPatch.dll
|   |   |-- Microsoft.AspNetCore.Mvc.NewtonsoftJson.dll
|   |   |-- Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer.dll
|   |   |-- Microsoft.AspNetCore.Mvc.Versioning.dll
|   |   |-- Microsoft.OpenApi.dll
|   |   |-- Neo.ConsoleService.dll
|   |   |-- Newtonsoft.Json.Bson.dll
|   |   |-- Newtonsoft.Json.dll
|   |   |-- RestServer.deps.json
|   |   |-- RestServer.dll
|   |   |-- RestServer.pdb
|   |   |-- RestServer.xml
|   |   |-- Swashbuckle.AspNetCore.Newtonsoft.dll
|   |   |-- Swashbuckle.AspNetCore.Swagger.dll
|   |   |-- Swashbuckle.AspNetCore.SwaggerGen.dll
|   |   |-- Swashbuckle.AspNetCore.SwaggerUI.dll
|   |   |-- System.ServiceProcess.ServiceController.dll
|   |   |-- config.json
|   |   `-- runtimes
|   |       `-- win
|   |           `-- lib
|   |               `-- net6.0
|   |                   `-- System.ServiceProcess.ServiceController.dll

These files go in the same directory as the RestServer.dll. In neo-cli
plugins/RestServer/ folder.

Response Headers

Name	Value(s)	Description
server	neo-cli/3.6.0 RestServer/3.6.0	`neo-cli` and `RestServer` version.

JSON Serializer

RestServer uses custom Newtonsoft Json Converters to serialize controller action
responses and route parameters.

One Way Binding - Write only.

Neo.SmartContract.ContractState
Neo.SmartContract.NefFile
Neo.SmartContract.MethodToken
Neo.SmartContract.Native.TrimmedBlock
Neo.SmartContract.Manifest.ContractAbi
Neo.SmartContract.Manifest.ContractGroup
Neo.SmartContract.Manifest.ContractManifest
Neo.SmartContract.Manifest.ContractPermission
Neo.SmartContract.Manifest.ContractPermissionDescriptor
Neo.Network.P2P.Payloads.Block
Neo.Network.P2P.Payloads.Header
Neo.Network.P2P.Payloads.Signer
Neo.Network.P2P.Payloads.TransactionAttribute
Neo.Network.P2P.Payloads.Transaction
Neo.Network.P2P.Payloads.Witness

Two Way Binding - Read & Write

System.Guid
System.ReadOnlyMemory<T>
Neo.BigDecimal
Neo.UInt160
Neo.UInt256
Neo.Cryptography.ECC.ECPoint
Neo.VM.Types.Array
Neo.VM.Types.Boolean
Neo.VM.Types.Buffer
Neo.VM.Types.ByteString
Neo.VM.Types.Integer
Neo.VM.Types.InteropInterface
Neo.VM.Types.Null
Neo.VM.Types.Map
Neo.VM.Types.Pointer
Neo.VM.Types.StackItem
Neo.VM.Types.Struct

Remote Endpoints

Parametes {hash} can be any Neo N3 address or scripthash; {address} can be any Neo N3 address only; {number} and {index} can be any uint32.

Parameter Examples

{hash} - 0xef4073a0f2b305a38ec4050e4d3d28bc40ea63f5 or NiHURyS83nX2mpxtA7xq84cGxVbHojj5Wc
{address} - NiHURyS83nX2mpxtA7xq84cGxVbHojj5Wc
{number} - 1
{index} - 2500000

Paths

Utils
- [GET] /api/v1/utils/{hash}/address
- [GET] /api/v1/utils/{address}/scripthash
- [GET] /api/v1/utils/{hash}/{address}/validate
Node
- [GET] /api/v1/node/peers
- [GET] /api/v1/node/plugins
- [GET] /api/v1/node/settings
Ledger
- [GET] /api/v1/ledger/neo/accounts
- [GET] /api/v1/ledger/gas/accounts
- [GET] /api/v1/ledger/blocks?page={number}&size={number}
- [GET] /api/v1/ledger/blocks/height
- [GET] /api/v1/ledger/blocks/{index}
- [GET] /api/v1/ledger/blocks/{index}/header
- [GET] /api/v1/ledger/blocks/{index}/witness
- [GET] /api/v1/ledger/blocks/{index}/transactions?page={number}&size={number}
- [GET] /api/v1/ledger/transactions/{hash}
- [GET] /api/v1/ledger/transactions/{hash}/witnesses
- [GET] /api/v1/ledger/transactions/{hash}/signers
- [GET] /api/v1/ledger/transactions/{hash}/attributes
- [GET] /api/v1/ledger/memorypool?page={number}&size={number}
- [GET] /api/v1/ledger/memorypool/verified?page={number}&size={number}
- [GET] /api/v1/ledger/memorypool/unverified?page={number}&size={number}
- [GET] /api/v1/ledger/memorypool/count
Tokens
- [GET] /api/v1/tokens/balanceof/{address}
- NFTs
  - [GET] /api/v1/tokens/nep-11?page={number}&size={number}
  - [GET] /api/v1/tokens/nep-11/count
  - [GET] /api/v1/tokens/nep-11/{hash}/balanceof/{address}
- NEP-17
  - [GET] /api/v1/tokens/nep-17?page={number}&size={number}
  - [GET] /api/v1/tokens/nep-17/count
  - [GET] /api/v1/tokens/nep-17/{hash}/balanceof/{address}
Contracts
- [GET] /api/v1/contracts?page={number}&size={number}
- [GET] /api/v1/contracts/count
- [GET] /api/v1/contracts/{hash}
- [GET] /api/v1/contracts/{hash}/abi
- [GET] /api/v1/contracts/{hash}/manifest
- [GET] /api/v1/contracts/{hash}/nef
- [GET] /api/v1/contracts/{hash}/storage

Type of change

Optimization (the change is only an optimization)
Style (the change is only a code style for better maintenance or standard purpose)
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

By @superboyiii from neo-project/neo-modules#839

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules

src/Plugins/RestServer/Controllers/v1/ContractsController.cs

superboyiii · 2024-07-08T07:12:55Z

All contractstates are missing updatecounter in Contracts collections. Maybe need make result as contracts.ToJson().

superboyiii · 2024-07-08T10:38:53Z

src/Plugins/RestServer/Controllers/v1/ContractsController.cs

+                throw new QueryParameterNotFoundException(nameof(method));
+            try
+            {
+                var engine = ScriptHelper.InvokeMethod(_neosystem.Settings, _neosystem.StoreView, contracts.Hash, method, contractParameters, out var script);


Need supporting signer account and scope like what invokefunction did, or methods can't pass verifywitness.

src/Plugins/RestServer/Controllers/v1/LedgerController.cs

src/Plugins/RestServer/Controllers/v1/ContractsController.cs

src/Plugins/RestServer/Controllers/v1/LedgerController.cs

src/Plugins/RestServer/Controllers/v1/TokensController.cs

Jim8y · 2024-07-27T04:02:57Z

@cschuchardt88 conflict

superboyiii · 2024-08-08T08:48:43Z

result[0] of BalanceOf can be type of any.

@cschuchardt88

src/Plugins/RestServer/Tokens/NEP17Token.cs

superboyiii · 2024-08-29T07:32:27Z

@cschuchardt88 Can we go on this? RestServer is useful, we need update and fix this.

src/Plugins/RestServer/Helpers/ContractHelper.cs

Added RestServer Plugin

47e11e0

cschuchardt88 mentioned this pull request Jul 2, 2024

Create a 'getTransactions' RPC endpoint (plugin/extension) #3297

Open

cschuchardt88 added waiting for review Plugins labels Jul 4, 2024

Merge branch 'master' into add/plugins/rest-server

bd94807

superboyiii reviewed Jul 8, 2024

View reviewed changes

src/Plugins/RestServer/Controllers/v1/ContractsController.cs Outdated Show resolved Hide resolved

superboyiii reviewed Jul 8, 2024

View reviewed changes

superboyiii reviewed Jul 9, 2024

View reviewed changes

src/Plugins/RestServer/Controllers/v1/LedgerController.cs Outdated Show resolved Hide resolved

superboyiii reviewed Jul 9, 2024

View reviewed changes

src/Plugins/RestServer/Controllers/v1/ContractsController.cs Outdated Show resolved Hide resolved

Merge branch 'master' into add/plugins/rest-server

e261aa6

superboyiii reviewed Jul 10, 2024

View reviewed changes

src/Plugins/RestServer/Controllers/v1/LedgerController.cs Outdated Show resolved Hide resolved

superboyiii reviewed Jul 12, 2024

View reviewed changes

src/Plugins/RestServer/Controllers/v1/TokensController.cs Show resolved Hide resolved

cschuchardt88 and others added 6 commits July 16, 2024 11:58

Merge branch 'master' into add/plugins/rest-server

5e8d98f

Merge branch 'master' into add/plugins/rest-server

6ab87d5

Update neo.sln

a8ac960

Fixed issue with merging from master

03e2298

Added @superboyiii request changes PART-1

287bbd7

Merge branch 'master' into add/plugins/rest-server

08f74a6

Jim8y added the need update label Jul 27, 2024

cschuchardt88 and others added 7 commits July 27, 2024 17:06

Merge branch 'master' into add/plugins/rest-server

8f0c919

Update sln file

758894c

Added better checking for IsNep11Supported and IsNep17Supported

b45c59a

Added Confirmations to Block JSON output

9dd47d9

variable name fixes

b310d99

Merge branch 'master' into add/plugins/rest-server

bcf109d

Merge branch 'master' into add/plugins/rest-server

6d8f294

superboyiii reviewed Aug 8, 2024

View reviewed changes

src/Plugins/RestServer/Tokens/NEP17Token.cs Show resolved Hide resolved

Merge branch 'master' into add/plugins/rest-server

5240a05

superboyiii reviewed Aug 29, 2024

View reviewed changes

src/Plugins/RestServer/Helpers/ContractHelper.cs Show resolved Hide resolved

superboyiii reviewed Aug 29, 2024

View reviewed changes

src/Plugins/RestServer/Helpers/ContractHelper.cs Show resolved Hide resolved

cschuchardt88 and others added 4 commits September 1, 2024 13:18

Merge branch 'master' into add/plugins/rest-server

498fd37

Added Signers for Invoking contracts

7d9786e

Revert Neo.CLI Configuation file

5dd2083

Merge branch 'master' into add/plugins/rest-server

698b88d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`[New]` `RestServer` Plugin #3390

`[New]` `RestServer` Plugin #3390

cschuchardt88 commented Jul 2, 2024 •

edited

Loading

superboyiii commented Jul 8, 2024 •

edited

Loading

superboyiii Jul 8, 2024

cschuchardt88 Sep 1, 2024

Jim8y commented Jul 27, 2024

superboyiii commented Aug 8, 2024 •

edited

Loading

superboyiii commented Aug 29, 2024

[New] RestServer Plugin #3390

Are you sure you want to change the base?

[New] RestServer Plugin #3390

Conversation

cschuchardt88 commented Jul 2, 2024 • edited Loading

Description

Dependencies

In Docker

Response Headers

JSON Serializer

Remote Endpoints

Type of change

How Has This Been Tested?

Checklist:

superboyiii commented Jul 8, 2024 • edited Loading

superboyiii Jul 8, 2024

Choose a reason for hiding this comment

cschuchardt88 Sep 1, 2024

Choose a reason for hiding this comment

Jim8y commented Jul 27, 2024

superboyiii commented Aug 8, 2024 • edited Loading

superboyiii commented Aug 29, 2024

`[New]` `RestServer` Plugin #3390

`[New]` `RestServer` Plugin #3390

cschuchardt88 commented Jul 2, 2024 •

edited

Loading

superboyiii commented Jul 8, 2024 •

edited

Loading

superboyiii commented Aug 8, 2024 •

edited

Loading