Wrap SOME of Radix Engine Toolkit types, first of MANY PRs. #3

CyonAlexRDX · 2024-02-14T10:30:12Z

LOC Delta

Fear not the LOC delta, it is the huge generated Swift file mostly.

Introduction

This PR primary solves the so far unsolved challenge of how to implement and vendor Decimal, renamed to Decimal192 as to not collide with Swift Foundations Decimal. 192 comes from the fact that it is powered by a 192 bit integer inside of Scrypto repo (radix_engine_common crate).

I've solved it by ensuring that Decimal192 is a struct/data class in Swift and Kotlin, and NOT a typealias, which HAS a __inner: String which is named like that so to scare Swift/Kotlin devs to not touch it, while keeping it as a thing which has a thing which has a ScryptoDecimal192. This actives the best of two worlds:

Strong typing in Swift and Kotlin
String typing in Rust.

The goal of this PR is to progress the wrapping of RET inside of Sargon, fulfilling the defined "API" by PR: radixdlt/babylon-wallet-ios#1032

This PR also implements, and stubs out some other RET types, and introduces fundamental building blocks such as Secp256k1Signature - UniFFI exposed! and Ed25519Signature also UniFFI exposed, needed by SignedIntent and other RET types.

This PR also contains improvements to the iOS example app

Changes

Changes in Rust land

Decimal renamed to Decimal192 and made production ready. Missing some formatting methods
Create Hex64, Hex33, Hex64 bytes types, by changing Hex32Bytes to a macro, this allows typesafe, non generic value (due to restrictions in UniFFI) types for bytes, which we can use in Signature types
Secp256k1Signature and Ed25519Signature types
Nonce
Epoch
Dummy placeholder RET types
Wallet now vendors mnemonic_with_passphrase_of_device_factor_source_by_id which is used by Example wallet to load the mnemonic

Changes in Sargon Swift SPM Package

Swift-ify some types in SPM target sargon mostly wrapping freestanding global functions in methods by use of extensions.
Make Decimal192 conform to SignedNumeric swift protocol

Changes in Example wallet iOS

Make create account a flow, user can select name and appearance ID.
Add screen to show mnemonic

Future

Many more PRs to come, all focused on vendoring RET through Sargon..

codecov · 2024-02-14T10:36:54Z

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Comparison is base (3e9d604) 99.13% compared to head (edd3748) 99.06%.

Files	Patch %	Lines
src/core/types/hex_32bytes.rs	97.59%	2 Missing ⚠️
src/core/types/decimal192.rs	99.27%	1 Missing ⚠️
src/core/types/epoch.rs	75.00%	1 Missing ⚠️
src/core/types/nonce.rs	83.33%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop       #3      +/-   ##
===========================================
- Coverage    99.13%   99.06%   -0.08%     
===========================================
  Files          120      128       +8     
  Lines         2663     2891     +228     
===========================================
+ Hits          2640     2864     +224     
- Misses          23       27       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…mple app

…requires more fixed size BagOfBytes, introducing: Hex64Bytes, Hex65Bytes, Hex33Bytes, generated with macro.

…Key, and same for Secp256k1.

…ove sccache ref in direnv, it did not speed up things.

… in Package.swift, also required for when making releses.

CyonAlexRDX · 2024-02-19T13:57:41Z

src/sargon.udl

@@ -10,4 +10,7 @@ typedef string Timestamp;
 [Custom]
 typedef sequence<i8> BagOfBytes;

+[Custom]
+typedef string InnerDecimal;


Here is the trick, we vendor Decimal192 as a struct with one single stored property (field) __inner: InnerDecimal which in the land of Swift and Kotlin will be __inner: String. It is given that name to hide it as much as possible. It is, in fact, NOT a String but the rust type InnerDecimal which in Rust land holds a ScryptoDecimal192.

This is the best compromise, it allwos for usage of a real decimal in Rust land - the ScryptoDecimal192 - and it allows for its OWN type in Swift/Kotlin, and NOT a silly error prone typealias Decimal192 = String.

CyonAlexRDX · 2024-02-19T13:57:58Z

src/core/types/signatures/signature_with_public_key.rs

To Be Written in coming PR

CyonAlexRDX · 2024-02-19T14:00:50Z

src/wrapped_radix_engine_toolkit/manifest_summary.rs

stubbing out the API as per radixdlt/babylon-wallet-ios#1032

CyonAlexRDX · 2024-02-19T14:00:56Z

src/wrapped_radix_engine_toolkit/notarized_transaction.rs

stubbing out the API as per radixdlt/babylon-wallet-ios#1032

CyonAlexRDX · 2024-02-19T14:01:11Z

src/wrapped_radix_engine_toolkit/transaction_intent.rs

stubbing out the API as per radixdlt/babylon-wallet-ios#1032

CyonAlexRDX · 2024-02-19T14:02:07Z

src/wrapped_radix_engine_toolkit/transaction_manifest.rs

stubbing out the API as per radixdlt/babylon-wallet-ios#1032

blobs() method will probably be turned into just field usage.

CyonAlexRDX · 2024-02-19T14:03:03Z

src/core/types/decimal192.rs

Almost ALL methods inits of Decimal as per radixdlt/babylon-wallet-ios#1032 has been implemented, formatting remains.

CyonAlexRDX · 2024-02-19T14:05:18Z

.pre-commit-config.yaml

@micbakos-rdx please re-install the precommit hook

GhenadieVP

