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

Jim8y · 2025-04-10T22:53:26Z

@shargon rate limiting is applied.

src/Plugins/ApplicationLogs/ApplicationLogs.csproj

src/Plugins/DBFTPlugin/DBFTPlugin.csproj

src/Plugins/LevelDBStore/LevelDBStore.csproj

src/Plugins/OracleService/OracleService.csproj

src/Plugins/RpcServer/RpcServer.csproj

src/Plugins/RocksDBStore/RocksDBStore.csproj

src/Plugins/SQLiteWallet/SQLiteWallet.csproj

src/Plugins/StateService/StateService.csproj

src/Plugins/StorageDumper/StorageDumper.csproj

src/Plugins/TokensTracker/TokensTracker.csproj

src/Plugins/RestServer/RestServer.csproj

tests/Neo.Plugins.RestServer.Tests/Neo.Plugins.RestServer.Tests.csproj

src/Plugins/RestServer/Newtonsoft/Json/BigDecimalJsonConverter.cs

vncoelho

Are all the converters of Newtonsoft/Json needed?

Do we really need that?

I still worry about maintenance of this plugin compared to how it could be improved in terms of code re-use

cschuchardt88 · 2025-05-31T01:26:17Z

Are all the converters of Newtonsoft/Json needed?

Do we really need that?

I still worry about maintenance of this plugin compared to how it could be improved in terms of code re-use

There is markdown files explaining how to reuse or addon to the plugin in other plugins
https://github.com/neo-project/neo/blob/6792a007902da37ea662a4d3a412722039db2fbb/docs/RestServer/Addons.md

cschuchardt88 · 2025-07-25T21:02:10Z

see #4093 moved for merging dev branch.

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

apply rate limiting

bb2cef6

Jimmy and others added 7 commits April 11, 2025 06:54

remove extra comment

460cc50

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

f52ad23

Updated libraries

5ff9476

fixed tests

fd5b10d

change dotnet version

7602060

downloadgrade veersion

3da51a9

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

d269acb

shargon reviewed Apr 17, 2025

View reviewed changes

src/Plugins/ApplicationLogs/ApplicationLogs.csproj Outdated Show resolved Hide resolved

shargon reviewed Apr 17, 2025

View reviewed changes

src/Plugins/DBFTPlugin/DBFTPlugin.csproj Outdated Show resolved Hide resolved

Jimmy and others added 3 commits April 22, 2025 08:02

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

d509a51

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

00446dd

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

b8cc9ca

shargon reviewed May 19, 2025

View reviewed changes

Apply suggestions from code review

2a504b0

shargon reviewed May 19, 2025

View reviewed changes

src/Plugins/RestServer/RestServer.csproj Outdated Show resolved Hide resolved

Update src/Plugins/RestServer/RestServer.csproj

0d1adbd

shargon reviewed May 19, 2025

View reviewed changes

tests/Neo.Plugins.RestServer.Tests/Neo.Plugins.RestServer.Tests.csproj Show resolved Hide resolved

shargon added 2 commits May 19, 2025 08:43

Add <IsTestProject>true</IsTestProject>

24f2f56

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

3dfe79b

vncoelho reviewed May 19, 2025

View reviewed changes

src/Plugins/RestServer/Newtonsoft/Json/BigDecimalJsonConverter.cs Show resolved Hide resolved

vncoelho reviewed May 19, 2025

View reviewed changes

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

6792a00

Jim8y added this to the v3.9.0 milestone Jul 23, 2025

superboyiii mentioned this pull request Jul 24, 2025

v3.9.0 Checklist #4091

Open

cschuchardt88 mentioned this pull request Jul 25, 2025

Add RestServer Plugin #4093

Merged

17 tasks

cschuchardt88 closed this Jul 25, 2025

[New] RestServer Plugin #3390

[New] RestServer Plugin #3390

Uh oh!

Conversation

cschuchardt88 commented Jul 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Dependencies

In Docker

Response Headers

JSON Serializer

Remote Endpoints

Type of change

How Has This Been Tested?

Checklist:

Uh oh!

Uh oh!

superboyiii commented Jul 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

superboyiii Jul 8, 2024

Choose a reason for hiding this comment

Uh oh!

cschuchardt88 Sep 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Jim8y commented Jul 27, 2024

Uh oh!

superboyiii commented Aug 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Jim8y commented Apr 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vncoelho left a comment

Choose a reason for hiding this comment

Uh oh!

cschuchardt88 commented May 31, 2025

Uh oh!

cschuchardt88 commented Jul 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

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