Feature: Mesh API Implementation #1021

dhedey · 2024-11-12T15:34:44Z

Summary

This PR implements the Mesh API for Radix.

Details

Data API

Endpoint	Status
- /network/list	Done
- /network/status	Done
- /network/options	Done
- /block	Done
- /block/transaction	Done, `Withdraw` and `Deposit` operations only
- /account/balance	Done, no historical balance lookup
- /mempool	Done
- /mempool/transaction	Done, no operation estimation

Construction API

All endpoints have been implemented and only single signer/sender is supported.

Endpoint	Status
- /construction/derive	Done
- /construction/preprocess	Done
- /construction/metadata	Done
- /construction/payloads	Done, `Withdraw` and `Deposit` operations only
- /construction/combine	Done
- /construction/parse	Done
- /construction/hash	Done
- /construction/submit	Done

Testing

We've added the mesh-cli test suites to CI.

source: https://github.com/coinbase/mesh-specifications/blob/v1.4.15/api.yaml

docker/config/default.config.envsubst

This reverts commit e4f2720.

dhedey

Looking good! I'm half way through this review, so going to drop the comments I have so far -- all very minor.

I've yet to review the handlers and common.rs in full.

dhedey · 2024-11-19T11:23:06Z

core/src/main/java/com/radixdlt/RadixNodeModule.java

