Importing Blueprints Guide

[fallen-icarus]

Since I've already written my contracts in Aiken, it would be great to have a guide on how to import the blueprints so that I can test them with the Scalus emulator. The docs only seem to cover exporting the blueprints file.

Even a hacky tutorial would be fine for now:

• How to parse and load the blueprints file to get the compiledCode
• How to apply extra params to the compiledCode
• How to use the compiledCode in the emulator

I can recreate the datums and redeemers in Scalus without relying on the blueprints file for now, but I need to get the compiledCode to start using Scalus.

[rssh]

Example is in https://github.com/scalus3/scalus/blob/master/scalus-examples/jvm/src/test/scala/scalus/examples/CompatibilityWithAikenTest.scala

i.e.

private lazy val aikenScript = {
        import upickle.default.*
        val fname = "/scalus/examples/PaymentSplitterAikenData/plutus.json"
        val inputStream = this.getClass.getResourceAsStream(fname)
        if inputStream == null then {
            println(s"Can't load script from $fname")
            throw new RuntimeException(s"Resource not found: $fname")
        }
        val obj = read[ujson.Obj](inputStream)
        val cborHex = obj("validators").arr(0)("compiledCode").str
        val program = DeBruijnedProgram.fromCborHex(cborHex).toProgram
        program
    }

[nau]

Here's the simpler version of the above that I believe covers all of your demands:

import scalus.builtin.Data.toData
import scalus.cardano.blueprint.Blueprint
import scalus.cardano.ledger.Script
import scalus.uplc.Program
import java.nio.file.{Files, Path}
import scala.concurrent.ExecutionContext.Implicits.global
// read Blueprint from plutus.json file
val blueprint = Blueprint.fromJson(Files.readString(Path.of("plutus.json")))
// get UPLC program
val program = blueprint.validators.head.compiledCode.map(Program.fromCborHex).get
// apply arguments to the program
val applied = program $ 42.toData
val script = Script.PlutusV3(applied.cborByteString)
// use the script in a transaction
// setup an emulator, we need to create some inputs here for it to work
val provider = Emulator(initialUtxos = Map.empty)
// deploying the script as a reference script
val tx = TxBuilder(CardanoInfo.mainnet)
    .output(
      TransactionOutput(
        Alice.address,
        Value.ada(10),
        datumOption = None,
        scriptRef = Some(ScriptRef(script))
      )
    )
    .complete(provider, sponsor = Alice.address)
    .await()
    .sign(Alice.signer)
    .transaction
// submitting the tx to the emulator for testing
provider.submit(tx).await()

[fallen-icarus]

@rssh @nau Thanks for these examples! Can you go a bit further though? I have an aiken script that expects extra parameters first to be applied. Then I want to:

1. Create a reference script on the emulator to use for later txs.
2. Create a tx that executes the script as both a minting policy and a certificate script using the reference UTxO on the emulator. So two executions with the same script.

You examples only show me how to create the reference UTxO. They don't show me how to execute the script. I don't know any scala so it is taking me a while to figure out the types and methods I need...

Here is the code I have so far (which could be wrong 😅). I want to use MintValidityNft and RegisterSharedWallet with the output index pointing to the output with the validity NFT that was minted in the tx.

package validator

import scalus.*
import scalus.ledger.api.v3.{PubKeyHash, Credential, TxInfo, TxOutRef}
import scalus.prelude.*
import scalus.builtin.Data.{ToData, toData}
import scalus.cardano.blueprint.Blueprint
import scalus.cardano.ledger.Script
import scalus.uplc.Program
import scalus.builtin.ByteString

import java.nio.file.{Files, Path}
import scala.concurrent.ExecutionContext.Implicits.global
import scala.io.Source

enum SharedWalletDatum derives ToData:
    case AdminConfigDatum(credentials: List[Credential], threshold: BigInt)
    case LowerPrivilegedDatum(credentials: List[Credential], threshold: BigInt)
    case AdminOnlyUTxO
    case PaymentReceiptDatum

@Compile
object SharedWalletDatum

enum SharedWalletSpendingRedeemer derives ToData:
    case UpdateAdminConfigDatum(outputConfigIdx: BigInt)
    case CloseOutSharedWallet
    case SpendAsAdminGroup(referenceConfigIdx: BigInt)
    case SpendAsLowerPrivilegeGroup

@Compile
object SharedWalletSpendingRedeemer

enum SharedWalletMintRedeemer derives ToData:
    case MintValidityNft
    case BurnValidityNft

@Compile
object SharedWalletMintRedeemer

enum SharedWalletPublishRedeemer derives ToData:
    case RegisterSharedWallet(outputConfigIdx: BigInt)
    case DeregisterSharedWallet(inputConfigIdx: BigInt)
    case CertifyAsAdmin(referenceConfigIdx: BigInt)

@Compile
object SharedWalletPublishRedeemer

enum SharedWalletOtherRedeemer derives ToData:
    case SharedWalletOtherRedeemer(referenceConfigIdx: BigInt)

@Compile
object SharedWalletOtherRedeemer

