@meshsdk/contract 1.6.0-alpha.11

package/src/marketplace/offchain.ts

@@ -0,0 +1,248 @@
+import {
+  ConStr0,
+  conStr0,
+  CurrencySymbol,
+  currencySymbol,
+  Integer,
+  integer,
+  mConStr0,
+  mConStr1,
+  parseAssetUnit,
+  PubKeyAddress,
+  pubKeyAddress,
+  TokenName,
+  tokenName,
+} from "@meshsdk/common";
+import {
+  deserializeAddress,
+  deserializeDatum,
+  Quantity,
+  serializeAddressObj,
+  serializePlutusScript,
+  Unit,
+  UTxO,
+} from "@meshsdk/core";
+import { applyParamsToScript } from "@meshsdk/core-csl";
+import { keepRelevant, largestFirst } from "@meshsdk/transaction";
+
+import { MeshTxInitiator, MeshTxInitiatorInput } from "../common";
+import blueprint from "./aiken-workspace/plutus.json";
+
+export const MeshMarketplaceBlueprint = blueprint;
+
+export type MarketplaceDatum = ConStr0<
+  [PubKeyAddress, Integer, CurrencySymbol, TokenName]
+>;
+export const marketplaceDatum = (
+  sellerAddress: string,
+  lovelaceFee: number,
+  assetHex: string,
+): MarketplaceDatum => {
+  const { pubKeyHash, stakeCredentialHash } = deserializeAddress(sellerAddress);
+  const { policyId, assetName } = parseAssetUnit(assetHex);
+  return conStr0([
+    pubKeyAddress(pubKeyHash, stakeCredentialHash),
+    integer(lovelaceFee),
+    currencySymbol(policyId),
+    tokenName(assetName),
+  ]);
+};
+
+export class MeshMarketplaceContract extends MeshTxInitiator {
+  ownerAddress: string;
+  feePercentageBasisPoint: number;
+  scriptCbor: string;
+
+  constructor(
+    inputs: MeshTxInitiatorInput,
+    ownerAddress: string,
+    feePercentageBasisPoint: number,
+  ) {
+    super(inputs);
+    this.ownerAddress = ownerAddress;
+    this.feePercentageBasisPoint = feePercentageBasisPoint;
+    const { pubKeyHash, stakeCredentialHash } =
+      deserializeAddress(ownerAddress);
+    this.scriptCbor = applyParamsToScript(
+      blueprint.validators[0]!.compiledCode,
+      [
+        pubKeyAddress(pubKeyHash, stakeCredentialHash),
+        integer(feePercentageBasisPoint),
+      ],
+      "JSON",
+    );
+  }
+
+  listAsset = async (asset: string, price: number) => {
+    const { utxos, walletAddress } = await this.getWalletInfoForTx();
+
+    const assetMap = new Map<Unit, Quantity>();
+    assetMap.set(asset, "1");
+    const selectedUtxos = keepRelevant(assetMap, utxos);
+
+    const { address: scriptAddr } = serializePlutusScript(
+      { code: this.scriptCbor, version: "V2" },
+      undefined,
+      this.networkId,
+    );
+
+    const tokenForSale = [{ unit: asset, quantity: "1" }];
+    const outputDatum = marketplaceDatum(walletAddress, price, asset);
+
+    await this.mesh
+      .txOut(scriptAddr, tokenForSale)
+      .txOutInlineDatumValue(outputDatum, "JSON")
+      .changeAddress(walletAddress)
+      .selectUtxosFrom(selectedUtxos)
+      .complete();
+
+    return this.mesh.txHex;
+  };
+
+  delistAsset = async (marketplaceUtxo: UTxO) => {
+    const { utxos, walletAddress, collateral } =
+      await this.getWalletInfoForTx();
+
+    await this.mesh
+      .spendingPlutusScriptV2()
+      .txIn(
+        marketplaceUtxo.input.txHash,
+        marketplaceUtxo.input.outputIndex,
+        marketplaceUtxo.output.amount,
+        marketplaceUtxo.output.address,
+      )
+      .spendingReferenceTxInInlineDatumPresent()
+      .spendingReferenceTxInRedeemerValue(mConStr1([]))
+      .txInScript(this.scriptCbor)
+      .changeAddress(walletAddress)
+      .requiredSignerHash(deserializeAddress(walletAddress).pubKeyHash)
+      .txInCollateral(
+        collateral.input.txHash,
+        collateral.input.outputIndex,
+        collateral.output.amount,
+        collateral.output.address,
+      )
+      .selectUtxosFrom(utxos)
+      .complete();
+
+    return this.mesh.txHex;
+  };
+
+  purchaseAsset = async (marketplaceUtxo: UTxO) => {
+    const { utxos, walletAddress, collateral } =
+      await this.getWalletInfoForTx();
+
+    const inputDatum = deserializeDatum<MarketplaceDatum>(
+      marketplaceUtxo.output.plutusData!,
+    );
+
+    const listingPrice = inputDatum.fields[1].int.toString();
+    const selectedUtxos = largestFirst(listingPrice, utxos, true);
+
+    const inputLovelace = marketplaceUtxo.output.amount.find(
+      (a) => a.unit === "lovelace",
+    )!.quantity;
+
+    const tx = this.mesh
+      .spendingPlutusScriptV2()
+      .txIn(
+        marketplaceUtxo.input.txHash,
+        marketplaceUtxo.input.outputIndex,
+        marketplaceUtxo.output.amount,
+        marketplaceUtxo.output.address,
+      )
+      .spendingReferenceTxInInlineDatumPresent()
+      .spendingReferenceTxInRedeemerValue(mConStr0([]))
+      .txInScript(this.scriptCbor)
+      .changeAddress(walletAddress)
+      .txInCollateral(
+        collateral.input.txHash,
+        collateral.input.outputIndex,
+        collateral.output.amount,
+        collateral.output.address,
+      )
+      .selectUtxosFrom(selectedUtxos);
+
+    let ownerToReceiveLovelace =
+      ((inputDatum.fields[1].int as number) * this.feePercentageBasisPoint) /
+      10000;
+    if (this.feePercentageBasisPoint > 0 && ownerToReceiveLovelace < 1000000) {
+      ownerToReceiveLovelace = 1000000;
+    }
+
+    if (ownerToReceiveLovelace > 0) {
+      const ownerAddress = this.ownerAddress;
+      const ownerToReceive = [
+        {
+          unit: "lovelace",
+          quantity: Math.ceil(ownerToReceiveLovelace).toString(),
+        },
+      ];
+      tx.txOut(ownerAddress, ownerToReceive);
+    }
+
+    const sellerToReceiveLovelace =
+      (inputDatum.fields[1].int as number) + Number(inputLovelace);
+
+    if (sellerToReceiveLovelace > 0) {
+      const sellerAddress = serializeAddressObj(inputDatum.fields[0]);
+      const sellerToReceive = [
+        {
+          unit: "lovelace",
+          quantity: sellerToReceiveLovelace.toString(),
+        },
+      ];
+      tx.txOut(sellerAddress, sellerToReceive);
+    }
+    await tx.complete();
+
+    return this.mesh.txHex;
+  };
+
+  relistAsset = async (marketplaceUtxo: UTxO, newPrice: number) => {
+    const { utxos, walletAddress, collateral } =
+      await this.getWalletInfoForTx();
+    const inputAsset = marketplaceUtxo.output.amount.find(
+      (a) => a.unit !== "lovelace",
+    )!.unit;
+
+    const tokenForSale = [{ unit: inputAsset, quantity: "1" }];
+    const outputDatum = marketplaceDatum(walletAddress, newPrice, inputAsset);
+
+    const { address: scriptAddr } = serializePlutusScript(
+      { code: this.scriptCbor, version: "V2" },
+      undefined,
+      this.networkId,
+    );
+
+    await this.mesh
+      .spendingPlutusScriptV2()
+      .txIn(
+        marketplaceUtxo.input.txHash,
+        marketplaceUtxo.input.outputIndex,
+        marketplaceUtxo.output.amount,
+        marketplaceUtxo.output.address,
+      )
+      .spendingReferenceTxInInlineDatumPresent()
+      .spendingReferenceTxInRedeemerValue(mConStr1([]))
+      .txInScript(this.scriptCbor)
+      .txOut(scriptAddr, tokenForSale)
+      .txOutInlineDatumValue(outputDatum, "JSON")
+      .changeAddress(walletAddress)
+      .requiredSignerHash(deserializeAddress(walletAddress).pubKeyHash)
+      .txInCollateral(
+        collateral.input.txHash,
+        collateral.input.outputIndex,
+        collateral.output.amount,
+        collateral.output.address,
+      )
+      .selectUtxosFrom(utxos)
+      .complete();
+
+    return this.mesh.txHex;
+  };
+
+  getUtxoByTxHash = async (txHash: string): Promise<UTxO | undefined> => {
+    return await this._getUtxoByTxHash(this.scriptCbor, txHash);
+  };
+}

