handle sft giveaway endpoint

Author: juliancwirko

CHANGELOG.md

@@ -1,6 +1,10 @@
+### [1.29.0](https://github.com/ElvenTools/elven-tools-cli/releases/tag/v1.29.0) (2024-02-10)
+- handle a giveaway endpoint for SFT minter SC
+- update dependencies
+
 ### [1.28.0](https://github.com/ElvenTools/elven-tools-cli/releases/tag/v1.28.0) (2024-01-06)
- - add possibility to define special roles for nft minter
- - update dependencies
+- add possibility to define special roles for nft minter
+- update dependencies
 
 ### [1.27.0](https://github.com/ElvenTools/elven-tools-cli/releases/tag/v1.27.0) (2024-01-05)
  - add possibility to define special roles for sft minter

package-lock.json

@@ -3,11 +3,11 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "version": "1.28.0",
+  "version": "1.29.0",
   "elvenTools": {
     "nftSmartContractVersionTagName": "v1.15.0",
-    "sftSmartContractVersionTagName": "v0.6.0",
-    "minterDappVersionTagName": "v7.4.1"
+    "sftSmartContractVersionTagName": "v0.7.0",
+    "minterDappVersionTagName": "v7.4.2"
   },
   "description": "Interacting with custom NFT/SFT-related smart contracts on the MultiversX blockchain",
   "bin": {
@@ -42,17 +42,18 @@
     "javascript",
     "typescript",
     "nft",
+    "sft",
     "cli",
     "transaction",
     "interaction",
     "elrond"
   ],
   "dependencies": {
-    "@multiversx/sdk-core": "12.17.0",
-    "@multiversx/sdk-network-providers": "2.2.0",
-    "@multiversx/sdk-wallet": "4.2.0",
+    "@multiversx/sdk-core": "12.18.0",
+    "@multiversx/sdk-network-providers": "2.2.1",
+    "@multiversx/sdk-wallet": "4.3.0",
     "adm-zip": "0.5.10",
-    "axios": "1.6.5",
+    "axios": "1.6.7",
     "bignumber.js": "9.1.2",
     "cosmiconfig": "9.0.0",
     "cross-fetch": "4.0.0",
@@ -65,15 +66,15 @@
   "devDependencies": {
     "@types/adm-zip": "0.5.5",
     "@types/cross-spawn": "6.0.6",
-    "@types/node": "20.10.6",
+    "@types/node": "20.11.17",
     "@types/prompts": "2.4.9",
-    "@typescript-eslint/eslint-plugin": "6.18.0",
-    "@typescript-eslint/parser": "6.18.0",
-    "esbuild": "0.19.11",
+    "@typescript-eslint/eslint-plugin": "6.21.0",
+    "@typescript-eslint/parser": "6.21.0",
+    "esbuild": "0.20.0",
     "eslint": "8.56.0",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-prettier": "5.1.2",
-    "prettier": "3.1.1",
+    "eslint-plugin-prettier": "5.1.3",
+    "prettier": "3.2.5",
     "rimraf": "5.0.5",
     "typescript": "5.3.3"
   }

package.json

@@ -362,6 +362,10 @@ export const getSftBurnFunctionName =
 export const sftBurnGasLimit =
   customConfig?.config?.sftMinterSc?.burnGasLimit || 3000000;
 
+// Gas limit required for giveaway transaction
+export const sftGiveawayTxBaseGasLimit =
+  customConfig?.config?.sftMinterSc?.giveawayBaseGasLimit || 3500000;
+
 // ⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡
 // Collection NFT owners
 // ⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡⚡
@@ -459,6 +463,7 @@ export const sftTokenNonceLabel =
   'Provide token nonce (for example in TTSFT-d1d695-01 the 01 has to be provided):\n';
 export const amountToBuyLabel = 'Provide the amount of SFT to buy:\n';
 export const giveawayAddressLabel = `Provide the list of addresses.\nSeparate them with comma (","):\n`;
+export const sftGiveawayReceiversLabel = `Provide the list of receivers.\nExample: erd1...|01|10,erd1...|02|100 etc. (address|nonce|amount):\n`;
 export const giveawayTokensAmount = `Provide how many tokens per one address you want to give away. Max ${tokensPerOneGiveawayTx} in total because of the max gas limit per transaction:\n`;
 export const dropTokensAmountLabel =
   'Provide the amount of the tokens for the drop:\n';

src/config.ts

@@ -7,7 +7,7 @@ import {
   getNftSCAddressFromOutputOrConfig,
   getNftAssignRolesTransaction,
   getMintTransaction,
-  getGiveawayTransaction,
+  getNftGiveawayTransaction,
   getSetDropTransaction,
   getUnsetDropTransaction,
   getPauseMintingTransaction,
@@ -358,7 +358,7 @@ const giveaway = async () => {
       exit(9);
     }
 
-    const giveawayTx = getGiveawayTransaction(
+    const giveawayTx = getNftGiveawayTransaction(
       signer.getAddress(),
       smartContract,
       giveawayTxBaseGasLimit,

src/nft-minter-fns.ts

@@ -25,6 +25,8 @@ import {
   getSftSetNewAmountLimitPerAddressTransaction,
   getSftMintTransaction,
   getSftBurnTransaction,
+  getFileContents,
+  getSftGiveawayTransaction,
 } from './utils';
 import prompts, { PromptObject } from 'prompts';
 import {
@@ -61,6 +63,9 @@ import {
   amountOfTokensToBurnLabel,
   sftCollectionProperties,
   sftSpecialRoles,
+  giveawayFileRelativePath,
+  sftGiveawayReceiversLabel,
+  sftGiveawayTxBaseGasLimit,
 } from './config';
 
 const nonceOnlyPromptQuestion: PromptObject[] = [
@@ -668,6 +673,66 @@ const getAmountPerAddressTotal = async () => {
   }
 };
 
+const giveaway = async () => {
+  const smartContractAddress = getSftSCAddressFromOutputOrConfig();
+
+  const promptQuestions: PromptObject[] = [
+    {
+      type: 'list',
+      name: 'giveawayReceiversList',
+      message: sftGiveawayReceiversLabel,
+      validate: (value) =>
+        value && value.length > 0 ? true : `Reguires at least one receiver!`,
+    },
+  ];
+
+  try {
+    const { smartContract, userAccount, signer, provider } =
+      await setupSftSc(smartContractAddress);
+
+    const giveawayFile = getFileContents(giveawayFileRelativePath, {
+      noExitOnError: true,
+    });
+
+    let receivers = [];
+
+    if (giveawayFile) {
+      console.log(' ');
+      console.log(`Populating receivers from the file: giveaway.json.`);
+      console.log(' ');
+      await areYouSureAnswer();
+      receivers = giveawayFile;
+    } else {
+      console.log(' ');
+      console.log('There is no giveaway.json file with receivers.');
+      console.log('You will be providing receivers by hand...');
+      console.log(' ');
+      await areYouSureAnswer();
+      const { giveawayReceiversList } = await prompts(promptQuestions);
+      const standarized = giveawayReceiversList.map((receiver: string) => {
+        const split = receiver.split('|');
+        return {
+          address: split[0],
+          nonce: split[1],
+          amount: split[2],
+        };
+      });
+      receivers = standarized;
+    }
+
+    const giveawayTx = getSftGiveawayTransaction(
+      signer.getAddress(),
+      smartContract,
+      sftGiveawayTxBaseGasLimit,
+      receivers
+    );
+
+    await commonTxOperations(giveawayTx, userAccount, signer, provider);
+  } catch (e) {
+    console.log((e as Error)?.message);
+  }
+};
+
 export const sftMinter = async (subcommand?: string) => {
   const COMMANDS = {
     issueCollectionToken: 'issue-collection-token',
@@ -681,6 +746,7 @@ export const sftMinter = async (subcommand?: string) => {
     pauseSelling: 'pause-selling',
     mint: 'mint',
     burn: 'burn',
+    giveaway: 'giveaway',
     setNewAmountLimitPerAddress: 'set-new-amount-limit-per-address',
     getCollectionTokenName: 'get-collection-token-name',
     getCollectionTokenId: 'get-collection-token-id',
@@ -777,5 +843,8 @@ export const sftMinter = async (subcommand?: string) => {
     case COMMANDS.burn:
       burn();
       break;
+    case COMMANDS.giveaway:
+      giveaway();
+      break;
   }
 };

src/sft-minter-fns.ts

@@ -27,6 +27,7 @@ import {
   ITransactionOnNetwork,
   EnumType,
   EnumValue,
+  Tuple,
 } from '@multiversx/sdk-core';
 import axios, { AxiosResponse } from 'axios';
 import { parseUserKey, UserSigner } from '@multiversx/sdk-wallet';
@@ -487,7 +488,7 @@ export const getMintTransaction = (
   }
 };
 
-export const getGiveawayTransaction = (
+export const getNftGiveawayTransaction = (
   caller: UserAddress,
   contract: SmartContract,
   baseGasLimit: number,
@@ -1351,6 +1352,28 @@ export const getSftMaxAmountPerAddress = (nonce: string) => {
   });
 };
 
+export const getSftGiveawayTransaction = (
+  caller: UserAddress,
+  contract: SmartContract,
+  baseGasLimit: number,
+  receivers: { address: string; nonce: string; amount: BigNumber }[]
+) => {
+  const mintsCount = receivers.length;
+  return contract.call({
+    func: new ContractFunction(giveawayFunctionName),
+    gasLimit: baseGasLimit + 600_000 * (mintsCount - 1),
+    chainID: shortChainId[chain],
+    args: receivers.map((receiver) =>
+      Tuple.fromItems([
+        new AddressValue(Address.fromBech32(receiver.address)),
+        new U64Value(new BigNumber(receiver.nonce, 16)),
+        new BigUIntValue(new BigNumber(receiver.amount).valueOf()),
+      ])
+    ),
+    caller,
+  });
+};
+
 export const getTheCollectionIdAfterIssuing = (
   transactionOnNetwork: ITransactionOnNetwork
 ) => {