0xPolygonMiden / miden-client

Client library that facilitates interaction with the Miden rollup
MIT License
27 stars 23 forks source link

Create an integration test for public SWAP notes #311

Closed Dominik1999 closed 1 month ago

Dominik1999 commented 2 months ago

Feature description

I want to see an integration test that maps the SWAP process end-to-end. A first client should create a SWAP note, and a second client should consume the note and create a second note containing the requested ASSET for the first client to consume.

The notes used in this test should be public. A first client should create a SWAP note, and a second client should consume the note and create a second note containing the requested ASSET for the first client to consume.

Why is this feature needed?

I want to show this test to our Pioneers as a tutorial on creating those transactions using the Miden client. Especially how to create the expected output notes.

Following a good integration test with extensive comments might be better than writing the docs for this use case.

bobbinth commented 2 months ago

Doing this would be a bit easier once we have https://github.com/0xPolygonMiden/miden-base/issues/412 and https://github.com/0xPolygonMiden/miden-base/issues/640 implemented.

mFragaBA commented 2 months ago

We could still do somewhat of a PoC since we can store notes without the metadata on the client. The only thing would be the note tag, but I think we can again in the contextof a PoC set it to 0 just to test the whole flow (minus discovery via tags). The public API on our side should probably stay the same so it's still useful for consumers of the client and it would also serve as a test for the swap functionality

What do you think?

bobbinth commented 2 months ago

Both of these should be done once https://github.com/0xPolygonMiden/miden-base/pull/665 is merged. So, we should be able to include these into the next release.

mFragaBA commented 1 month ago

closing as #324 got merged