package/src/marketplace/readme.md

@@ -0,0 +1,45 @@
+# Marketplace Contract
+
+This marketplace allows anyone to buy and sell native assets such as NFTs.
+
+[Demo](https://meshjs.dev/smart-contracts/marketplace)
+
+The marketplace smart contract allows users to buy and sell NFTs. A seller list an NFT for sales by specifying a certain price, and anyone can buy it by paying the demanded price.
+
+There are 4 actions (or endpoints) available to interact with this smart contract:
+
+- list asset
+- buy asset
+- updating listing
+- cancel listing
+
+## Initialize the Marketplace
+
+Utilizing the Marketplace contract requires a blockchain provider and a connected browser wallet. Here is an example how we can initialize the Marketplace.
+
+```
+import { MeshMarketplaceContract } from '@meshsdk/contracts';
+import { BlockfrostProvider, MeshTxBuilder } from '@meshsdk/core';
+
+const blockchainProvider = new BlockfrostProvider(APIKEY);
+
+const meshTxBuilder = new MeshTxBuilder({
+  fetcher: blockchainProvider,
+  submitter: blockchainProvider,
+});
+
+const contract = new MeshMarketplaceContract(
+  {
+    mesh: meshTxBuilder,
+    fetcher: blockchainProvider,
+    wallet: wallet,
+    networkId: 0,
+  },
+  'addr_test1qpvx0sacufuypa2k4sngk7q40zc5c4npl337uusdh64kv06fwlvuacpyv59g3a3w2fhk7daa8aepvacnpamyhyyxrgnscrfpsa',
+  200
+);
+```
+
+To initialize the Marketplace, we import the MeshMarketplaceContract. The first JSON object is the inputs for the MeshTxInitiatorInput, this requires a MeshTxBuilder, a Provider, a Wallet, and define the network ID.
+
+Second and third parameters are the ownerAddress and feePercentageBasisPoint. The ownerAddress is the address of the marketplace owner which will receive the marketplace fee. The feePercentageBasisPoint is the percentage of the sale price that the marketplace owner will take. The fee numerator is in the order of hundreds, for example 200 implies a fee of 2%.

package/src/payment-splitter/aiken-workspace/aiken.lock

@@ -0,0 +1,15 @@
+# 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"
+
+[[packages]]
+name = "aiken-lang/stdlib"
+version = "1.9.0"
+requirements = []
+source = "github"
+
+[etags]

package/src/payment-splitter/aiken-workspace/aiken.toml

@@ -0,0 +1,14 @@
+name = "fabianbormann/payment-splitter"
+version = "0.1.0"
+license = "Apache-2.0"
+description = "Aiken contracts for project 'fabianbormann/payment-splitter'"
+
+[repository]
+user = "fabianbormann"
+project = "payment-splitter"
+platform = "github"
+
+[[dependencies]]
+name = "aiken-lang/stdlib"
+version = "1.9.0"
+source = "github"

package/src/payment-splitter/aiken-workspace/plutus.json

@@ -0,0 +1,83 @@
+{
+  "preamble": {
+    "title": "fabianbormann/payment-splitter",
+    "description": "Aiken contracts for project 'fabianbormann/payment-splitter'",
+    "version": "0.1.0",
+    "plutusVersion": "v2",
+    "compiler": {
+      "name": "Aiken",
+      "version": "v1.0.29-alpha+unknown"
+    },
+    "license": "Apache-2.0"
+  },
+  "validators": [
+    {
+      "title": "payment_splitter.payout",
+      "datum": {
+        "title": "_datum",
+        "schema": {
+          "$ref": "#/definitions/payment_splitter~1Datum"
+        }
+      },
+      "redeemer": {
+        "title": "_redeemer",
+        "schema": {
+          "$ref": "#/definitions/payment_splitter~1Redeemer"
+        }
+      },
+      "parameters": [
+        {
+          "title": "scriptHashes",
+          "schema": {
+            "$ref": "#/definitions/List$ByteArray"
+          }
+        }
+      ],
+      "compiledCode": "5903a5010000323232323232322322322322533300832323232323232323232323253330143375e6e9cccc8c0040048894ccc06800440084ccc00c00cc8c8cc004004010894ccc07400452f5c026464a66603866ebc00801440044cc080008cc010010004c084008c07c004c070004c074004cc8c004004894ccc06400452f5c026466036002660060066600e603a004466603066ebc00400928251301b001323300100100722533301900114bd7009980d1806180c1baa300c3018375460360026600400460380020169801018000100114a0646600200200444a66603000229444c94ccc058cdc39bad301b00233005533301900414c0103d87a80001300e3301a301b0044bd70240002660060060022940c06c004c8cc004004028894ccc05c00452f5c02660306ea0c8c8c8c8c8c94ccc068cdc424000002266e04008cdc08009802005880119980119804806919baf3010301c3754602060386ea8c014c070dd5000803240004466e00004c014dd59803180e9baa3006301d375400466600266010014466ebcc03cc06cdd51807980d9baa0010054800088cdc000098021bab3005301c3754004444646600200200844a66603e0022008266006604200266004004604400246600c64a66603066e1d200230193754002298103d87a8000132330010013756603c60366ea8008894ccc074004530103d87a8000132323232533301e33722911000021533301e3371e9101000021301633022375000297ae014c0103d87a8000133006006003375a603e0066eb8c074008c084008c07c004c8cc004004008894ccc0700045300103d87a8000132323232533301d33722911000021533301d3371e9101000021301533021374c00297ae014c0103d87a80001330060060033756603c0066eb8c070008c080008c07800520002301b301c001301900133002002301a0012253330133370e9001180a1baa00210011375a6030602a6ea800888c8cc00400400c894ccc05c00452f5c026464a66602c600a00426603400466008008002266008008002603600460320026eacc050c054008dd61809800980998098011bac3011001300d37546002601a6ea80108c040004c8cc004004020894ccc03800452f5c026601e60066601e602000297ae0330020023011001374a90000a4c26caca66600c66e1d20003007375400226464a666016601c0042930b1bae300c001300837540022ca66600866e1d20003005375400226464a66601260180042930b1bae300a001300637540022c6eb00055cd2ab9d5573caae7d5d02ba157441",
+      "hash": "0776032753d2900f7c1e933af4108c53851e10ca95fa10e34af90277"
+    }
+  ],
+  "definitions": {
+    "ByteArray": {
+      "dataType": "bytes"
+    },
+    "List$ByteArray": {
+      "dataType": "list",
+      "items": {
+        "$ref": "#/definitions/ByteArray"
+      }
+    },
+    "payment_splitter/Datum": {
+      "title": "Datum",
+      "anyOf": [
+        {
+          "title": "Datum",
+          "dataType": "constructor",
+          "index": 0,
+          "fields": [
+            {
+              "title": "owner",
+              "$ref": "#/definitions/ByteArray"
+            }
+          ]
+        }
+      ]
+    },
+    "payment_splitter/Redeemer": {
+      "title": "Redeemer",
+      "anyOf": [
+        {
+          "title": "Redeemer",
+          "dataType": "constructor",
+          "index": 0,
+          "fields": [
+            {
+              "title": "message",
+              "$ref": "#/definitions/ByteArray"
+            }
+          ]
+        }
+      ]
+    }
+  }
+}