Awesome, looks promising!
Waiting to see how stuff around TransactionManifest and building will look like 🚀.

GhenadieVP · 2024-02-19T15:58:47Z

src/core/types/signatures/signature_with_public_key.rs

+// use radix_engine_common::crypto::Ed25519Signature as ScryptoEd25519Signature;
+// use radix_engine_common::crypto::Secp256k1Signature as ScryptoSecp256k1Signature;
+
+// /// Represents any natively supported signature, including public key.


To implement later?

GhenadieVP · 2024-02-19T16:01:13Z

src/wrapped_radix_engine_toolkit/transaction_header.rs

Third party deposits more tests

Sajjon added 4 commits February 13, 2024 20:50

Arithmetic operations for Decimal

eedf6a2

Decimal compare methods and UniFFI exported funtions

d4a019a

add Swift bindgen tests for decimal

ed6e18e

Merge branch 'develop' into wrap_radix_engine_toolkit

2e95bfb

Sajjon and others added 21 commits February 17, 2024 09:45

Sargon: Add method to read Mnemonic, UniFFI exported, Improve iOS exa…

30f134d

…mple app

Merge

2c447c5

WIP Decimal192 + Swifitfied

944795e

Make Decimal192 conform to Comparable

a9b96d0

Add clamped

5ec79b6

Decimal rounding

ff8a4a4

rename file decimal -> decimal192.rs, add from f32.

ac0e057

Add from_formatted_string

3dc5907

Swiftify Decimal192 from formatted string

b2c90d9

Add tests

47f6da9

more tests

7592b04

Start stubbing out Signatures and other types required by RET, which …

9437497

…requires more fixed size BagOfBytes, introducing: Hex64Bytes, Hex65Bytes, Hex33Bytes, generated with macro.

Declare Ed25519Signature and use it with Ed25519PrivateKey and Public…

5f5cc20

…Key, and same for Secp256k1.

drop Ord/PartialOrd for types where it did not really make sense. Rem…

fe86e8c

…ove sccache ref in direnv, it did not speed up things.

Add HasPlaceholder conformance to Ed25519PublicKey

9aad4ff

Add HasPlaceholder conformance to Secp256k1Signature

b31d4fa

tests of Ed25519Signature and Secp256k1Signature

1731692

Unit tests for Signature

3d286fc

Merge branch 'develop' into wrap_radix_engine_toolkit

6a7efd4

Add step to precommit ensuring that local development is set to false…

95931b9

… in Package.swift, also required for when making releses.

fail fast in precommit

32e15fb

CyonAlexRDX marked this pull request as ready for review February 19, 2024 13:47

CyonAlexRDX requested review from micbakos-rdx and GhenadieVP February 19, 2024 13:47

CyonAlexRDX changed the title ~~Wrap radix engine toolkit~~ Wrap SOME of Radix Engine Toolkit types, first of MANY PRs. Feb 19, 2024

CyonAlexRDX commented Feb 19, 2024

View reviewed changes

src/core/types/signatures/signature_with_public_key.rs Outdated

Copy link

Contributor Author

CyonAlexRDX Feb 19, 2024

Choose a reason for hiding this comment

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

To Be Written in coming PR

CyonAlexRDX commented Feb 19, 2024

View reviewed changes

.pre-commit-config.yaml Outdated

Copy link

Contributor Author

CyonAlexRDX Feb 19, 2024

Choose a reason for hiding this comment

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

@micbakos-rdx please re-install the precommit hook

build, here is the updated Swift bindgen

edd3748

GhenadieVP approved these changes Feb 19, 2024

View reviewed changes

CyonAlexRDX merged commit 73af6c9 into develop Feb 19, 2024
10 of 12 checks passed

CyonAlexRDX deleted the wrap_radix_engine_toolkit branch February 19, 2024 16:45

CyonAlexRDX pushed a commit that referenced this pull request Apr 1, 2024

Merge pull request #3 from Sajjon/third_party_deposits_more_tests

d7fac1a

Third party deposits more tests

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wrap SOME of Radix Engine Toolkit types, first of MANY PRs. #3

Wrap SOME of Radix Engine Toolkit types, first of MANY PRs. #3

CyonAlexRDX commented Feb 14, 2024 •

edited

Loading

codecov bot commented Feb 14, 2024 •

edited

Loading

CyonAlexRDX Feb 19, 2024

CyonAlexRDX Feb 19, 2024

CyonAlexRDX Feb 19, 2024

CyonAlexRDX Feb 19, 2024

CyonAlexRDX Feb 19, 2024

CyonAlexRDX Feb 19, 2024

CyonAlexRDX Feb 19, 2024

CyonAlexRDX Feb 19, 2024

GhenadieVP left a comment

GhenadieVP Feb 19, 2024

GhenadieVP Feb 19, 2024

Wrap SOME of Radix Engine Toolkit types, first of MANY PRs. #3

Wrap SOME of Radix Engine Toolkit types, first of MANY PRs. #3

Conversation

CyonAlexRDX commented Feb 14, 2024 • edited Loading

LOC Delta

Introduction

Changes

Changes in Rust land

Changes in Sargon Swift SPM Package

Changes in Example wallet iOS

Future

codecov bot commented Feb 14, 2024 • edited Loading

Codecov Report

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

GhenadieVP left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CyonAlexRDX commented Feb 14, 2024 •

edited

Loading

codecov bot commented Feb 14, 2024 •

edited

Loading