Light SDK #2220

adrianbrink · 2023-11-28T10:06:07Z

Describe your changes

Implements a first version of a simpler, more user-friendly SDK.

Indicate on which release or other PRs this topic is based on

Commit 74d412e of base (v0.28.1)

Checklist before merging to `draft`

I have added a changelog
Git history is in acceptable state

adrianbrink · 2023-11-28T15:41:59Z

light_sdk/src/lib.rs

+pub const TX_REVEAL_PK_HASH: [u8; 32] = [0x8d, 0x4e, 0x20, 0x08, 0x30, 0xa9, 0xf6, 0x03, 0xd6, 0x47, 0x79, 0x9f, 0xaf, 0xdb, 0xf1, 0x94, 0x6e, 0x07, 0xa0, 0x38, 0xa6, 0x7c, 0xfa, 0x09, 0xd4, 0xee, 0xb3, 0x1c, 0x80, 0xc7, 0x74, 0xce];
+
+/// Takes any kind of inner tx and gives me back my sign bytes
+pub fn get_inner_sign_bytes(mut tx: Tx) -> Hash {


These should be immutable functions on a specific RevealPk struct. Ie. this signature should be repeated for every type of transaction.

Also this function should be immutable.

adrianbrink · 2023-12-06T09:05:22Z

light_sdk/src/tx_builders/mod.rs

+
+pub mod pos;
+
+pub(in crate::tx_builders) fn build_tx(


no generics - everything should be passed in as strings

This function is not exposed to the SDK user

adrianbrink · 2023-12-06T09:05:48Z

light_sdk/src/tx_builders/mod.rs

+}
+
+pub(in crate::tx_builders) fn attach_raw_signatures(
+    mut tx: Tx,


no mutability - we should consume the tx object and return a new one

That's what I'm doing here but I need the object to be mutable in the scope of the function

adrianbrink · 2023-12-06T09:06:40Z

light_sdk/src/tx_builders/pos.rs

+    /// Generate the signature(s) for the given transaction and signers
+    pub fn generate_signatures(
+        mut self,
+        secret_keys: &[common::SecretKey],


the library doesn't take secret keys.

it should expose sign_bytes() and then the caller figures out how to sign it

adrianbrink · 2023-12-06T09:07:08Z

light_sdk/src/tx_builders/pos.rs

+    }
+
+    /// Generate the signature(s) for the given transaction and signers
+    pub fn generate_signatures(


likewise - this kind of function shouldn't exist in the public api

adrianbrink · 2023-12-20T12:19:04Z

light_sdk/src/reading/mod.rs

+    /// Lookup the full response accompanying the specified transaction event
+    pub fn query_tx_response(
+        tendermint_addr: &str,
+        tx_query: TxEventQuery<'_>,


This is essentially a hash, right? Can this type be instantiated by the caller?

yeah, I changed this to take a &str. It means you can only query applied txs and not accepted, but I think that is totally fine.

adrianbrink · 2023-12-20T12:20:20Z

light_sdk/src/reading/mod.rs

+    }
+
+    /// Query a validator's unbonds for a given epoch
+    pub fn query_and_print_unbonds(


let's not have print options in the api. if a caller wants to print something, they can do it in their own code.

adrianbrink · 2023-12-20T12:21:09Z

light_sdk/src/reading/mod.rs

@@ -0,0 +1,679 @@
+use std::str::FromStr;


Overall I like the api.

It's probably better to split the individual submodules into their own files.

adrianbrink · 2023-12-20T12:22:36Z

light_sdk/src/writing/mod.rs

@@ -0,0 +1,3 @@
+pub mod blocking {}


This should be just 1 function - submit_tx().

* origin/adrian/light-sdk: Adds a method to serialize transactions Makes internal struct of `RevealPk` private Fixes datetime Splits light sdk queries into multiple files Renames light sdk crate and adds description Adds missing feature for tendermint-rpc in light sdk Changelog #2220 Imports `HttpClient` from `tendermint_rpc` Updates types and imports after rebase Updates docstrings and fixes clippy Some small type simplifications in the reading api [feat]: Added rpc functions to light sdk Renames `get_msg_to_sign` to `get_sign_bytes` [feat]: Small fixes and making stuff public First draft of all transactions in light sdk Refactors pos txs in separate file. Improved shared functions Created light SDK builders. First attempt at overview of light-sdk

adrianbrink commented Nov 28, 2023

View reviewed changes

adrianbrink commented Dec 6, 2023

View reviewed changes

adrianbrink commented Dec 20, 2023

View reviewed changes

light_sdk/src/writing/mod.rs

@@ -0,0 +1,3 @@

pub mod blocking {}

Copy link

Member Author

adrianbrink Dec 20, 2023

Choose a reason for hiding this comment

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

This should be just 1 function - submit_tx().

adrianbrink and others added 12 commits December 20, 2023 15:09

First attempt at overview of light-sdk

b11789c

Created light SDK builders.

91b2774

Refactors pos txs in separate file. Improved shared functions

7073172

First draft of all transactions in light sdk

4e8861a

[feat]: Small fixes and making stuff public

90fa75e

Renames get_msg_to_sign to get_sign_bytes

45e986b

[feat]: Added rpc functions to light sdk

32a2f25

Some small type simplifications in the reading api

6d8a7ea

Updates docstrings and fixes clippy

ae486a7

Updates types and imports after rebase

3b93c62

Imports HttpClient from tendermint_rpc

420e667

Changelog #2220

4a148f9

grarco force-pushed the adrian/light-sdk branch from 2561ee9 to 4a148f9 Compare December 20, 2023 15:10

Adds missing feature for tendermint-rpc in light sdk

6b0fe47

grarco marked this pull request as ready for review December 20, 2023 16:03

grarco requested a review from batconjurer December 20, 2023 16:03

grarco added 2 commits December 20, 2023 20:12

Renames light sdk crate and adds description

5c70e86

Splits light sdk queries into multiple files

596a1eb

batconjurer previously approved these changes Dec 21, 2023

View reviewed changes

grarco mentioned this pull request Dec 22, 2023

Draft #2252

Closed

Fixes datetime

b2f4bd1

grarco added 2 commits December 22, 2023 12:44

Makes internal struct of RevealPk private

7049bb5

Adds a method to serialize transactions

5a62829

grarco dismissed batconjurer’s stale review via 5a62829 December 22, 2023 14:17

brentstone merged commit c9a1f48 into main Dec 29, 2023
15 checks passed

brentstone deleted the adrian/light-sdk branch December 29, 2023 19:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Light SDK #2220

Light SDK #2220

adrianbrink commented Nov 28, 2023 •

edited by grarco

Loading

adrianbrink Nov 28, 2023

adrianbrink Dec 6, 2023

grarco Dec 6, 2023

adrianbrink Dec 6, 2023

grarco Dec 6, 2023

adrianbrink Dec 6, 2023

adrianbrink Dec 6, 2023

adrianbrink Dec 20, 2023

batconjurer Dec 21, 2023

adrianbrink Dec 20, 2023

adrianbrink Dec 20, 2023

adrianbrink Dec 20, 2023

Light SDK #2220

Light SDK #2220

Conversation

adrianbrink commented Nov 28, 2023 • edited by grarco Loading

Describe your changes

Indicate on which release or other PRs this topic is based on

Checklist before merging to draft

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

adrianbrink commented Nov 28, 2023 •

edited by grarco

Loading

Checklist before merging to `draft`