API v2 specification along with the new requirements #300

kacpersaw · 2024-01-24T19:05:28Z

No description provided.

…eward, network and node)

lrettig

great start. see comments.

one more thing to add: TransactionService.EstimateGas which receives a tx (with max gas unset) and returns a recommended max gas.

spacemesh/v2/account.proto

spacemesh/v2/block.proto

spacemesh/v2/tx.proto

lrettig · 2024-01-24T21:15:03Z

spacemesh/v2/tx.proto

+
+// An immutable Spacemesh transaction.
+// do not include mutable data such as tx state or result.
+message TransactionV1 {


need to also add recipient and send amount (for Send txs). I'm not 100% sure how to structure this. we should probably add a subfield, something liked ParsedContents, that's oneof depending on the type of tx (spawn, self spawn, send, etc.)

we can also left that to user. In explorer I'm parsing every tx from raw format, but if you want to put everything as fields we can do that.

Yes, this is an important requirement for consumers. We shouldn't require them to parse a raw TX, the API should provide the parsed TX. If for some reason we think this will be expensive, we can add a flag to the Request object to enable this.

Co-authored-by: Lane Rettig <lanerettig@gmail.com>

lrettig

Great work, design is almost done.

spacemesh/v2/network.proto

lrettig · 2024-02-15T23:00:42Z

spacemesh/v2/network.proto

+  uint32 layer_duration = 3; // layer duration, in seconds
+  bytes genesis_id = 4;
+  string hrp = 5;
+  uint32 first_genesis = 7; // first effective genesis layer


I see in the code that this has to do with checkpoint restore. In practice effective genesis and "first genesis" are the same. Let's keep things simple and collapse these two into a single data item called effective_genesis_layer for clarity.

spacemesh/v2/network.proto

lrettig · 2024-02-15T23:13:14Z

spacemesh/v2/node.proto

+  uint32 synced_layer = 3; // the last layer node has synced
+  uint32 verified_layer = 4; // the last layer node has verified
+  uint32 head_layer = 5; // head layer is the tip
+  uint32 head_block = 6;


I think we're missing one. Here's my proposal:

uint32 synced_layer = 3; // last layer node has synced uint32 verified_layer = 4; // last layer node has verified uint32 head_layer = 5; // current chain head; the last layer the node has gossiped or seen uint32 current_layer = 6; // current layer, based on clock time

synced_layer is only useful while syncing. Blocks are also received via gossip. The relationship should be:

synced_layer <= verified_layer <= head_layer <= current_layer

lrettig · 2024-02-15T23:15:27Z

spacemesh/v2/tx.proto

+
+// An immutable Spacemesh transaction.
+// do not include mutable data such as tx state or result.
+message TransactionV1 {


Yes, this is an important requirement for consumers. We shouldn't require them to parse a raw TX, the API should provide the parsed TX. If for some reason we think this will be expensive, we can add a flag to the Request object to enable this.

lrettig · 2024-02-15T23:17:17Z

spacemesh/v2/tx.proto

+  string template = 3;
+  uint32 method = 4; // this is actually limited by uint8, but no type for that.
+  Nonce nonce = 5;
+  LayerLimits limits = 6;


confirmed, layer limits for tx are not currently enabled. let's remove this for now for simplicity and to avoid confusion.

lrettig · 2024-02-15T23:50:01Z

See latest commit, this is my attempt to add parsed tx contents. Feel free to tweak!

Co-authored-by: Lane Rettig <lanerettig@gmail.com>

kacpersaw · 2024-02-16T13:16:50Z

See latest commit, this is my attempt to add parsed tx contents. Feel free to tweak!

looks good, we can start with that

lrettig

lgtm! just need one more small change.

spacemesh/v2alpha1/node.proto

lrettig · 2024-02-20T00:16:23Z

spacemesh/v2alpha1/tx.proto

+  repeated string pubkey = 2;
+}
+
+message TransactionContents {


This should also be versioned, but it lives inside a versioned tx type so maybe that's enough. What do you think?

lrettig · 2024-02-20T00:17:01Z

spacemesh/v2alpha1/tx.proto

+  uint64 gas_price = 7; // fee per unit gas, in smidge
+  uint64 max_spend = 8;
+  bytes raw = 9;
+  enum TransactionType {


For the record there are other types, involving the vault and vesting wallet templates, but neither is relevant right now and we can add these later.

Bumps google.golang.org/protobuf from 1.31.0 to 1.32.0. --- updated-dependencies: - dependency-name: google.golang.org/protobuf dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [github.com/grpc-ecosystem/grpc-gateway/v2](https://github.com/grpc-ecosystem/grpc-gateway) from 2.18.1 to 2.19.0. - [Release notes](https://github.com/grpc-ecosystem/grpc-gateway/releases) - [Changelog](https://github.com/grpc-ecosystem/grpc-gateway/blob/main/.goreleaser.yml) - [Commits](grpc-ecosystem/grpc-gateway@v2.18.1...v2.19.0) --- updated-dependencies: - dependency-name: github.com/grpc-ecosystem/grpc-gateway/v2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.60.1 to 1.61.0. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](grpc/grpc-go@v1.60.1...v1.61.0) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [github.com/grpc-ecosystem/grpc-gateway/v2](https://github.com/grpc-ecosystem/grpc-gateway) from 2.19.0 to 2.19.1. - [Release notes](https://github.com/grpc-ecosystem/grpc-gateway/releases) - [Changelog](https://github.com/grpc-ecosystem/grpc-gateway/blob/main/.goreleaser.yml) - [Commits](grpc-ecosystem/grpc-gateway@v2.19.0...v2.19.1) --- updated-dependencies: - dependency-name: github.com/grpc-ecosystem/grpc-gateway/v2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: Bartosz Różański <bartek.roza@gmail.com>

Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.61.0 to 1.61.1. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](grpc/grpc-go@v1.61.0...v1.61.1) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>

kacpersaw · 2024-04-02T16:06:26Z

Specification was divided into separate PRs to avoid merging all definitions at once. Current progress can be found here: #295 (comment)

kacpersaw added 3 commits December 22, 2023 12:33

Add Account and Transaction service

3b736eb

Add v2 resources according to specification (account, block, layer, r…

063c964

…eward, network and node)

Add v2 transaction service

090594f

kacpersaw linked an issue Jan 24, 2024 that may be closed by this pull request

Finalize API v2 specification along with the new requirements #295

Open

lrettig requested changes Jan 24, 2024

View reviewed changes

kacpersaw and others added 12 commits February 2, 2024 11:07

Update spacemesh/v2/account.proto

2485b17

Co-authored-by: Lane Rettig <lanerettig@gmail.com>

Update spacemesh/v2/block.proto

f4b4a86

Co-authored-by: Lane Rettig <lanerettig@gmail.com>

Update spacemesh/v2/layer.proto

7145b78

Co-authored-by: Lane Rettig <lanerettig@gmail.com>

Apply suggestions from code review

2dd0cd8

Co-authored-by: Lane Rettig <lanerettig@gmail.com>

Apply suggestions from review comments

c3aca8c

Add comments

cc61f8e

remove bitfield from nonce type

4217e64

add ParseTransactionResponse

bcf10c5

return tx_id for submitted tx

0ea7633

Add ListBySmesher to RewardService

babbcee

Add EstimateGas to TransactionService

39e5d8f

Fix rewards and build v2

8bf4fdb

kacpersaw mentioned this pull request Feb 15, 2024

API v2alpha1 activations #305

Merged

lrettig requested changes Feb 15, 2024

View reviewed changes

Add parsed tx contents

56cef0b

kacpersaw and others added 5 commits February 16, 2024 08:51

Update spacemesh/v2/network.proto

44131e9

Co-authored-by: Lane Rettig <lanerettig@gmail.com>

Update spacemesh/v2/network.proto

356967c

Co-authored-by: Lane Rettig <lanerettig@gmail.com>

Move v2 to v2alpha1

ec026ea

Remove layer limits

24b2b30

Apply review suggestions

3fef9a1

buf generate

1a4b69a

kacpersaw marked this pull request as ready for review February 16, 2024 23:49

lrettig requested changes Feb 20, 2024

View reviewed changes

kacpersaw and others added 21 commits February 20, 2024 08:49

Rename head_block

f42ab30

Add "until" to PoetWaitRound, PoetWaitProof, AtxPublished events

3a80bb0

Fix indentation

2d8ac12

Add POST_INDEX malfeasance proof

28f69e2

Extend API for multismesher node

1a80a40

Add v2alpha1 atxs

d2c765a

Apply suggestions from review

d5f6f85

Update build

88b67dc

Update spacemesh/v2alpha1/activation.proto

5df3172

Co-authored-by: Bartosz Różański <bartek.roza@gmail.com>

Modify comment

194553a

Modify comment

c2aee87

generate new build

5c8fe0f

switch reward smesher field to bytes

52e1aa5

Add layer filter to reward request

47f0e8a

Add start/end layer filter to reward request

71210bf

Add reward stream service

ef8ca21

kacpersaw mentioned this pull request Feb 21, 2024

v2alpha1: add reward service #307

Merged

This was referenced Mar 19, 2024

v2alpha1: add network service #315

Merged

v2alpha1: add node service #316

Merged

kacpersaw closed this Apr 2, 2024

This was referenced Apr 5, 2024

v2alpha1: Add LayerService with transaction and block definition #319

Merged

api v2 spacemeshos/pm#270

Open

lrettig mentioned this pull request Apr 16, 2024

Block validity not currently exposed #287

Open

fasmat deleted the api-v2 branch April 19, 2024 14:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API v2 specification along with the new requirements #300

API v2 specification along with the new requirements #300

kacpersaw commented Jan 24, 2024

lrettig left a comment

lrettig Jan 24, 2024

kacpersaw Feb 5, 2024 •

edited

lrettig Feb 15, 2024

lrettig left a comment

lrettig Feb 15, 2024

lrettig Feb 15, 2024

lrettig Feb 15, 2024

lrettig Feb 15, 2024

lrettig commented Feb 15, 2024

kacpersaw commented Feb 16, 2024

lrettig left a comment

lrettig Feb 20, 2024

lrettig Feb 20, 2024

kacpersaw commented Apr 2, 2024 •

edited

API v2 specification along with the new requirements #300

API v2 specification along with the new requirements #300

Conversation

kacpersaw commented Jan 24, 2024

lrettig left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kacpersaw Feb 5, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lrettig left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lrettig commented Feb 15, 2024

kacpersaw commented Feb 16, 2024

lrettig left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kacpersaw commented Apr 2, 2024 • edited

kacpersaw Feb 5, 2024 •

edited

kacpersaw commented Apr 2, 2024 •

edited