@@ -118,12 +119,14 @@ public final class RadixNodeModule extends AbstractModule {
  private static final int DEFAULT_ENGINE_STATE_API_PORT = 3336;
  private static final int DEFAULT_SYSTEM_API_PORT = 3334;
  private static final int DEFAULT_PROMETHEUS_API_PORT = 3335;
+  private static final int DEFAULT_MESH_API_PORT = 3337;


Just a thought - we may need to talk to devops about getting this port hooked up in the babylon-nginx image.

core/src/test/java/com/radixdlt/api/mesh_api/MeshApiMempoolEndpointsTest.java

core-rust/mesh-api-server/mesh-cli-configs/default.json

docker/core.yml

core-rust/mesh-api-server/src/mesh_api/conversions/crypto.rs

core-rust/mesh-api-server/src/mesh_api/conversions/hashes.rs

core-rust/mesh-api-server/src/mesh_api/conversions/common.rs

dhedey

Some further comments. I can't approve as github thinks it's my PR!

Nearly all the comments are minor consistency / code location / naming improvements.

dhedey · 2024-11-19T15:25:43Z

core-rust/mesh-api-server/src/mesh_api/conversions/common.rs

+        let fee_balance_change = fee_balance_changes
+            .entry(global_ancestor_address)
+            .or_insert_with(Decimal::zero);
+        *fee_balance_change = fee_balance_change.sub_or_panic(*paid_fee_amount_xrd);


I assume paid_fee_amount_xrd must be negative :D

Not sure if I get this.
Whole method was copied from Core API

Don't worry - this was just an unimportant observation.
I was a little surprised we were subtracting values, and expecting a positive balance coming out. But I assume paid_fee_amount_xrd must be negative.

core-rust/mesh-api-server/src/mesh_api/conversions/common.rs

core-rust/mesh-api-server/src/mesh_api/handlers/network_status.rs

core-rust/mesh-api-server/src/mesh_api/handlers/network_options.rs

core-rust/mesh-api-server/src/mesh_api/handlers/construction_parse.rs

dhedey · 2024-11-21T15:14:08Z

core-rust/mesh-api-server/src/mesh_api/conversions/block.rs

    ledger_header: &LedgerStateSummary,
 ) -> Result<models::BlockIdentifier, MappingError> {
-    to_mesh_api_block_identifier_from_state_version(ledger_header.state_version)
+    to_mesh_api_block_identifier_from_state_version(database, ledger_header.state_version)


MINOR - In this case, we don't need to do a database read, because we have ledger_header.state_version and ledger_header.ledger_hashes :).

I'd perhaps expect a to_mesh_api_block_identifier(state_version: StateVersion, ledger_hashes: &LedgerHashes) which to_mesh_api_block_identifier_from_ledger_header can call directly, and to_mesh_api_block_identifier_from_state_version can call via the transaction_identifiers read.

Wil fix it in next PR

core-rust/mesh-api-server/src/mesh_api/errors.rs

core-rust/mesh-api-server/src/mesh_api/handlers/construction_payloads.rs

dhedey · 2024-11-21T15:27:44Z

docker/config/default.config.envsubst

@@ -1,3 +1,5 @@
+api.mesh.enabled=$RADIXDLT_MESH_API_ENABLED


Can we put this just above api.mesh.port?

Was really confused when you initially asked to put it in the first line 🤣

dhedey

Latest changes LGTM

lrubasze

Approve on @dhedey's behalf

sonarqubecloud · 2024-11-21T18:06:35Z

Quality Gate passed

Issues
8 New issues
0 Accepted issues

Measures
0 Security Hotspots
37.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

lrubasze added 30 commits November 5, 2024 21:13

Add MeshApi v1.4.15 schema

0451b01

source: https://github.com/coinbase/mesh-specifications/blob/v1.4.15/api.yaml

Add generated openapi server

21db3e2

mesh-api-server initial implementation

4badcac

MeshApi support in Java part

beb0172

Adjust errors to MeshApi requirements

22e1e2c

Add network/status endpoint

73086f4

Add network/list endpoint

d7a19a0

Refactor error reporting

386d221

Add network/options endpoint

b493069

Assume block is a single transaction

2a5a38d

Add account/balance endpoint

e583d77

Hardcode node version

b11d85e

Unsupport historical balance querying

1aac9ea

Use index as hash in block identifier

76c4451

Add endpoint stubs

3cc82f3

Fix formatting

e3a4e6c

Add mesh-api-server to Dockerfile

bdf71f0

Block identifier conversions improved

8b8c4a1

Cleanup

f1fdeff

Cleanup OpenAPI generation scripts

ae467e3

Cleanup TODO notes

a7e617a

Tweak network status response

322ee34

Add more TODOs

34c4379

Tweak network status response

5bb0067

Some renaming

56b4153

Fix Currency <-> ResourceAddress conversion

ceaeac3

Add extract_account

74af262

Add support for node version fetching

205fea7

Remove FeatureNotEnabled error

81bf9da

Cleanup

07045b1

iamyulong marked this pull request as ready for review November 15, 2024 17:07

iamyulong and others added 3 commits November 15, 2024 17:26

Clean up error in conventions mod

1f89f0c

Clean up construction errors

6e03a72

Setup workflow in separate scenario

e4f2720

dhedey commented Nov 18, 2024

View reviewed changes

docker/config/default.config.envsubst Show resolved Hide resolved

lrubasze added 4 commits November 18, 2024 13:59

More error cleanup

d87b52d

Remove not used errors

e0050aa

Revert "Setup workflow in separate scenario"

93c5c76

This reverts commit e4f2720.

Workaround mesh-cli DSL parsing error

7003fc7

dhedey commented Nov 19, 2024

View reviewed changes

Mempool tests cleanup

2753ec2

lrubasze force-pushed the feature/mesh branch from ecca0d7 to 9c481a0 Compare November 20, 2024 22:03

lrubasze added 4 commits November 21, 2024 15:27

Some cleanup

36bca03

TODOs added

46cebc9

More cleanup

d37c370

Reimplement block hash

9e03a3b

lrubasze force-pushed the feature/mesh branch from aed5c8b to 9e03a3b Compare November 21, 2024 14:27

dhedey commented Nov 21, 2024

View reviewed changes

core-rust/mesh-api-server/src/mesh_api/errors.rs Show resolved Hide resolved

dhedey commented Nov 21, 2024

View reviewed changes

core-rust/mesh-api-server/src/mesh_api/handlers/construction_payloads.rs Show resolved Hide resolved

dhedey commented Nov 21, 2024

View reviewed changes

lrubasze added 2 commits November 21, 2024 16:40

Reimplement transaction identifier for non-user transactions

44bc046

Cleanup

df784c5

dhedey commented Nov 21, 2024

View reviewed changes

Merge branch 'develop' into feature/mesh

c8c5f33

lrubasze approved these changes Nov 21, 2024

View reviewed changes

iamyulong merged commit b8f3151 into develop Nov 21, 2024
23 checks passed

iamyulong deleted the feature/mesh branch November 21, 2024 21:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Mesh API Implementation #1021

Feature: Mesh API Implementation #1021

dhedey commented Nov 12, 2024 •

edited by iamyulong

Loading

dhedey left a comment

dhedey Nov 19, 2024

dhedey left a comment

dhedey Nov 19, 2024

lrubasze Nov 20, 2024 •

edited

Loading

dhedey Nov 21, 2024 •

edited

Loading

dhedey Nov 21, 2024

lrubasze Nov 21, 2024

dhedey Nov 21, 2024

lrubasze Nov 21, 2024

dhedey left a comment

lrubasze left a comment

sonarqubecloud bot commented Nov 21, 2024

Feature: Mesh API Implementation #1021

Feature: Mesh API Implementation #1021

Conversation

dhedey commented Nov 12, 2024 • edited by iamyulong Loading

Summary

Details

Data API

Construction API

Testing

dhedey left a comment

Choose a reason for hiding this comment

dhedey Nov 19, 2024

Choose a reason for hiding this comment

dhedey left a comment

Choose a reason for hiding this comment

dhedey Nov 19, 2024

Choose a reason for hiding this comment

lrubasze Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

dhedey Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

dhedey Nov 21, 2024

Choose a reason for hiding this comment

lrubasze Nov 21, 2024

Choose a reason for hiding this comment

dhedey Nov 21, 2024

Choose a reason for hiding this comment

lrubasze Nov 21, 2024

Choose a reason for hiding this comment

dhedey left a comment

Choose a reason for hiding this comment

lrubasze left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 21, 2024

Quality Gate passed

dhedey commented Nov 12, 2024 •

edited by iamyulong

Loading

lrubasze Nov 20, 2024 •

edited

Loading

dhedey Nov 21, 2024 •

edited

Loading