plutus-pioneer-program/README.md

136 lines
5.6 KiB
Markdown
Raw Normal View History

2021-04-08 12:07:47 +02:00
# Plutus Pioneer Program
## Lectures
- [Lecture #1](https://youtu.be/IEn6jUo-0vU)
- Welcome
- The (E)UTxO-model
- Running an example auction contract on a local Playground
- Homework
2021-04-13 12:48:07 +02:00
- [Lecture #2](https://youtu.be/E5KRk5y9KjQ)
- Triggering change.
- Low-level, untyped on-chain validation scripts.
- High-level, typed on-chain validation scripts.
2021-04-20 09:09:21 +02:00
- [Lecture #3](https://youtu.be/Lk1eIVm_ZTQ)
- Script context.
- Time handling.
- Parameterized contracts.
2021-04-27 09:14:58 +02:00
- [Lecture #4](https://youtu.be/6Reuh0xZDjY)
- Monads
- The `EmulatorTrace` monad.
- The `Contract` monad.
2021-05-05 21:46:44 +02:00
- [Lecture #5](https://youtu.be/6VbhY162GQA)
- Values.
- Native tokens & minting policies.
- NFT's.
2021-05-12 19:40:33 +02:00
- [Lecture #6](https://youtu.be/wY7R-PJn66g)
- Oracles.
- Using the PAB.
2021-04-08 12:07:47 +02:00
## Code Examples
- Lecture #1: [English Auction](code/week01)
2021-04-13 16:44:22 +02:00
- Lecture #2: [Simple Validation](code/week02)
2021-04-20 09:09:21 +02:00
- Lecture #3: [Validation Context & Parameterized Contracts](code/week03)
2021-04-27 09:14:58 +02:00
- Lecture #4: [Monads, `EmulatorTrace` & `Contract`](code/week04)
2021-05-05 21:46:44 +02:00
- Lecture #5: [Minting Policies](code/week05)
2021-05-12 19:40:33 +02:00
- Lecture #6: [Oracles](code/week06)
2021-04-08 12:07:47 +02:00
2021-04-08 12:15:17 +02:00
## Exercises
- Week #1
- Build the [English Auction](code/week01) contract with `cabal build` (you may need to run `cabal update` first).
2021-04-08 12:15:17 +02:00
- Clone the [The Plutus repository](https://github.com/input-output-hk/plutus), check out the correct commit
as specified in [cabal.project](code/week01/cabal.project).
2021-04-09 09:36:15 +02:00
- Set-up IOHK binary caches [How to set up the IOHK binary caches](https://github.com/input-output-hk/plutus#iohk-binary-cache). "If you do not do this, you will end up building GHC, which takes several hours. If you find yourself building GHC, STOP and fix the cache."
2021-04-08 12:15:17 +02:00
- Enter a `nix-shell`.
- Go to the `plutus-playground-client` folder.
- Start the Playground server with `plutus-playground-server`.
- Start the Playground client (in another `nix-shell`) with `npm run start`.
- Copy-paste the auction contract into the Playground editor - don't forget to remove the module header!
- Compile.
- Simulate various auction scenarios.
2021-04-13 16:44:22 +02:00
- Week #2
- Fix and complete the code in the [Homework1](code/week02/src/Week02/Homework1.hs) module.
- Fix and complete the code in the [Homework2](code/week02/src/Week02/Homework2.hs) module.
2021-04-20 09:09:21 +02:00
- Week #3
2021-04-20 11:35:50 +02:00
- Fix and complete the code in the [Homework1](code/week03/src/Week03/Homework1.hs) module.
- Fix and complete the code in the [Homework2](code/week03/src/Week03/Homework2.hs) module.
2021-04-20 09:09:21 +02:00
2021-04-27 09:14:58 +02:00
- Week #4
- Write an appropriate `EmulatorTrace` that uses the `payContract` contract in the [Homework](code/week04/src/Week04/Homework.hs) module.
- Catch errors in the `payContract` contract in the same module.
2021-04-20 09:09:21 +02:00
2021-05-05 21:46:44 +02:00
- Week #5
- Add a deadline to the minting policy in the [Homework1](code/week05/src/Week05/Homework1.hs) module.
- Fix the token name to the empty `ByteString` in the NFT contract in the [Homework2](code/week05/src/Week05/Homework2.hs) module.
2021-05-12 19:40:33 +02:00
- Week #6
- Get the Oracle demo running and extend it in some way.
2021-04-14 16:42:16 +02:00
## Solutions
- Week #2
- [`Homework1`](code/week02/src/Week02/Solution1.hs)
- [`Homework2`](code/week02/src/Week02/Solution2.hs)
2021-04-20 11:36:21 +02:00
- Week #3
- [`Homework1`](code/week03/src/Week03/Solution1.hs)
- [`Homework2`](code/week03/src/Week03/Solution2.hs)
2021-05-05 21:46:44 +02:00
- Week #4
- [`Homework`](code/week04/src/Week04/Solution.hs)
2021-05-12 19:40:33 +02:00
- Week #5
- [`Homework1`](code/week05/src/Week05/Solution1.hs)
- [`Homework2`](code/week05/src/Week05/Solution2.hs)
2021-04-12 11:29:45 +02:00
## Some Plutus Modules
2021-05-12 19:40:33 +02:00
- [`Plutus.PAB.Webserver.API`](https://github.com/input-output-hk/plutus/blob/master/plutus-pab/src/Plutus/PAB/Webserver/API.hs), contains the HTTP-interface provided by the PAB.
2021-04-27 09:14:58 +02:00
- [`Plutus.Trace.Emulator`](https://github.com/input-output-hk/plutus/blob/master/plutus-contract/src/Plutus/Trace/Emulator.hs), contains types and functions related to traces.
2021-05-05 21:46:44 +02:00
- [`Plutus.V1.Ledger.Ada`](https://github.com/input-output-hk/plutus/blob/master/plutus-ledger-api/src/Plutus/V1/Ledger/Ada.hs), contains support for the Ada currency.
2021-04-18 22:49:27 +02:00
- [`Plutus.V1.Ledger.Contexts`](https://github.com/input-output-hk/plutus/blob/master/plutus-ledger-api/src/Plutus/V1/Ledger/Contexts.hs), contains the definition of the context-related types.
- [`Plutus.V1.Ledger.Interval`](https://github.com/input-output-hk/plutus/blob/master/plutus-ledger-api/src/Plutus/V1/Ledger/Interval.hs), contains the definition of and helper functions for the `Interval` type.
- [`Plutus.V1.Ledger.Slot`](https://github.com/input-output-hk/plutus/blob/master/plutus-ledger-api/src/Plutus/V1/Ledger/Slot.hs), contains the definition of the `Slot` type.
2021-05-05 21:46:44 +02:00
- [`Plutus.V1.Ledger.Value`](https://github.com/input-output-hk/plutus/blob/master/plutus-ledger-api/src/Plutus/V1/Ledger/Value.hs), contains the definition of and helper functions for the `Value` type.
2021-04-12 11:29:45 +02:00
- [`PlutusTx.Data`](https://github.com/input-output-hk/plutus/blob/master/plutus-tx/src/PlutusTx/Data.hs), contains the definition of the `Data` type.
2021-04-12 22:59:51 +02:00
- [`PlutusTx.IsData.Class`](https://github.com/input-output-hk/plutus/blob/master/plutus-tx/src/PlutusTx/IsData/Class.hs), defines the `IsData` class.
2021-04-12 11:29:45 +02:00
2021-04-22 13:35:44 +02:00
## Plutus community playground
- [Week 1 Community Playground(Legacy)](https://playground-week1.plutus-community.com/)
- [Week 2 Community Playground(Legacy)](https://playground-week2.plutus-community.com/)
2021-05-02 20:13:43 +02:00
- [Week 3 Community Playground(Current)](https://playground-week3.plutus-community.com/)
- [Week 4 Community Playground(Current)](https://playground.plutus-community.com/)
2021-04-08 12:07:47 +02:00
## Additional Resources
2021-04-08 12:15:17 +02:00
- [The Plutus repository](https://github.com/input-output-hk/plutus)
- [Learn You a Haskell for Great Good!](http://learnyouahaskell.com/)
2021-04-08 12:07:47 +02:00
- [Haskell & Cryptocurrencies course Mongolia](https://www.youtube.com/playlist?list=PLJ3w5xyG4JWmBVIigNBytJhvSSfZZzfTm)