@gala-chain/launchpad 1.0.13 → 1.0.14

package/src/chaincode/launchpad/sellWithNative.ts

@@ -22,11 +22,11 @@ import {
 } from "@gala-chain/chaincode";
 import BigNumber from "bignumber.js";
 
-import { LaunchpadSale, NativeTokenQuantityDto, TradeResDto } from "../../api/types";
+import { NativeTokenQuantityDto, TradeResDto } from "../../api/types";
 import { SlippageToleranceExceededError } from "../../api/utils/error";
-import { fetchAndValidateSale, fetchLaunchpadFeeAddress } from "../utils";
+import { fetchAndValidateSale } from "../utils";
 import { callMemeTokenIn } from "./callMemeTokenIn";
-import { payReverseBondingCurveFee } from "./fees";
+import { payReverseBondingCurveFee, transferTransactionFees } from "./fees";
 
 /**
  * Executes a sale of tokens using native tokens (e.g., GALA) in exchange for the specified token amount.
@@ -52,7 +52,7 @@ export async function sellWithNative(
   sellTokenDTO: NativeTokenQuantityDto
 ): Promise<TradeResDto> {
   // Fetch and validate the sale object
-  const sale: LaunchpadSale = await fetchAndValidateSale(ctx, sellTokenDTO.vaultAddress);
+  const sale = await fetchAndValidateSale(ctx, sellTokenDTO.vaultAddress);
 
   const { collection, category, type, additionalKey } = sale.sellingToken;
   const sellingTokenCompositeKey = TokenClass.getCompositeKeyFromParts(TokenClass.INDEX_KEY, [
@@ -66,22 +66,23 @@ export async function sellWithNative(
   const nativeTokensLeftInVault = new BigNumber(sale.nativeTokenQuantity);
 
   // Cap nativeTokenQuantity to the vault balance if the requested amount exceeds it
-  if (nativeTokensLeftInVault.comparedTo(sellTokenDTO.nativeTokenQuantity) < 0) {
+  if (nativeTokensLeftInVault.isLessThan(sellTokenDTO.nativeTokenQuantity)) {
     throw new ValidationFailedError("Not enough GALA in sale contract to carry out this operation.");
   }
 
   // Calculate how many tokens need to be sold to get the requested native amount
   const callMemeTokenInResult = await callMemeTokenIn(ctx, sellTokenDTO);
-  const transactionFees = callMemeTokenInResult.extraFees.transactionFees;
+  const transactionFees = callMemeTokenInResult.extraFees.transactionFees; // transaction fees
+  const nativeTokensPayout = new BigNumber(callMemeTokenInResult.originalQuantity); // number of native tokens user wants to receive
   const tokensToSell = new BigNumber(callMemeTokenInResult.calculatedQuantity).decimalPlaces(
     sellingToken.decimals
-  );
+  ); // number of tokens user needs to sell
 
   const nativeToken = sale.fetchNativeTokenInstanceKey();
   const memeToken = sale.fetchSellingTokenInstanceKey();
 
   // Enforce slippage tolerance
-  if (sellTokenDTO.expectedToken && sellTokenDTO.expectedToken.comparedTo(tokensToSell) < 0) {
+  if (sellTokenDTO.expectedToken && sellTokenDTO.expectedToken.isLessThan(tokensToSell)) {
     throw new SlippageToleranceExceededError(
       `expected ${sellTokenDTO.expectedToken.toString()}, but at least ${tokensToSell.toString()} tokens are required. Increase the expected amount or adjust your slippage tolerance.`
     );
@@ -92,22 +93,12 @@ export async function sellWithNative(
   await payReverseBondingCurveFee(
     ctx,
     sale,
-    sellTokenDTO.nativeTokenQuantity,
+    nativeTokensPayout,
     sellTokenDTO.extraFees?.maxAcceptableReverseBondingCurveFee
   );
 
   // Transfer launchpad transaction fees if applicable
-  const launchpadFeeAddressConfiguration = await fetchLaunchpadFeeAddress(ctx);
-  if (launchpadFeeAddressConfiguration && transactionFees) {
-    await transferToken(ctx, {
-      from: ctx.callingUser,
-      to: launchpadFeeAddressConfiguration.feeAddress,
-      tokenInstanceKey: nativeToken,
-      quantity: new BigNumber(transactionFees),
-      allowancesToUse: [],
-      authorizedOnBehalf: undefined
-    });
-  }
+  await transferTransactionFees(ctx, sale, transactionFees, nativeToken);
 
   // Send meme tokens from user to vault
   await transferToken(ctx, {
@@ -124,7 +115,7 @@ export async function sellWithNative(
     from: sellTokenDTO.vaultAddress,
     to: ctx.callingUser,
     tokenInstanceKey: nativeToken,
-    quantity: sellTokenDTO.nativeTokenQuantity,
+    quantity: nativeTokensPayout,
     allowancesToUse: [],
     authorizedOnBehalf: {
       callingOnBehalf: sellTokenDTO.vaultAddress,
@@ -133,7 +124,7 @@ export async function sellWithNative(
   });
 
   // Update internal sale tracking
-  sale.sellToken(tokensToSell, sellTokenDTO.nativeTokenQuantity);
+  sale.sellToken(tokensToSell, nativeTokensPayout);
   await putChainObject(ctx, sale);
 
   const token = await fetchTokenClass(ctx, sale.sellingToken);
@@ -142,7 +133,7 @@ export async function sellWithNative(
     totalFees: new BigNumber(transactionFees)
       .plus(sellTokenDTO.extraFees?.maxAcceptableReverseBondingCurveFee ?? 0)
       .toFixed(),
-    outputQuantity: sellTokenDTO.nativeTokenQuantity.toFixed(),
+    outputQuantity: nativeTokensPayout.toFixed(),
     tokenName: token.name,
     tradeType: "Sell",
     vaultAddress: sellTokenDTO.vaultAddress,

package/src/chaincode/test/launchpadgala.ts

@@ -26,6 +26,8 @@ import { users } from "@gala-chain/test";
 import { createInstanceFn, createPlainFn } from "@gala-chain/test/lib/src/data/utils";
 import BigNumber from "bignumber.js";
 
+import { LaunchpadSale } from "../../api/types";
+
 process.env.LAUNCHPAD_GALA_CLASS_COLLECTION = process.env.LAUNCHPAD_GALA_CLASS_COLLECTION ?? "GALA";
 process.env.LAUNCHPAD_GALA_CLASS_CATEGORY = process.env.LAUNCHPAD_GALA_CLASS_CATEGORY ?? "Unit";
 process.env.LAUNCHPAD_GALA_CLASS_TYPE = process.env.LAUNCHPAD_GALA_CLASS_TYPE ?? "none";
@@ -41,7 +43,7 @@ const tokenClassKeyPlain = createPlainFn({
 const tokenClassPlain = createPlainFn({
   ...tokenClassKeyPlain(),
   description: "Generated via automated test suite.",
-  decimals: 8, // This codebase currently hard-codes 8 as NATIVE_TOKEN_DECIMALS
+  decimals: LaunchpadSale.NATIVE_TOKEN_DECIMALS,
   image: "https://app.gala.games/test-image-placeholder-url.png",
   isNonFungible: false,
   maxCapacity: new BigNumber(100000000000000),

package/src/chaincode/utils/launchpadSaleUtils.ts

@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 import { ChainError, DefaultError, ErrorCode, NotFoundError } from "@gala-chain/api";
-import { GalaChainContext, getObjectByKey } from "@gala-chain/chaincode";
+import { GalaChainContext, fetchTokenClass, getObjectByKey } from "@gala-chain/chaincode";
 import Decimal from "decimal.js";
 
 import { LaunchpadFeeConfig, LaunchpadSale, SaleStatus } from "../../api/types";
@@ -66,3 +66,15 @@ export async function fetchLaunchpadFeeAddress(
 
   return platformFeeAddress;
 }
+
+export async function fetchTokenDecimals(
+  ctx: GalaChainContext,
+  sale: LaunchpadSale
+): Promise<{ sellingTokenDecimals: number; nativeTokenDecimals: number }> {
+  const sellingToken = await fetchTokenClass(ctx, sale.fetchSellingTokenInstanceKey());
+  const nativeToken = await fetchTokenClass(ctx, sale.fetchNativeTokenInstanceKey());
+  return {
+    sellingTokenDecimals: sellingToken.decimals,
+    nativeTokenDecimals: nativeToken.decimals
+  };
+}

package/src/cli.ts

@@ -19,6 +19,8 @@ import type { ContractAPI } from "@gala-chain/api";
 import type { GalaContract } from "@gala-chain/chaincode";
 import "fabric-shim/cli";
 import fs from "fs";
+import os from "os";
+import path from "path";
 
 const [, , customCommand] = process.argv;
 if (customCommand === "get-contract-names") {
@@ -27,7 +29,7 @@ if (customCommand === "get-contract-names") {
 }
 
 if (customCommand === "get-contract-api") {
-  saveContractAPI("/tmp/contract-api.json");
+  saveContractAPI(path.join(os.tmpdir(), "contract-api.json")); // output is stored at the operating system's default directory
   process.exit(0);
 }