Add Wasm Stardust Client #975

cycraig · 2022-08-18T15:28:53Z

Description of change

Add a client implementation for the Stardust Wasm bindings. The client helper traits are split following the suggestion in #963 (comment). The trait names are pretty arbitrary, open to suggestions.

Supersedes #969. Previous PR used @iota/iota.js, which does not currently implement automatic input and output selection, so that was previously manually implemented in TypeScript to match the behaviour of iota.rs in #969. To avoid maintaining that complex logic, we opted to go with Wasm bindings to iota.rs ourselves.

This uses unofficial iota.rs Wasm bindings, We chose not to use the official iota.rs Node.js bindings initially since they don't work in the browser and require Rust to install.

This also requires importing several new npm packages: @iota/iota.js, and @iota/types. But we would need to import them if using iota.js or iota.rs Node.js bindings too, unless we duplicate certain functionality from them (even then @iota/types would still be required).

Added

Add StardustIdentityClient trait.
Add StardustIdentityClientExt trait.
Add "client" feature for the new traits without the iota-client dependency.
Add WasmStardustIdentityClient.
Add StardustIdentityClient TypeScript wrapper class.
Add examples-stardust Wasm examples.

Changed

Move most StardustClientExt methods to the StardustIdentityClient traits.
Replace private extract_documents_from_block function with public StardustDocument::unpack_from_block.
Change StardustClientExt to error on network mismatch.
Change delete_did_output to promote the block until included.
Change delete_did_output to transfer native tokens too.
Change StardustDocument to allow empty state metadata.
Change state metadata fieldnames to use doc and meta, instead of document, metadata.

Links to any relevant issues

Resolves #950.

Type of change

