Add types spec #2
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
also cleanup some folders
Add a paragraph introducting the Client API to give context and link to the RPC spec that the Client needs to implement
Provide information regarding the need to serialize and deserialize some types in the client before and after interaction with the server
Provide information about error handling by the Client
chabroA
force-pushed
the
support/LIVE-3593-create-types-spec
branch
from
ec8e9f4
to
2d4eabd
Compare
Justkant
approved these changes
Sep 7, 2022
sprohaszka-ledger
approved these changes
Sep 9, 2022
Good idea 👍 |
|
Added note regarding raw types ed4ba34 For now I limited it to JSON primitive types (Strings, Numbers, Booleans, and Null) but there might not be any technical limitation to use structured types (Objects and Arrays). With that said, if we can use Objects, then raw types might not be useful since everything can be represented by an Object 🤔 |
|
recreated here #7 |
Wozacosta
added a commit
that referenced
this pull request
Jan 11, 2024
Wozacosta
added a commit
that referenced
this pull request
Jan 19, 2024
signandbroadcast handles tokencurrency test account receive remove local manifest test
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add specification for types based on https://github.com/LedgerHQ/live-app-sdk/blob/main/docs/reference/modules.md
It looks like some types are not related to the specification (are more implementation specific), like
EcdsaSignature,ExchangeDeviceTxIdorExchangePayload.Also, some types are actually not used anywhere today (like
ApplicationDetailsorDeviceInfo).Some types are also Ledger Live specific like
RawSignedTransaction.It feels like all these types should be either removed from the spec or reworked (like
RawSignedTransactionthat seems quite useless as a type since the object it represents is juste passed through the Client SDK fromsignTransactiontobroadcastSignedTransaction.Same general feeling regarding types, some types are JS specific (like
BigNumberorBuffer). We should represent them in a language agnostic way (how? what type should we use?)What do you think? What's your opinion? How should we go about that?