plutus-pioneer-program/README.md

Plutus Pioneer Program

Lectures

• Lecture #1

  • Welcome.
  • The (E)UTxO-model.
  • Building the example code.
  • An auction contract in the EUTxO-model.
  • A brief look at the auction code.
  • Running an example auction contract on a local Playground.
  • Homework.

• Lecture #2

  • Triggering change.
  • Low-level, untyped on-chain validation scripts.
  • High-level, typed on-chain validation scripts.

• Lecture #3

  • Script contexts.
  • Time handling.
  • Parameterized contracts.

• Lecture #4

  • Monads.
  • The EmulatorTrace-monad.
  • The Contract-monad.

• Lecture #5

  • Values.
  • Native Tokens.
  • NFT's.

• Lecture #6

  • Oracles.
  • Using the PAB.

Code Examples

• Lecture #1: English Auction
• Lecture #2: Simple validation
• Lecture #3: Script Context & Parameterized Contracts
• Lecture #4: Monad, Traces & Contracts
• Lecture #5: Native Tokens
• Lecture #6: Oracles

Exercises

• Week #1

  • Clone the The Plutus repository, check out the correct commit as specified in cabal.project.
  • Install NixOS cross-referencing the following resources.
    • https://nixos.org/download.html
    • https://docs.plutus-community.com
    • A few resources to understand the what and why regarding NixOS
      • https://nixos.org/manual/nix/stable
      • https://serokell.io/blog/what-is-nix
  • Set-up IOHK binary caches How to set up the IOHK binary caches. "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."
  • Enter a nix-shell.
  • Build the English Auction contract with cabal build (you may need to run cabal update first).
  • 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.
  • Compile.
  • Simulate various auction scenarios.

• Week #2

  • Fix and complete the code in the Homework1 module.
  • Fix and complete the code in the Homework2 module.

• Week #3

  • Fix and complete the code in the Homework1 module.
  • Fix and complete the code in the Homework2 module.

• Week #4

  • Implement function payTrace in the Homework module.
  • Handle exceptions thrown by submitTx in function payContract in the same module.

• Week #5

  • Add a deadline to the minting policy in the Homework1 module.
  • Fix the token name to the empty ByteString in the NFT contract in the Homework2 module.

• Week #6

  • Get the Oracle demo running and extend it in some way.

Some Plutus Modules

• Language.Marlowe.Semantics, contains Marlowe types and semantics.
• Plutus.Contract.StateMachine, contains types and functions for using state machines.
• Plutus.Contract.Test, provides various ways to write tests for Plutus contracts.
• Plutus.Contract.Test.ContractModel, support for property based testing of Plutus contracts.
• Plutus.Contracts.Uniswap, an implementation of Uniswap in Plutus.
• Plutus.Ledger.TimeSlot, conversions between Slot and POSIXTime.
• Plutus.PAB.Webserver.API, contains the HTTP-interface provided by the PAB.
• Plutus.Trace.Emulator, contains types and functions related to traces.
• Plutus.V1.Ledger.Ada, contains support for the Ada currency.
• Plutus.V1.Ledger.Contexts, contains the definition of the context-related types.
• Plutus.V1.Ledger.Interval, contains the definition of and helper functions for the Interval type.
• Plutus.V1.Ledger.Slot, contains the definition of the Slot type.
• Plutus.V1.Ledger.Value, contains the definition of and helper functions for the Value type.
• PlutusTx.Builtins.Data, contains the definition of the Data type.
• PlutusTx.IsData.Class, defines the IsData class.

Additional Resources

• The Plutus repository
• Learn You a Haskell for Great Good!
• Haskell & Cryptocurrencies course Mongolia