Bug fix (a non-breaking change which fixes an issue)
Enhancement (a non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation Fix

How the change has been tested

Run the new Wasm Stardust examples:

npm run build
npm run test:stardust

Change checklist

I have followed the contribution guidelines for this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

Add allow_empty to StardustDocument::unpack.

Sort inputs. Add some block validation checks. Fix unlocking logic. Fix consumeAmount, remainderAmount calculations.

Remove timestamps when unpacking an empty DID Document.

…feat/wasm-shimmer-client

cycraig · 2022-08-18T16:09:39Z

Rust Stardust tests are failing due to the runner being banned from the faucet API.

https://github.com/iotaledger/identity.rs/runs/7902204219?check_suite_focus=true

bindings/wasm/lib/stardust_identity_client.ts

bindings/wasm/examples-stardust/src/ex0_create_did.ts

bindings/wasm/examples-stardust/src/ex1_update_did.ts

bindings/wasm/build/web.js

Co-authored-by: Eike Haß <eike-hass@web.de>

…ger/identity.rs into feat/wasm-shimmer-client

PhilippGackstatter

Looks good to me. Thanks for the massive effort here!

PhilippGackstatter · 2022-08-19T07:22:46Z

identity_stardust/src/client/identity_client.rs

+/// This trait is not intended to be implemented directly, a blanket implementation is
+/// provided for [`StardustIdentityClient`] implementers.
+#[async_trait::async_trait(? Send)]
+pub trait StardustIdentityClientExt: StardustIdentityClient {


When we do the renaming from stardust to iota, I assume we'll get rid of the "Stardust" prefix.

So just IdentityClientExt or ClientIdentityExt would be good for this trait.

Since the other part of the trait, what is currently called StardustClientExt is used for modifying the ledger (publishing, deleting) we could call it ClientIdentityWriteExt or something to clarify its modifying nature. Just throwing ideas around.

~~It should just match whatever the name is on the Rust side,~~ likely IotaClientExt/IotaIdentityClient, to avoid ambiguity with other DID methods in the future.

Probably just:

IotaClient for the get_network_hrp, get_alias_output, get_rent_structure methods (since iota-client uses Client).

IotaIdentityClient for new_did_output etc.

IotaIdentityClientExt/IotaIdentityPublish for publish_did_output, delete_did_output? I wouldn't use Write since it doesn't match the terminology.

That makes sense 👍

PhilippGackstatter · 2022-08-19T08:18:37Z

identity_stardust/examples/ex3_deactivate_did.rs

+  // Deactivation may only be performed by the state controller of the Alias Output.
+  let deactivated_output: AliasOutput = client.deactivate_did_output(&did).await?;
+
+  // Optional: reduce and reclaim the storage deposit, sending the tokens to the state controller.


How does that work? If the tokens no longer needed for the storage deposit are not enough to cover the deposit for a new basic output, that would fail, right?

? iota.rs will try choose another Basic Output to combine it with to avoid dust outputs. I wrote logic to that effect in the previous PR too. Yes it can fail otherwise, but it's not generally the concern of the library, hence why we don't do it automatically.

PhilippGackstatter · 2022-08-19T09:29:37Z

bindings/wasm/rustfmt.toml

-comment_width = 120
-format_code_in_doc_comments = true
-license_template_path = ".license_template"
-max_width = 120
-normalize_comments = false
-normalize_doc_attributes = false
-tab_spaces = 2
-wrap_comments = true


Why was that removed?

It kept giving problems due to being a symlink and rustfmt uses the config file in parent directories automatically, so this was an unnecessary copy anyway.

PhilippGackstatter · 2022-08-19T09:32:41Z

bindings/wasm/package.json

    "node-fetch": "^2.6.7"
  },
+  "peerDependencies": {
+    "@cycraig/iota-client-wasm": "^0.5.0-alpha.1",


Should this be moved to the @iota namespace or will that happen if and when the iota.rs team takes over those bindings?

When or if iota.rs allows me to merge in the bindings. I just put it under my account to avoid polluting the global namespace for now, it can be changed to whatever.

bindings/wasm/examples-stardust/src/ex3_deactivate_did.ts

bindings/wasm/examples-stardust/src/ex4_delete_did.ts

cycraig added 25 commits August 3, 2022 13:07

Split StardustClientExt into StardustIdentityClient/Base traits

842e32c

Add network checks to StardustClientExt

ebad080

Add context to example errors, increase faucet timeout

7b36056

Fix compilation without iota-client feature, relax Send restriction

8f9a32d

Re-export bee_block as the block module

3874b0e

Add IStardustIdentityClient, IStardustIdentityClientExt interfaces

d373ea7

[WIP] TypeScript client extension attempt

bab7d7a

Remove expect, make error messages more verbose

013689b

Fix AliasOutput serialization, update example

0dbb582

Move deactivate_did_output to StardustIdentityClient

a395a70

Add allow_empty to StardustDocument::unpack.

Update Wasm bindings

824cb33

Implement publishDidOutput for Wasm bindings

c031d7f

Clean Wasm ex0_create_did example

f80db4e

Implement deleteDidOutput for Wasm bindings

23f5280

Add ex1_update_did Wasm example, add examples-stardust directory

8b6e326

Add ex2_resolve_did example for Wasm

7f09eb2

Add metadata deactivated field Wasm bindings

5de2d5a

Fix input commitment hash calculation for multiple inputs

20157a9

Sort inputs. Add some block validation checks. Fix unlocking logic. Fix consumeAmount, remainderAmount calculations.

Add ex4_delete_did Wasm example

4d0904a

Fix StateMetadataDocument serialised fieldnames

8463da2

Remove timestamps when unpacking an empty DID Document.

Fix dust outputs when reclaiming Alias Output amount

4e65b02

Update iota.js to latest version

d38a528

Start iota.rs Node.js client intergration

a152cc1

Use unofficia iota-client Wasm bindings

f68d781

Merge branch 'dev' of https://github.com/iotaledger/identity.rs into …

dd0dd4c

…feat/wasm-shimmer-client

cycraig added Wasm Related to Wasm bindings. Becomes part of the Wasm changelog Breaking change A change to the API that requires a major release. Part of "Changed" section in changelog Rust Related to the core Rust code. Becomes part of the Rust changelog. labels Aug 18, 2022

cycraig requested review from eike-hass and PhilippGackstatter August 18, 2022 15:28

cycraig requested a review from abdulmth August 18, 2022 15:28

cycraig self-assigned this Aug 18, 2022

cycraig changed the title ~~Feat/wasm shimmer client~~ Add Wasm Stardust Client Aug 18, 2022

Fix formatting

e825516

cycraig mentioned this pull request Aug 18, 2022

Add Wasm iota.js Stardust Client #969

Closed

10 tasks

cycraig added this to the v0.7 Features milestone Aug 18, 2022

cycraig commented Aug 19, 2022

View reviewed changes

bindings/wasm/lib/stardust_identity_client.ts Outdated Show resolved Hide resolved

eike-hass reviewed Aug 19, 2022

View reviewed changes

bindings/wasm/examples-stardust/src/ex0_create_did.ts Outdated Show resolved Hide resolved

eike-hass reviewed Aug 19, 2022

View reviewed changes

bindings/wasm/examples-stardust/src/ex1_update_did.ts Outdated Show resolved Hide resolved

eike-hass reviewed Aug 19, 2022

View reviewed changes

bindings/wasm/build/web.js Outdated Show resolved Hide resolved

eike-hass and others added 6 commits August 19, 2022 16:37

Merge branch 'dev' into feat/wasm-shimmer-client

cdd82ae

Add StardustDocument::unpack_from_block, simplify TypeScript

7859065

Apply suggestions from code review

5c2bfda

Co-authored-by: Eike Haß <eike-hass@web.de>

Merge branch 'feat/wasm-shimmer-client' of https://github.com/iotaled…

8504582

…ger/identity.rs into feat/wasm-shimmer-client

Wait for faucet in Wasm Stardust examples

b66132f

Change TypeScript import to import type

7a4207b

PhilippGackstatter approved these changes Aug 22, 2022

View reviewed changes

cycraig removed the request for review from abdulmth August 22, 2022 08:12

Improve Wasm TypeScript build (#976)

250390a

eike-hass approved these changes Aug 22, 2022

View reviewed changes

cycraig added 2 commits August 22, 2022 11:14

Remove sleep in Wasm deactivate example

a85895f

Revert change to txm README.md example

0a83839

cycraig merged commit 0d5ed61 into dev Aug 22, 2022

cycraig deleted the feat/wasm-shimmer-client branch August 22, 2022 10:32

cycraig mentioned this pull request Aug 22, 2022

[Task] Implement Client for Stardust #950

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Wasm Stardust Client #975

Add Wasm Stardust Client #975

cycraig commented Aug 18, 2022 •

edited

Loading

cycraig commented Aug 18, 2022

PhilippGackstatter left a comment •

edited

Loading

PhilippGackstatter Aug 19, 2022

cycraig Aug 22, 2022 •

edited

Loading

PhilippGackstatter Aug 22, 2022

PhilippGackstatter Aug 19, 2022

cycraig Aug 22, 2022

PhilippGackstatter Aug 19, 2022

cycraig Aug 22, 2022 •

edited

Loading

PhilippGackstatter Aug 19, 2022

cycraig Aug 22, 2022

Add Wasm Stardust Client #975

Add Wasm Stardust Client #975

Conversation

cycraig commented Aug 18, 2022 • edited Loading

Description of change

Added

Changed

Links to any relevant issues

Type of change

How the change has been tested

Change checklist

cycraig commented Aug 18, 2022

PhilippGackstatter left a comment • edited Loading

Choose a reason for hiding this comment

PhilippGackstatter Aug 19, 2022

Choose a reason for hiding this comment

cycraig Aug 22, 2022 • edited Loading

Choose a reason for hiding this comment

PhilippGackstatter Aug 22, 2022

Choose a reason for hiding this comment

PhilippGackstatter Aug 19, 2022

Choose a reason for hiding this comment

cycraig Aug 22, 2022

Choose a reason for hiding this comment

PhilippGackstatter Aug 19, 2022

Choose a reason for hiding this comment

cycraig Aug 22, 2022 • edited Loading

Choose a reason for hiding this comment

PhilippGackstatter Aug 19, 2022

Choose a reason for hiding this comment

cycraig Aug 22, 2022

Choose a reason for hiding this comment

cycraig commented Aug 18, 2022 •

edited

Loading

PhilippGackstatter left a comment •

edited

Loading

cycraig Aug 22, 2022 •

edited

Loading

cycraig Aug 22, 2022 •

edited

Loading