Make the auction example end-to-end #6477

zliu41 · 2024-09-12T21:05:22Z

This PR expands the auction example to make it end-to-end, using mesh for off-chain code. Also removes some outdated or less relevant content.

For reviewers: it is recommend to review it by building the site locally: cd to doc/docusaurus, run nix develop, then run yarn install followed by yarn start.

If you prefer reviewing it on GH, you may want to review the files in this order:

But note that code embedding won't work.

@rober-m @jinglescode feedback welcome

jmchapman · 2024-09-13T02:33:33Z

Cool!

jinglescode · 2024-09-13T03:23:32Z

Very nice work @zliu41. Certainly wanted to add auction into smart contract lib for live demos useful for people to quickly connect wallet and try it out the contracts and transactions. I will read the markdown files and see if anything to add.

rober-m · 2024-09-13T11:41:29Z

@zliu41 I see a lot of PlutusTx and Plutus-as-platform references. Should I ignore that for this PR? Is the renaming of the docs and/or modules on the roadmap?

zliu41 · 2024-09-13T14:44:12Z

I see a lot of PlutusTx and Plutus-as-platform references.

@rober-m

PlutusTx - I'll rename all occurrences in one go later in a separate PR
This PR doesn't mention Plutus-as-platform; I'll clean up any existing references later

doc/docusaurus/docs/auction-smart-contract/end-to-end/mint.md

doc/docusaurus/docs/auction-smart-contract/on-chain-code.md

doc/docusaurus/static/code/AuctionValidator.hs

rober-m · 2024-09-13T16:35:05Z

I haven't reviewed the whole thing yet, but I found a few issues we might want to make a decision about:

