@meshsdk/contract 1.6.0-alpha.21 → 1.6.2

package/src/payment-splitter/aiken-workspace/validators/payment-splitter.ak

@@ -1,329 +0,0 @@
-use aiken/hash.{Blake2b_224, Hash}
-use aiken/list
-use aiken/option
-use aiken/transaction.{
-  Input, NoDatum, Output, OutputReference, ScriptContext, Spend, Transaction,
-  TransactionId,
-}
-use aiken/transaction/credential.{
-  Address, VerificationKey, VerificationKeyCredential,
-}
-use aiken/transaction/value.{from_lovelace, lovelace_of}
-
-type Datum {
-  owner: Hash<Blake2b_224, VerificationKey>,
-}
-
-type Redeemer {
-  message: ByteArray,
-}
-
-validator(scriptHashes: List<ByteArray>) {
-  fn payout(_datum: Datum, _redeemer: Redeemer, context: ScriptContext) -> Bool {
-    let payees = list.map(scriptHashes, fn(x) { VerificationKeyCredential(x) })
-
-    let Transaction { outputs, inputs, fee, .. } = context.transaction
-
-    let outputCredentials =
-      list.map(outputs, fn(output) { output.address.payment_credential })
-
-    // Only the payees are allowed to trigger the payout and the list needs to include all payees
-    let hasNoAdditionalPayees =
-      list.difference(list.unique(outputCredentials), payees) == []
-
-    // All payees must receive the same amount but the payee that triggered the payout
-    // must receive the sum of its own inputs minus the fee back to itself on top of that
-    let outputValues =
-      list.map(
-        payees,
-        fn(payee) {
-          let payeeOutputs =
-            list.filter(
-              outputs,
-              fn(output) { output.address.payment_credential == payee },
-            )
-
-          let payeeOutputSum =
-            list.foldr(
-              payeeOutputs,
-              0,
-              fn(output, acc) { acc + lovelace_of(output.value) },
-            )
-
-          let payeeInput =
-            list.filter(
-              inputs,
-              fn(input) { input.output.address.payment_credential == payee },
-            )
-
-          let payeeInputSum =
-            list.foldr(
-              payeeInput,
-              0,
-              fn(input, acc) { acc + lovelace_of(input.output.value) },
-            )
-
-          if payeeInputSum > 0 {
-            // The payee must receive the sum of its own inputs minus the fee back to itself
-            let change = payeeInputSum - lovelace_of(fee)
-            payeeOutputSum - change
-          } else {
-            payeeOutputSum
-          }
-        },
-      )
-    let isSplitEqually =
-      list.all(
-        outputValues,
-        fn(value) {
-          let firstOutputValue = option.or_else(list.head(outputValues), 0)
-          value == firstOutputValue
-        },
-      )
-
-    hasNoAdditionalPayees && isSplitEqually
-  }
-}
-
-test should_split_equally() {
-  let datum =
-    Datum { owner: #"52bd00e69e371daa373c021c3f4321356902016c320e41526e239406" }
-  let placeholder_utxo =
-    OutputReference { transaction_id: TransactionId(""), output_index: 0 }
-  let context =
-    ScriptContext {
-      purpose: Spend(placeholder_utxo),
-      transaction: transaction.placeholder()
-        |> fn(transaction) {
-            Transaction {
-              ..transaction,
-              fee: from_lovelace(846025),
-              inputs: [
-                Input {
-                  output_reference: OutputReference {
-                    transaction_id: TransactionId(""),
-                    output_index: 0,
-                  },
-                  output: Output {
-                    address: Address {
-                      payment_credential: VerificationKeyCredential(
-                        #"92e2ae51fb03dcc55c471506fe35bdedad9c266b0d09c2b8bc7cb445",
-                      ),
-                      stake_credential: None,
-                    },
-                    value: from_lovelace(41961442),
-                    datum: NoDatum,
-                    reference_script: None,
-                  },
-                },
-                Input {
-                  output_reference: OutputReference {
-                    transaction_id: TransactionId(""),
-                    output_index: 0,
-                  },
-                  output: Output {
-                    address: Address {
-                      payment_credential: VerificationKeyCredential(
-                        #"29ab97f98df7b26c5bfea0c68a727194eca3a14fe41bbe640bce1b8c",
-                      ),
-                      stake_credential: None,
-                    },
-                    value: from_lovelace(15000000),
-                    datum: NoDatum,
-                    reference_script: None,
-                  },
-                },
-              ],
-              outputs: [
-                Output {
-                  address: Address {
-                    payment_credential: VerificationKeyCredential(
-                      #"92e2ae51fb03dcc55c471506fe35bdedad9c266b0d09c2b8bc7cb445",
-                    ),
-                    stake_credential: None,
-                  },
-                  value: from_lovelace(3000000),
-                  datum: NoDatum,
-                  reference_script: None,
-                },
-                Output {
-                  address: Address {
-                    payment_credential: VerificationKeyCredential(
-                      #"92e2ae51fb03dcc55c471506fe35bdedad9c266b0d09c2b8bc7cb445",
-                    ),
-                    stake_credential: None,
-                  },
-                  value: from_lovelace(41115417),
-                  datum: NoDatum,
-                  reference_script: None,
-                },
-                Output {
-                  address: Address {
-                    payment_credential: VerificationKeyCredential(
-                      #"3cea9e9f66482d00cdacd2087d27173d534b76ce7e3cc86e8a07f434",
-                    ),
-                    stake_credential: None,
-                  },
-                  value: from_lovelace(3000000),
-                  datum: NoDatum,
-                  reference_script: None,
-                },
-                Output {
-                  address: Address {
-                    payment_credential: VerificationKeyCredential(
-                      #"01f3855a5b36569e6ce1bdd8286f2b8b4e764b0e1a90a3e3d8357490",
-                    ),
-                    stake_credential: None,
-                  },
-                  value: from_lovelace(3000000),
-                  datum: NoDatum,
-                  reference_script: None,
-                },
-                Output {
-                  address: Address {
-                    payment_credential: VerificationKeyCredential(
-                      #"ce63d3ad78867ac366cabe17e3f15f76d05e0f99827986f92413c4d8",
-                    ),
-                    stake_credential: None,
-                  },
-                  value: from_lovelace(3000000),
-                  datum: NoDatum,
-                  reference_script: None,
-                },
-                Output {
-                  address: Address {
-                    payment_credential: VerificationKeyCredential(
-                      #"06cae4f91a7e73521cfb42a0dcfe0d90feff52ffa096467995bfb503",
-                    ),
-                    stake_credential: None,
-                  },
-                  value: from_lovelace(3000000),
-                  datum: NoDatum,
-                  reference_script: None,
-                },
-              ],
-              extra_signatories: [
-                #"52bd00e69e371daa373c021c3f4321356902016c320e41526e239406",
-              ],
-            }
-          },
-    }
-
-  let redeemer = Redeemer { message: "Payday" }
-
-  let scriptHashes =
-    [
-      #"92e2ae51fb03dcc55c471506fe35bdedad9c266b0d09c2b8bc7cb445",
-      #"3cea9e9f66482d00cdacd2087d27173d534b76ce7e3cc86e8a07f434",
-      #"01f3855a5b36569e6ce1bdd8286f2b8b4e764b0e1a90a3e3d8357490",
-      #"ce63d3ad78867ac366cabe17e3f15f76d05e0f99827986f92413c4d8",
-      #"06cae4f91a7e73521cfb42a0dcfe0d90feff52ffa096467995bfb503",
-    ]
-
-  payout(scriptHashes, datum, redeemer, context)
-}
-
-test payment_splitter_should_fail() fail {
-  let datum =
-    Datum { owner: #"52bd00e69e371daa373c021c3f4321356902016c320e41526e239406" }
-  let placeholder_utxo =
-    OutputReference { transaction_id: TransactionId(""), output_index: 0 }
-  let context =
-    ScriptContext {
-      purpose: Spend(placeholder_utxo),
-      transaction: transaction.placeholder()
-        |> fn(transaction) {
-            Transaction {
-              ..transaction,
-              fee: from_lovelace(846025),
-              inputs: [
-                Input {
-                  output_reference: OutputReference {
-                    transaction_id: TransactionId(""),
-                    output_index: 0,
-                  },
-                  output: Output {
-                    address: Address {
-                      payment_credential: VerificationKeyCredential(
-                        #"92e2ae51fb03dcc55c471506fe35bdedad9c266b0d09c2b8bc7cb445",
-                      ),
-                      stake_credential: None,
-                    },
-                    value: from_lovelace(41961442),
-                    datum: NoDatum,
-                    reference_script: None,
-                  },
-                },
-                Input {
-                  output_reference: OutputReference {
-                    transaction_id: TransactionId(""),
-                    output_index: 0,
-                  },
-                  output: Output {
-                    address: Address {
-                      payment_credential: VerificationKeyCredential(
-                        #"29ab97f98df7b26c5bfea0c68a727194eca3a14fe41bbe640bce1b8c",
-                      ),
-                      stake_credential: None,
-                    },
-                    value: from_lovelace(16000000),
-                    datum: NoDatum,
-                    reference_script: None,
-                  },
-                },
-              ],
-              outputs: [
-                Output {
-                  address: Address {
-                    payment_credential: VerificationKeyCredential(
-                      #"92e2ae51fb03dcc55c471506fe35bdedad9c266b0d09c2b8bc7cb445",
-                    ),
-                    stake_credential: None,
-                  },
-                  value: from_lovelace(8000000),
-                  datum: NoDatum,
-                  reference_script: None,
-                },
-                Output {
-                  address: Address {
-                    payment_credential: VerificationKeyCredential(
-                      #"92e2ae51fb03dcc55c471506fe35bdedad9c266b0d09c2b8bc7cb445",
-                    ),
-                    stake_credential: None,
-                  },
-                  value: from_lovelace(41115417),
-                  datum: NoDatum,
-                  reference_script: None,
-                },
-                Output {
-                  address: Address {
-                    payment_credential: VerificationKeyCredential(
-                      #"3cea9e9f66482d00cdacd2087d27173d534b76ce7e3cc86e8a07f434",
-                    ),
-                    stake_credential: None,
-                  },
-                  value: from_lovelace(8000000),
-                  datum: NoDatum,
-                  reference_script: None,
-                },
-              ],
-              extra_signatories: [
-                #"52bd00e69e371daa373c021c3f4321356902016c320e41526e239406",
-              ],
-            }
-          },
-    }
-
-  let redeemer = Redeemer { message: "Payday" }
-
-  let scriptHashes =
-    [
-      #"92e2ae51fb03dcc55c471506fe35bdedad9c266b0d09c2b8bc7cb445",
-      #"3cea9e9f66482d00cdacd2087d27173d534b76ce7e3cc86e8a07f434",
-      #"01f3855a5b36569e6ce1bdd8286f2b8b4e764b0e1a90a3e3d8357490",
-      #"ce63d3ad78867ac366cabe17e3f15f76d05e0f99827986f92413c4d8",
-      #"06cae4f91a7e73521cfb42a0dcfe0d90feff52ffa096467995bfb503",
-    ]
-
-  payout(scriptHashes, datum, redeemer, context)
-}

package/src/payment-splitter/index.ts

@@ -1 +0,0 @@
-export * from './offchain';

package/src/payment-splitter/offchain.ts

@@ -1,143 +0,0 @@
-import { builtinByteString, list, PlutusScript } from "@meshsdk/common";
-import {
-  BrowserWallet,
-  deserializeAddress,
-  MeshWallet,
-  serializePlutusScript,
-  Transaction,
-} from "@meshsdk/core";
-import { applyParamsToScript } from "@meshsdk/core-csl";
-
-import { MeshTxInitiator, MeshTxInitiatorInput } from "../common";
-import blueprint from "./aiken-workspace/plutus.json";
-
-export const MeshPaymentSplitterBlueprint = blueprint;
-
-export class MeshPaymentSplitterContract extends MeshTxInitiator {
-  wrapPayees = (payees: string[]) =>
-    list(
-      payees.map((payee) =>
-        builtinByteString(deserializeAddress(payee).pubKeyHash),
-      ),
-    );
-
-  scriptCbor = () =>
-    applyParamsToScript(
-      blueprint.validators[0]!.compiledCode,
-      [this.wrapPayees(this.payees)],
-      "JSON",
-    );
-  payees: string[] = [];
-
-  constructor(inputs: MeshTxInitiatorInput, payees: string[]) {
-    super(inputs);
-
-    if (inputs.wallet) {
-      // We add the initiator to the payees list, as only the payees can trigger the payout in the next steps
-      if (inputs.wallet instanceof MeshWallet) {
-        this.payees = [inputs.wallet.getUsedAddresses()[0]!, ...payees];
-      }
-      if (inputs.wallet instanceof BrowserWallet) {
-        inputs.wallet.getUsedAddresses().then((addresses) => {
-          this.payees = [addresses[0]!, ...payees];
-        });
-      }
-    } else {
-      this.payees = payees;
-      console.warn(
-        "Wallet not provided. Therefore the payment address will not be added to the payees list which makes it impossible to trigger the payout.",
-      );
-    }
-  }
-
-  sendLovelaceToSplitter = async (lovelaceAmount: number): Promise<string> => {
-    if (this.wallet === null || this.wallet === undefined) {
-      throw new Error("Wallet not provided");
-    }
-
-    const { walletAddress } = await this.getWalletInfoForTx();
-
-    const script: PlutusScript = {
-      code: this.scriptCbor(),
-      version: "V2",
-    };
-
-    const { address: scriptAddress } = serializePlutusScript(
-      script,
-      undefined,
-      0,
-    );
-
-    const { pubKeyHash } = deserializeAddress(walletAddress);
-    const datum = {
-      alternative: 0,
-      fields: [pubKeyHash],
-    };
-
-    const tx = new Transaction({ initiator: this.wallet }).sendLovelace(
-      {
-        address: scriptAddress,
-        datum: { value: datum },
-      },
-      lovelaceAmount.toString(),
-    );
-
-    const unsignedTx = await tx.build();
-    return unsignedTx;
-  };
-
-  triggerPayout = async () => {
-    if (this.wallet === null || this.wallet === undefined) {
-      throw new Error("Wallet not provided");
-    }
-
-    const { walletAddress, collateral } = await this.getWalletInfoForTx();
-
-    const script: PlutusScript = {
-      code: this.scriptCbor(),
-      version: "V2",
-    };
-    const { address: scriptAddress } = serializePlutusScript(
-      script,
-      undefined,
-      0,
-    );
-    const utxos = (await this.fetcher?.fetchAddressUTxOs(scriptAddress)) || [];
-    const { pubKeyHash } = deserializeAddress(walletAddress);
-    const datum = {
-      alternative: 0,
-      fields: [pubKeyHash],
-    };
-
-    const redeemerData = "Hello, World!";
-    const redeemer = { data: { alternative: 0, fields: [redeemerData] } };
-
-    let tx = new Transaction({ initiator: this.wallet });
-    let split = 0;
-    for (const utxo of utxos) {
-      const amount = utxo.output?.amount;
-      if (amount) {
-        let lovelace = amount.find((asset) => asset.unit === "lovelace");
-        if (lovelace) {
-          split += Math.floor(Number(lovelace.quantity) / this.payees.length);
-        }
-
-        tx = tx.redeemValue({
-          value: utxo,
-          script: script,
-          datum: datum,
-          redeemer: redeemer,
-        });
-      }
-    }
-
-    tx = tx.setCollateral([collateral]);
-    for (const payee of this.payees) {
-      tx = tx.sendLovelace(payee, split.toString());
-    }
-
-    tx = tx.setRequiredSigners([walletAddress]);
-    const unsignedTx = await tx.build();
-    return unsignedTx;
-  };
-}

package/src/payment-splitter/readme.md

@@ -1,100 +0,0 @@
-# 💸 Aiken Payment Splitter
-
-A simple payment splitter validator written in Aiken and its off-chain counterpart. The Aiken code is located in the onchain directory, while the off-chain code is in the offchain directory.
-
-[Demo](https://meshjs.dev/smart-contracts/payment-splitter)
-
-There are 2 actions (or endpoints) available to interact with this smart contract:
-
-- Send Lovelace to Payment Splitter
-- Trigger Payout
-
-To initialize the payment splitter, we need to initialize a provider, MeshTxBuilder and MeshPaymentSplitterContract.
-
-```typescript
-import { BlockfrostProvider, MeshTxBuilder } from '@meshsdk/core';
-import { MeshPaymentSplitterContract } from '@meshsdk/contracts';
-import { useWallet } from '@meshsdk/react';
-
-const { connected, wallet } = useWallet();
-
-const blockchainProvider = new BlockfrostProvider(APIKEY);
-
-const meshTxBuilder = new MeshTxBuilder({
-  fetcher: blockchainProvider,
-  submitter: blockchainProvider,
-});
-
-const contract = new MeshPaymentSplitterContract(
-  {
-    mesh: meshTxBuilder,
-    fetcher: blockchainProvider,
-    wallet: wallet,
-    networkId: 0,
-  },
-  [
-    'addr_test1vpg334d6skwu6xxq0r4lqrnsjd5293n8s3d80em60kf6guc7afx8k',
-    'addr_test1vp4l2kk0encl7t7972ngepgm0044fu8695prkgh5vjj5l6sxu0l3p',
-    'addr_test1vqqnfs2vt42nq4htq460wd6gjxaj05jg9vzg76ur6ws4sngs55pwr',
-    'addr_test1vqv2qhqddxmf87pzky2nkd9wm4y5599mhp62mu4atuss5dgdja5pw',
-  ]);
-```
-
-## ⛓ On-chain
-
-The validator checks two simple rules:
-
-1. The list of (unique) payment credentials must match the provided list of "known payees." This list can be provided as a parameter to the validator.
-2. The sum of the outputs (by payment credentials) must be equally split. (Excluding change outputs)
-
-### 🔌 Prerequirements
-
-- [Aiken](https://aiken-lang.org/installation-instructions#from-aikup-linux--macos-only)
-
-### 🪄 Test and build
-
-```bash
-cd onchain
-aiken test
-aiken build
-```
-
-## 📄 Off-chain
-
-### 🔌 Prerequirements
-
-- Node >= 16
-- Yarn
-
-### 💳 Prepare a list of wallets
-
-```bash
-cd offchain
-yarn install
-node use-payment-splitter.js prepare 5
-```
-
-### 💎 Top up the wallets
-
-Copy the address from the output of the previous command and send some test Ada on the preprod network to this address.
-If you don't have test Ada at all, you can get some from the [Cardano Testnets Faucet](https://docs.cardano.org/cardano-testnets/tools/faucet/).
-
-### 🤳🏼 Send 10 tAda to the payment splitter
-
-Anyone can lock funds in the payment splitter by sending an amount to the contract address.
-
-```bash
-node use-payment-splitter.js lock 10000000
-```
-
-Example transaction: https://preprod.cexplorer.io/tx/0008dd3ead94b0ca922ad45162762d73b5200efc5565a24532f1517fdf060dee
-
-### 🤑 Trigger a payout
-
-This command will generate a transaction that calculates the total available Lovelace value within the contract UTXOs and distributes the funds among the payees.
-
-```bash
-node use-payment-splitter.js unlock
-```
-
-Example transaction: https://preprod.cexplorer.io/tx/53be51e0f1268d41caae2944a760387fd762e76058aceddee73ca507d9e9a9c7

package/src/swap/aiken-workspace/aiken.lock

@@ -1,26 +0,0 @@
-# This file was generated by Aiken
-# You typically do not need to edit this file
-
-[[requirements]]
-name = "aiken-lang/stdlib"
-version = "1.9.0"
-source = "github"
-
-[[requirements]]
-name = "sidan-lab/aiken-utils"
-version = "0.1.6-beta"
-source = "github"
-
-[[packages]]
-name = "aiken-lang/stdlib"
-version = "1.9.0"
-requirements = []
-source = "github"
-
-[[packages]]
-name = "sidan-lab/aiken-utils"
-version = "0.1.6-beta"
-requirements = []
-source = "github"
-
-[etags]

package/src/swap/aiken-workspace/aiken.toml

@@ -1,19 +0,0 @@
-name = "meshjs/swap"
-version = "0.0.0"
-license = "Apache-2.0"
-description = "Aiken contracts for project 'meshjs/swap'"
-
-[repository]
-user = "meshjs"
-project = "swap"
-platform = "github"
-
-[[dependencies]]
-name = "aiken-lang/stdlib"
-version = "1.9.0"
-source = "github"
-
-[[dependencies]]
-name = "sidan-lab/aiken-utils"
-version = "0.1.6-beta"
-source = "github"