object SharedWallets:
    private val rawSharedWalletScript = {
        val fname = "../aiken/plutus.json"
        val inputStream = this.getClass.getResourceAsStream(fname)
        if inputStream == null then {
            throw new RuntimeException(s"Resource not found: $fname")
        }
        val jsonString = Source.fromInputStream(inputStream).mkString
        val blueprint = Blueprint.fromJson(jsonString)
        blueprint.validators.head.compiledCode.map(Program.fromCborHex).get
    }

    def mkSharedWallet(
        genesisCredentials: List[Credential],
        genesisThreshold: BigInt,
        walletName: Option[ByteString]
    ): Script = {
        val applied = rawSharedWalletScript
            .$ (genesisCredentials.toData)
            .$ (genesisThreshold.toData)
            .$ (walletName.toData)
        
        Script.PlutusV3(applied.cborByteString)
    }

[nau]

@fallen-icarus, Let's have a call and we'll help you figure everything out. Meanwhile, something like that should point you in the right direction I think.

package validator

import scalus.builtin.Data.{toData, ToData}
import scalus.builtin.ToData.given
import scalus.builtin.{ByteString, Data}
import scalus.cardano.address.Address.*
import scalus.cardano.address.{StakeAddress, StakePayload}
import scalus.cardano.ledger.*
import scalus.cardano.node.Emulator
import scalus.cardano.txbuilder.TxBuilder
import scalus.ledger.api.v3.Credential
import scalus.*
import scalus.prelude.List
import scalus.uplc.PlutusV3
import scalus.utils.await

import scala.concurrent.ExecutionContext.Implicits.global

enum SharedWalletDatum derives ToData:
    case AdminConfigDatum(credentials: prelude.List[Credential], threshold: BigInt)
    case LowerPrivilegedDatum(credentials: prelude.List[Credential], threshold: BigInt)
    case AdminOnlyUTxO
    case PaymentReceiptDatum

@Compile
object SharedWalletDatum

enum SharedWalletSpendingRedeemer derives ToData:
    case UpdateAdminConfigDatum(outputConfigIdx: BigInt)
    case CloseOutSharedWallet
    case SpendAsAdminGroup(referenceConfigIdx: BigInt)
    case SpendAsLowerPrivilegeGroup

@Compile
object SharedWalletSpendingRedeemer

enum SharedWalletMintRedeemer derives ToData:
    case MintValidityNft
    case BurnValidityNft

@Compile
object SharedWalletMintRedeemer

enum SharedWalletPublishRedeemer derives ToData:
    case RegisterSharedWallet(outputConfigIdx: BigInt)
    case DeregisterSharedWallet(inputConfigIdx: BigInt)
    case CertifyAsAdmin(referenceConfigIdx: BigInt)

@Compile
object SharedWalletPublishRedeemer

enum SharedWalletOtherRedeemer derives ToData:
    case SharedWalletOtherRedeemer(referenceConfigIdx: BigInt)

@Compile
object SharedWalletOtherRedeemer

object SharedWallets:
//    private val rawSharedWalletScript = {
//        val fname = "../aiken/plutus.json"
//        val inputStream = this.getClass.getResourceAsStream(fname)
//        if inputStream == null then {
//            throw new RuntimeException(s"Resource not found: $fname")
//        }
//        val jsonString = Source.fromInputStream(inputStream).mkString
//        val blueprint = Blueprint.fromJson(jsonString)
//        blueprint.validators.head.compiledCode.map(Program.fromCborHex).get
//    }
    val Alice =
        addr"addr1qxwg0u9fpl8dac9rkramkcgzerjsfdlqgkw0q8hy5vwk8tzk5pgcmdpe5jeh92guy4mke4zdmagv228nucldzxv95clqe35r3m"
    val Bob =
        addr"addr1qxwg0u9fpl8dac9rkramkcgzerjsfdlqgkw0q8hy5vwk8tzk5pgcmdpe5jeh92guy4mke4zdmagv228nucldzxv95clqe35r3m"

    private val rawSharedWalletScript = {
        given Compiler.Options = Compiler.Options.default
        val v = PlutusV3.compile((ctx: Data) => ())
        v.program
    }

    def mkSharedWallet(
        genesisCredentials: List[Credential],
        genesisThreshold: BigInt,
        walletName: prelude.Option[ByteString]
    ): Script = {
        val applied = rawSharedWalletScript $
            genesisCredentials.toData $
            genesisThreshold.toData $
            walletName.toData

        Script.PlutusV3(applied.cborByteString)
    }

    def mkEmulator(script: Script) = {
        val genesis = TransactionHash.fromHex("0".repeat(64))
        val utxos = Map(
          TransactionInput(genesis, 0) ->
              TransactionOutput(
                Alice,
                Value.ada(10),
                datumOption = None,
                scriptRef = Some(ScriptRef(script))
              ),
          TransactionInput(genesis, 1) ->
              TransactionOutput(Alice, Value.ada(1000)),
        )
        Emulator(utxos)
    }

    def makeTx() = {
        val env = CardanoInfo.mainnet
        val script: Script = ???
        // must be registered first
        val stakeAddr = StakeAddress(
          network = env.network,
          payload = StakePayload.Script(script.scriptHash)
        )
        val emulator = mkEmulator(script)
        val assets = Map(AssetName.fromString("test") -> 100L)
        TxBuilder(env)
            .payTo(
              address = Bob,
              value = Value.ada(5)
            )
            // reference the script, already put in the Emulator
            .references(Utxo(emulator.utxos.head))
            // mint using the referenced script
            .mint(script.scriptHash, assets, SharedWalletMintRedeemer.MintValidityNft)
            // withdraw 0
            .withdrawRewards(stakeAddress = stakeAddr, amount = Coin.zero)
            // set fees, collaterals and change output
            .complete(emulator, sponsor = Alice)
            .await()
            .transaction
    }