Currently, the MeshJS instructions won't work because the scripts can't download the packages. To solve it, we could:
- Ask the student to create a folder with a package.json file or
- change the imports to use URLs and use Deno instead of Node. (I wouldn't use Deno in a production app, but here, it would be fine)
The "Minting the Token to be auctioned" section asks the student to use blueprints (GenMintingPolicyBlueprint.hs), but that's not in the repo. Should we change the instructions or the repo?

Co-authored-by: Robertino <[email protected]>

zliu41

Ask the student to create a folder with a package.json file

Added the steps to create package.json in generating-keys.md.

The "Minting the Token to be auctioned" section asks the student to use blueprints (GenMintingPolicyBlueprint.hs), but that's not in the repo.

It will work once IntersectMBO/plutus-tx-template#20 is merged.

doc/docusaurus/docs/auction-smart-contract/end-to-end/mint.md

doc/docusaurus/docs/auction-smart-contract/on-chain-code.md

Added `AuctionMintingPolicy.hs`, `GenAuctionValidatorBlueprint.hs` and `app/GenMintingPolicyBlueprint.hs`, to make it compatible with IntersectMBO/plutus#6477. --------- Co-authored-by: zeme <[email protected]>

doc/docusaurus/docs/auction-smart-contract/end-to-end/mint.md

doc/docusaurus/docs/auction-smart-contract/end-to-end/placing-bids.md

doc/docusaurus/static/code/bid.mjs

doc/docusaurus/static/code/mint-token-for-auction.mjs

doc/docusaurus/static/code/send-lovelace.mjs

Co-authored-by: Robertino <[email protected]>

…bids.md Co-authored-by: Robertino <[email protected]>

Co-authored-by: Robertino <[email protected]>

zeme-wana · 2024-09-17T09:38:47Z

Rebase off master to fix the failing PlutusTx Template check

Unisay · 2024-09-17T09:44:44Z

JFYI: I am in the process of reviewing this PR...

doc/docusaurus/docs/auction-smart-contract/end-to-end/generating-keys.md

…ng-keys.md Co-authored-by: Robertino <[email protected]>

doc/docusaurus/docs/auction-smart-contract/end-to-end/generating-keys.md

Unisay · 2024-09-18T08:44:36Z

doc/docusaurus/docs/auction-smart-contract/end-to-end/getting-funds.md

+node send-lovelace.mjs bidder1
+node send-lovelace.mjs bidder2


Suggested change

node send-lovelace.mjs bidder1

node send-lovelace.mjs bidder2

pushd off-chain

node send-lovelace.mjs bidder1

node send-lovelace.mjs bidder2

popd

previous commands assume that current dir is one level above the off-chain dir, but this command fails when executed not from the off-chain dir.

previous commands assume that current dir is one level above the off-chain dir

Are you referring to "To do so, create a file named off-chain/send-lovelace.mjs"? I can change it to "To do so, create a file named send-lovelace.mjs in off-chain". The previous task was to generate keys, and there's no need to leave the off-chain dir.

Unisay · 2024-09-18T09:02:55Z

doc/docusaurus/docs/auction-smart-contract/end-to-end/mint.md

+
+## On-chain Minting Policy Script
+
+The full minting policy code can be found at [AuctionMintingPolicy.hs](https://github.com/IntersectMBO/plutus-tx-template/blob/main/src/AuctionMintingPolicy.hs).


I noticed that minting policy uses Plutus V2. Do we have a task to update it to the Plutus V3?

I think V2 is fine for this example, since there's no advantage (in fact there's disadvantage) to use Plutus V3. But if anyone wants to update the example to V3, you are welcome to.

Unisay · 2024-09-18T12:45:46Z

doc/docusaurus/docs/auction-smart-contract/end-to-end/mint.md

+Next, we need to compile the minting policy script and create its blueprint.
+To do so, we first need to supply a public key hash, which the minting policy will use for checking condition 1 above.
+Assuming the seller is the one minting the token, this should be the seller's public key hash.
+Open `GenMintingPolicyBlueprint.hs` in the `on-chain` directory, and replace `error "Replace with seller pkh"` with the content of `off-chain/seller.pkh`.


Is there a reason to put auction validator script and minting policy script in two different blueprint files?
I can see how two different plutus scripts (validator, policy) together constitute a one logical "contract".

To generate blueprint for the auction validator, we need to know the hash of the minting validator, and currently the best way to get the hash is from the blueprint.

…uction

Unisay · 2024-09-23T09:12:01Z

doc/docusaurus/docs/auction-smart-contract/end-to-end/getting-funds.md

@@ -9,6 +9,7 @@ We can get funds from Cardano's [testnet faucet](https://docs.cardano.org/cardan

 To request funds, enter the seller's address into the address field and click "request funds."
 This will deposit 10,000 (test) ADA into the seller's wallet.
+Make sure you select the correct network (Preview).


…uction

… be more complex? (#6513) * This seems 'too easy' but to certify things I don't think it needs to be more complex? * Er, I think this was the wrong way round * Add version select to haddock index page (#6499) * Remove plutus-ghc-stub (#6514) * Remove the Plutus Platform page (#6506) * Make the auction example end-to-end (#6477) * Mark `&&` and `||` OPAQUE (#6510) * Translation relation and decision procedure for the Float-Delay (#6482) * WIP * WIP * WIP * WIP * WIP * WIP - Most of the nFD->FD proof is done but I am now wondering if the application rules need the force in them... * Some progress on the FD->pureFD proof... Not completely sure it is going in a good direction... * Made the parameters to istranslation implicit, since they are encoded in the relation anyway * WIP * WIP * WIP - with crazy variable binding issues * Add 'forall DecEq' to 'Relation' * Roman's additions. * Workign Float-Delay translation relation and decision procedure. * Missed a definition * Now uses Purity, althought that is 'stub code' at the moment. * Now with added Purity... * Remove 'Terminating' from 'translation?' --------- Co-authored-by: effectfully <[email protected]> * WIP * Now with fake purity... * Some WIP from the other branch that is needed here. * Tidy some Agda... * Agda... --------- Co-authored-by: zeme-wana <[email protected]> Co-authored-by: Ziyang Liu <[email protected]> Co-authored-by: effectfully <[email protected]>

… be more complex? (IntersectMBO#6513) * This seems 'too easy' but to certify things I don't think it needs to be more complex? * Er, I think this was the wrong way round * Add version select to haddock index page (IntersectMBO#6499) * Remove plutus-ghc-stub (IntersectMBO#6514) * Remove the Plutus Platform page (IntersectMBO#6506) * Make the auction example end-to-end (IntersectMBO#6477) * Mark `&&` and `||` OPAQUE (IntersectMBO#6510) * Translation relation and decision procedure for the Float-Delay (IntersectMBO#6482) * WIP * WIP * WIP * WIP * WIP * WIP - Most of the nFD->FD proof is done but I am now wondering if the application rules need the force in them... * Some progress on the FD->pureFD proof... Not completely sure it is going in a good direction... * Made the parameters to istranslation implicit, since they are encoded in the relation anyway * WIP * WIP * WIP - with crazy variable binding issues * Add 'forall DecEq' to 'Relation' * Roman's additions. * Workign Float-Delay translation relation and decision procedure. * Missed a definition * Now uses Purity, althought that is 'stub code' at the moment. * Now with added Purity... * Remove 'Terminating' from 'translation?' --------- Co-authored-by: effectfully <[email protected]> * WIP * Now with fake purity... * Some WIP from the other branch that is needed here. * Tidy some Agda... * Agda... --------- Co-authored-by: zeme-wana <[email protected]> Co-authored-by: Ziyang Liu <[email protected]> Co-authored-by: effectfully <[email protected]>

Make the auction example end-to-end

03e22ae

zliu41 added the No Changelog Required Add this to skip the Changelog Check label Sep 12, 2024

zliu41 requested review from brunjlar and a team September 12, 2024 21:05

zliu41 mentioned this pull request Sep 12, 2024

Add a few modules to the template IntersectMBO/plutus-tx-template#20

Merged

zeme-wana approved these changes Sep 13, 2024

View reviewed changes