Add Endpoints GetObjects & GetObjectInfo #579

arun-koshy · 2022-02-26T18:02:50Z

This is the third of a series of PR's that will implement the client service API described as part of the GDC Eng Deliverables

The endpoints that are included in this PR are:

Get Objects: Return all objects owned by the account address.
curl --location --request GET 'http://127.0.0.1:5000/wallet/objects?address=2DB7987BD5F905EB8A257DD7090AADEA4D8839D9'

Get Object Info: Get object info.
curl --location --request GET 'http://127.0.0.1:5000/wallet/object_info?owner=2DB7987BD5F905EB8A257DD7090AADEA4D8839D9&object_id=4C0C061D0D386D65FC4FED1A31195A2D305389FC'

sblackshear · 2022-02-27T22:52:38Z

sui/src/rest_server.rs

+#[derive(Deserialize, Serialize, JsonSchema)]
+struct Object {
+    object_id: String,
+    object_ref: serde_json::Value,


A bit confused here--an object reference contains an ID. Will the ID be duplicated here, or is this the (version, digest) part of an object ref (in which case we might want to call it something else)?

You are correct I was duplicating the ID, fixed it to explicitly return ID/Version/Digest

sblackshear · 2022-02-27T22:54:46Z

sui/src/rest_server.rs

+*/
+#[derive(Deserialize, Serialize, JsonSchema)]
+struct GetObjectInfoRequest {
+    owner: String,


In https://docs.google.com/document/d/1LYTRODgj5GuufocEqKTqzozJJ7MusFOK_s0f8JKoEaw/ (and I believe in the current CLI) the owner is optional. We should probably do the same here.

Current implementation of the CLI (which the rest server uses) requires the owner field to get a client state. I will add a TODO here to change that. The documentation in PR#544 also reflects the correct behavior.

sblackshear · 2022-02-27T22:55:06Z

sui/src/rest_server.rs

+*/
+#[derive(Deserialize, Serialize, JsonSchema)]
+struct ObjectInfoResponse {
+    owner: String,


I think comments on these would be useful.

Full documentation will come with the merge of PR#544 but I will add the comments for these endpoints in this PR as well.

sblackshear · 2022-02-27T22:57:25Z

sui/src/rest_server.rs

+
+#[derive(Deserialize, Serialize, JsonSchema)]
+struct Object {
+    object_id: String,


What are the restrictions on the types that can appear in a Response--e.g., could this be object_id: ObjectID instead?

It just needs to derive Serialize/Deserialize and JsonSchema. i.e. ObjectID would need to derive from JsonSchema and so would AccountAddress and so on.

Gotcha + makes sense. I would be in favor of adding these #derive(JsonSchema)'s everywhere instead of converting our Rust types into strings.

I did not know about this schemars library that provides JsonSchema--it is pretty nifty. Am wondering if we can express our SuiJSON via a schema (not a priority, but could be useful for unifying JSON input/output formats in the future). CC @oxade for thoughts

https://graham.cool/schemars/

This would be great! I attempted to do this earlier but I started getting into the weeds with PublicKeyBytes/dalek and I thought it was better to punt the idea. But now that SuiAddress & PublicKeyBytes are decoupled this may be easier? I will open an issue for this to either to derive from JsonSchema or a custom SuiJsonSchema

huitseeker · 2022-02-26T20:52:25Z

sui/src/rest_server.rs

+    // Need to use a random id because rocksdb locks on current process which
+    // means even if the directory is deleted the lock will remain causing an
+    // IO Error when a restart is attempted.


/cc @laura-makdah for visibility of cleanup conditions (relevant to an unrelated effort)

arun-koshy · 2022-02-26T18:06:55Z

sui/src/rest_server.rs

+    let get_objects_params = query.into_inner();
+    let address = get_objects_params.address;
+
+    let wallet_context = &mut *server_context.wallet_context.lock().unwrap();


@huitseeker I am not sure exactly why I am able to borrow a mutable reference here without the macro complaining. The only difference is that I don't call an async function on client state (which is created from wallet context). Not sure if you see something I don't here.

arun-koshy · 2022-02-28T07:01:49Z

sui/src/rest_server.rs

+
+#[derive(Deserialize, Serialize, JsonSchema)]
+struct Object {
+    object_id: String,


It just needs to derive Serialize/Deserialize and JsonSchema. i.e. ObjectID would need to derive from JsonSchema and so would AccountAddress and so on.

arun-koshy · 2022-02-28T07:02:30Z

sui/src/rest_server.rs

+#[derive(Deserialize, Serialize, JsonSchema)]
+struct Object {
+    object_id: String,
+    object_ref: serde_json::Value,


You are correct I was duplicating the ID, fixed it to explicitly return ID/Version/Digest

arun-koshy · 2022-02-28T07:10:49Z

sui/src/rest_server.rs

+*/
+#[derive(Deserialize, Serialize, JsonSchema)]
+struct GetObjectInfoRequest {
+    owner: String,


Current implementation of the CLI (which the rest server uses) requires the owner field to get a client state. I will add a TODO here to change that. The documentation in PR#544 also reflects the correct behavior.

arun-koshy · 2022-02-28T07:11:23Z

sui/src/rest_server.rs

+*/
+#[derive(Deserialize, Serialize, JsonSchema)]
+struct ObjectInfoResponse {
+    owner: String,


Full documentation will come with the merge of PR#544 but I will add the comments for these endpoints in this PR as well.

sblackshear · 2022-02-28T23:08:36Z

sui/src/rest_server.rs

+
+#[derive(Deserialize, Serialize, JsonSchema)]
+struct Object {
+    object_id: String,


Gotcha + makes sense. I would be in favor of adding these #derive(JsonSchema)'s everywhere instead of converting our Rust types into strings.

I did not know about this schemars library that provides JsonSchema--it is pretty nifty. Am wondering if we can express our SuiJSON via a schema (not a priority, but could be useful for unifying JSON input/output formats in the future). CC @oxade for thoughts

https://graham.cool/schemars/

sui/src/rest_server.rs

Co-authored-by: Sam Blackshear <[email protected]>

Adds a few missing type constraints in the `KeyPair` trait, closes #579.

Adds a few missing type constraints in the `KeyPair` trait, closes MystenLabs#579.

arun-koshy added 4 commits February 24, 2022 13:00

Add get addresses endpoint

2f627a5

small error output change

9423477

merge main

51e7310

Add GetObjects & GetObjectsInfo Endpoints

926ca0d

arun-koshy requested review from huitseeker, patrickkuo, sblackshear and oxade February 26, 2022 18:02

sblackshear reviewed Feb 27, 2022

View reviewed changes

huitseeker reviewed Feb 28, 2022

View reviewed changes

Add documentation & Fix GetObjectsResponse

c454372

arun-koshy commented Feb 28, 2022

View reviewed changes

merge main

1219523

sblackshear reviewed Feb 28, 2022

View reviewed changes

arun-koshy and others added 2 commits February 28, 2022 16:05

Update sui/src/rest_server.rs

fbfafe7

Co-authored-by: Sam Blackshear <[email protected]>

change to field name to version

7d25108

sblackshear approved these changes Mar 1, 2022

View reviewed changes

comment formatting

138e1ec

arun-koshy merged commit 1caf721 into main Mar 1, 2022

arun-koshy deleted the arun/objects branch March 1, 2022 06:19

mwtian pushed a commit that referenced this pull request Sep 12, 2022

fix: fix key usage in restarter,

7f49d8b

Adds a few missing type constraints in the `KeyPair` trait, closes #579.

mwtian pushed a commit to mwtian/sui that referenced this pull request Sep 29, 2022

fix: fix key usage in restarter,

15b0b1b

Adds a few missing type constraints in the `KeyPair` trait, closes MystenLabs#579.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Endpoints GetObjects & GetObjectInfo #579

Add Endpoints GetObjects & GetObjectInfo #579

arun-koshy commented Feb 26, 2022

sblackshear Feb 27, 2022

arun-koshy Feb 28, 2022

sblackshear Feb 27, 2022

arun-koshy Feb 28, 2022

sblackshear Feb 27, 2022

arun-koshy Feb 28, 2022

sblackshear Feb 27, 2022

arun-koshy Feb 28, 2022

sblackshear Feb 28, 2022

arun-koshy Mar 1, 2022

huitseeker Feb 26, 2022

arun-koshy Feb 26, 2022

arun-koshy Feb 28, 2022

arun-koshy Feb 28, 2022

arun-koshy Feb 28, 2022

arun-koshy Feb 28, 2022

sblackshear Feb 28, 2022

Add Endpoints GetObjects & GetObjectInfo #579

Add Endpoints GetObjects & GetObjectInfo #579

Conversation

arun-koshy commented Feb 26, 2022

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment