Skip to content

Add Storable Helper Object #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 22, 2023
Merged

Add Storable Helper Object #13

merged 2 commits into from
Sep 22, 2023

Conversation

G8XSU
Copy link
Collaborator

@G8XSU G8XSU commented Sep 21, 2023

Motivation: Provides helper object for client to use,
avoids some foot-guns in client-side encryption.
Ensures easy backward compatibility, cross-language support
and efficient serialization when dealing with long-lived
storage objects.

Mainly auto-gen code from server-side PR.

Motivation: Provides helper object for client to use,
avoids some foot-guns in client-side encryption.
Ensures easy backward compatibility, cross-language support
and efficient serialization when dealing with long-lived
storage objects.
@G8XSU G8XSU requested a review from jkczyz September 21, 2023 19:55
@@ -1,6 +1,6 @@
[package]
name = "vss-client"
version = "0.1.0"
version = "0.1.1"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would generally prefer to have releases in separate PRs. Also, do we want to start a CHANGELOG to mention what was included in each release?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

releases in separate PRs.

This is just a patch release, there are no users, i don't think it makes any difference and is unnecessary.

I don't think CHANGELOG is required until we have an alpha or rc release.
Everything is part of vss-client core functionality. It is equivalent to overwriting 0.1.0, but sadly cargo doesn't allow that.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just a patch release, there are no users, i don't think it makes any difference and is unnecessary.

I don't think CHANGELOG is required until we have an alpha or rc release. Everything is part of vss-client core functionality. It is equivalent to overwriting 0.1.0, but sadly cargo doesn't allow that.

Yeah, we can have a more formal process then.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think CHANGELOG is required until we have an alpha or rc release. Everything is part of vss-client core functionality. It is equivalent to overwriting 0.1.0, but sadly cargo doesn't allow that.

SGTM

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated nit: double the in docs of GetObjectRequest (line 15).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is auto-generated code, on top of that this comment is unrelated to added change, will resolve this in next PR of server side.
lets not block this one for this.
Otherwise we keep going back-and-forth on same thing and this gets auto-generated code takes 3-4 days to merge.

/// The version of the value. Can be used by client to verify version integrity.
#[prost(int64, tag = "2")]
pub version: i64,
}
/// ErrorCodes to be used in `ErrorResponse`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: tick ErrorCode, also on lines 64, 89, 123.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it is defining ErrorCode, as it is here, we should write either "Error codes" or "Codes" without ticks, IMO.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is auto-generated code, on top of that this comment is unrelated to added change, will resolve this in next PR of server side.
lets not block this one for this.
Otherwise we keep going back-and-forth on same thing and this gets auto-generated code takes 3-4 days to merge.

@G8XSU G8XSU merged commit ad0ef0c into lightningdevkit:main Sep 22, 2023
@G8XSU G8XSU mentioned this pull request Nov 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants