@gala-chain/launchpad 1.0.13 → 1.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gala-chain/launchpad",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "description": "GalaChain Launchpad Chaincode",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",

package/src/api/types/LaunchpadDtos.ts

@@ -27,6 +27,7 @@ import {
   ArrayNotEmpty,
   IsArray,
   IsBoolean,
+  IsInt,
   IsNotEmpty,
   IsNumber,
   IsOptional,
@@ -115,6 +116,10 @@ export class CreateTokenSaleDTO extends SubmitCallDTO {
   @IsOptional()
   public twitterUrl?: string;
 
+  @IsOptional()
+  @IsInt()
+  public saleStartTime?: number;
+
   @IsOptional()
   @ValidateNested()
   @Type(() => ReverseBondingCurveConfigurationDto)
@@ -128,7 +133,8 @@ export class CreateTokenSaleDTO extends SubmitCallDTO {
     preBuyQuantity: BigNumber,
     tokenCollection: string,
     tokenCategory: string,
-    reverseBondingCurveConfiguration?: ReverseBondingCurveConfigurationDto
+    reverseBondingCurveConfiguration?: ReverseBondingCurveConfigurationDto,
+    saleStartTime?: number
   ) {
     super();
     this.tokenName = tokenName;
@@ -139,6 +145,10 @@ export class CreateTokenSaleDTO extends SubmitCallDTO {
     this.tokenCollection = tokenCollection;
     this.tokenCategory = tokenCategory;
     this.reverseBondingCurveConfiguration = reverseBondingCurveConfiguration;
+
+    if (saleStartTime !== undefined) {
+      this.saleStartTime = saleStartTime;
+    }
   }
 }
 
@@ -369,6 +379,10 @@ export class TradeCalculationResFeesDto {
 }
 
 export class TradeCalculationResDto {
+  @IsNotEmpty()
+  @IsString()
+  public originalQuantity: string;
+
   @IsNotEmpty()
   @IsString()
   public calculatedQuantity: string;

package/src/api/types/LaunchpadSale.ts

@@ -23,12 +23,13 @@ import {
 } from "@gala-chain/api";
 import BigNumber from "bignumber.js";
 import { Exclude, Type } from "class-transformer";
-import { IsNotEmpty, IsOptional, IsString, ValidateNested } from "class-validator";
+import { IsInt, IsNotEmpty, IsOptional, IsPositive, IsString, ValidateNested } from "class-validator";
 import { JSONSchema } from "class-validator-jsonschema";
 
 import { ReverseBondingCurveConfigurationChainObject } from "./LaunchpadDtos";
 
 export enum SaleStatus {
+  UPCOMING = "Upcoming",
   ONGOING = "Ongoing",
   END = "Finished"
 }
@@ -49,12 +50,18 @@ export class LaunchpadSale extends ChainObject {
   @IsNotEmpty()
   public saleStatus: SaleStatus;
 
-  @Type(() => TokenInstanceKey)
+  @IsOptional()
+  @IsInt()
+  public saleStartTime?: number;
+
   @IsNotEmpty()
+  @ValidateNested()
+  @Type(() => TokenInstanceKey)
   public sellingToken: TokenInstanceKey;
 
-  @Type(() => TokenInstanceKey)
   @IsNotEmpty()
+  @ValidateNested()
+  @Type(() => TokenInstanceKey)
   public nativeToken: TokenInstanceKey;
 
   @IsString()
@@ -99,11 +106,22 @@ export class LaunchpadSale extends ChainObject {
   })
   public static BASE_PRICE = "16506671506650";
 
+  @JSONSchema({
+    description: "The decimals of the selling token."
+  })
+  public static SELLING_TOKEN_DECIMALS = 9;
+
+  @JSONSchema({
+    description: "The decimals of the native token."
+  })
+  public static NATIVE_TOKEN_DECIMALS = 8;
+
   constructor(
     vaultAddress: UserAlias,
     sellingToken: TokenInstanceKey,
     reverseBondingCurveConfiguration: ReverseBondingCurveConfigurationChainObject | undefined,
-    saleOwner: UserAlias
+    saleOwner: UserAlias,
+    saleStartTime?: number | undefined
   ) {
     super();
 
@@ -113,11 +131,20 @@ export class LaunchpadSale extends ChainObject {
     this.sellingToken = sellingToken;
     this.sellingTokenQuantity = "1e+7";
 
+    if (saleStartTime) {
+      this.saleStartTime = saleStartTime;
+    }
+
+    if (this.saleStartTime !== undefined && this.saleStartTime > 0) {
+      this.saleStatus = SaleStatus.UPCOMING;
+    } else {
+      this.saleStatus = SaleStatus.ONGOING;
+    }
+
     this.basePrice = new BigNumber(LaunchpadSale.BASE_PRICE);
     this.exponentFactor = new BigNumber("1166069000000");
     this.maxSupply = new BigNumber("1e+7");
     this.euler = new BigNumber("2.7182818284590452353602874713527");
-    this.saleStatus = SaleStatus.ONGOING;
 
     const nativeTokenInstance = new TokenInstanceKey();
     nativeTokenInstance.collection = "GALA";
@@ -165,11 +192,6 @@ export class LaunchpadSale extends ChainObject {
     return nativeTokenInVault.toString();
   }
 
-  public fetchBasePrice() {
-    const basePriceBigNumber = new BigNumber(this.basePrice);
-    return basePriceBigNumber.toString();
-  }
-
   public finalizeSale() {
     this.saleStatus = SaleStatus.END;
     this.nativeTokenQuantity = "0";

package/src/chaincode/LaunchpadContract.ts

@@ -137,7 +137,7 @@ export class LaunchpadContract extends GalaContract {
   @Submit({
     in: ConfigureLaunchpadFeeAddressDto,
     out: LaunchpadFeeConfig,
-    allowedOrgs: ["CuratorOrg"]
+    allowedOrgs: [process.env.CURATOR_ORG_MSP ?? "CuratorOrg"]
   })
   public async ConfigureLaunchpadFeeAddress(
     ctx: GalaChainContext,
@@ -149,7 +149,7 @@ export class LaunchpadContract extends GalaContract {
   @Submit({
     in: FinalizeTokenAllocationDto,
     out: LaunchpadFinalizeFeeAllocation,
-    allowedOrgs: ["CuratorOrg"]
+    allowedOrgs: [process.env.CURATOR_ORG_MSP ?? "CuratorOrg"]
   })
   public async FinalizeTokenAllocation(
     ctx: GalaChainContext,
@@ -209,7 +209,7 @@ export class LaunchpadContract extends GalaContract {
   @Evaluate({
     in: ChainCallDTO,
     out: LaunchpadFeeConfig,
-    allowedOrgs: ["CuratorOrg"]
+    allowedOrgs: [process.env.CURATOR_ORG_MSP ?? "CuratorOrg"]
   })
   public async FetchLaunchpadFeeConfig(
     ctx: GalaChainContext,

package/src/chaincode/launchpad/buyExactToken.spec.ts

@@ -23,8 +23,7 @@ import {
   asValidUserAlias,
   randomUniqueKey
 } from "@gala-chain/api";
-import { InvalidDecimalError } from "@gala-chain/chaincode";
-import { currency, fixture, transactionError, transactionSuccess, users } from "@gala-chain/test";
+import { currency, fixture, transactionSuccess, users } from "@gala-chain/test";
 import BigNumber from "bignumber.js";
 import { plainToInstance } from "class-transformer";
 
@@ -61,7 +60,7 @@ describe("buyWithNative", () => {
 
     launchpadGalaClass = plainToInstance(TokenClass, {
       ...launchpadgala.tokenClassPlain(),
-      decimals: 8
+      decimals: LaunchpadSale.NATIVE_TOKEN_DECIMALS
     });
 
     vaultAddress = asValidUserAlias(`service|${launchpadGalaClassKey.toStringKey()}$launchpad`);
@@ -128,40 +127,6 @@ describe("buyWithNative", () => {
     expect(buyTokenRes).toEqual(transactionSuccess());
   });
 
-  it("should reject buy when meme token has 0 decimals and input dto contains fractional quantity", async () => {
-    // Given - Setup token with 0 decimals to force decimal precision error
-    const zeroDecimalCurrencyClass = plainToInstance(TokenClass, {
-      ...currency.tokenClassPlain(),
-      decimals: 0 // Integer-only token
-    });
-
-    const { ctx, contract } = fixture(LaunchpadContract)
-      .registeredUsers(users.testUser1)
-      .savedState(
-        zeroDecimalCurrencyClass,
-        currencyInstance,
-        launchpadGalaClass,
-        launchpadGalaInstance,
-        sale,
-        salelaunchpadGalaBalance,
-        saleCurrencyBalance,
-        userlaunchpadGalaBalance,
-        userCurrencyBalance
-      );
-
-    const dto = new ExactTokenQuantityDto(vaultAddress, new BigNumber("500.555"));
-    dto.uniqueKey = randomUniqueKey();
-    dto.sign(users.testUser1.privateKey);
-
-    // When
-    const buyTokenRes = await contract.BuyExactToken(ctx, dto);
-
-    // Then
-    expect(buyTokenRes).toEqual(
-      transactionError(new InvalidDecimalError(dto.tokenQuantity, zeroDecimalCurrencyClass.decimals))
-    );
-  });
-
   test("User should be able to buy exact tokens, without fee configured", async () => {
     // Given
     const { ctx, contract } = fixture(LaunchpadContract)
@@ -185,7 +150,7 @@ describe("buyWithNative", () => {
 
     const expectedResponse = plainToInstance(TradeResDto, {
       inputQuantity: "0.00825575",
-      totalFees: "0.00000000",
+      totalFees: "0",
       totalTokenSold: "500",
       outputQuantity: "500",
       tokenName: "AUTOMATEDTESTCOIN",

package/src/chaincode/launchpad/buyExactToken.ts

@@ -12,20 +12,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ValidationFailedError } from "@gala-chain/api";
-import {
-  GalaChainContext,
-  fetchOrCreateBalance,
-  fetchTokenClass,
-  putChainObject,
-  transferToken
-} from "@gala-chain/chaincode";
+import { GalaChainContext, fetchTokenClass, putChainObject, transferToken } from "@gala-chain/chaincode";
 import BigNumber from "bignumber.js";
 
-import { ExactTokenQuantityDto, LaunchpadSale, TradeResDto } from "../../api/types";
+import { ExactTokenQuantityDto, TradeResDto } from "../../api/types";
 import { SlippageToleranceExceededError } from "../../api/utils/error";
-import { fetchAndValidateSale, fetchLaunchpadFeeAddress } from "../utils";
+import { fetchAndValidateSale } from "../utils";
 import { callNativeTokenIn } from "./callNativeTokenIn";
+import { transferTransactionFees } from "./fees";
 import { finalizeSale } from "./finaliseSale";
 
 /**
@@ -52,67 +46,39 @@ export async function buyExactToken(
 
   // Fetch and validate the sale based on the provided vault address
   const sale = await fetchAndValidateSale(ctx, buyTokenDTO.vaultAddress);
-  const tokenLeftInVault = new BigNumber(sale.sellingTokenQuantity);
+  const tokensLeftInVault = new BigNumber(sale.sellingTokenQuantity);
 
   // Calculate the required amount of native tokens to buy the specified token amount
-  const callNativeTokenInResult1 = await callNativeTokenIn(ctx, buyTokenDTO);
-  let transactionFees = callNativeTokenInResult1.extraFees.transactionFees;
-  let nativeTokensToBuy = new BigNumber(callNativeTokenInResult1.calculatedQuantity);
+  const callNativeTokenInResult = await callNativeTokenIn(ctx, buyTokenDTO);
+  const tokensToBuy = new BigNumber(callNativeTokenInResult.originalQuantity); // number of tokens user wants to buy
+  const nativeTokensRequired = new BigNumber(callNativeTokenInResult.calculatedQuantity); // number of native tokens required to buy the tokens
+  const transactionFees = new BigNumber(callNativeTokenInResult.extraFees.transactionFees); // transaction fees
+
   const nativeToken = sale.fetchNativeTokenInstanceKey();
   const memeToken = sale.fetchSellingTokenInstanceKey();
 
-  // If the requested token amount exceeds what's available, adjust it and recalculate native tokens needed
-  if (tokenLeftInVault.lte(buyTokenDTO.tokenQuantity)) {
-    buyTokenDTO.tokenQuantity = tokenLeftInVault;
-    const callNativeTokenInResult2 = await callNativeTokenIn(ctx, buyTokenDTO);
-    nativeTokensToBuy = new BigNumber(callNativeTokenInResult2.calculatedQuantity);
-    transactionFees = callNativeTokenInResult2.extraFees.transactionFees;
-    isSaleFinalized = true;
-  }
-
-  // Check if the native tokens used exceed the market cap, finalizing the sale if true
-  if (
-    nativeTokensToBuy
-      .plus(new BigNumber(sale.nativeTokenQuantity))
-      .gte(new BigNumber(LaunchpadSale.MARKET_CAP))
-  ) {
+  // If the requested token amount exceeds what's available, finalise the sale
+  // Token amounts have been adjusted in the callNativeTokenIn function if they exceed the total supply
+  if (tokensLeftInVault.isLessThanOrEqualTo(buyTokenDTO.tokenQuantity)) {
     isSaleFinalized = true;
   }
 
   // Ensure the expected native token amount is not less than the actual amount required
-  if (buyTokenDTO.expectedNativeToken && buyTokenDTO.expectedNativeToken.comparedTo(nativeTokensToBuy) < 0) {
+  if (buyTokenDTO.expectedNativeToken && buyTokenDTO.expectedNativeToken.isLessThan(nativeTokensRequired)) {
     throw new SlippageToleranceExceededError(
-      `expected ${buyTokenDTO.expectedNativeToken.toString()}, but at least ${nativeTokensToBuy.toString()} are required to complete this operation. Increase the expected amount or adjust your slippage tolerance.`
+      `expected ${buyTokenDTO.expectedNativeToken.toString()}, but at least ${nativeTokensRequired.toString()} are required to complete this operation. Increase the expected amount or adjust your slippage tolerance.`
     );
   }
 
   // Transfer transaction fees
-  const launchpadFeeAddressConfiguration = await fetchLaunchpadFeeAddress(ctx);
-  if (launchpadFeeAddressConfiguration && transactionFees) {
-    const totalRequired = nativeTokensToBuy.plus(new BigNumber(transactionFees));
-
-    const buyerBalance = await fetchOrCreateBalance(ctx, ctx.callingUser, sale.nativeToken);
-    if (buyerBalance.getQuantityTotal().lt(totalRequired)) {
-      throw new ValidationFailedError(
-        `Insufficient balance: Total amount required including fee is ${totalRequired}`
-      );
-    }
-    await transferToken(ctx, {
-      from: ctx.callingUser,
-      to: launchpadFeeAddressConfiguration.feeAddress,
-      tokenInstanceKey: nativeToken,
-      quantity: new BigNumber(transactionFees),
-      allowancesToUse: [],
-      authorizedOnBehalf: undefined
-    });
-  }
+  await transferTransactionFees(ctx, sale, transactionFees, nativeToken, nativeTokensRequired);
 
   // Transfer native tokens from the buyer to the vault
   await transferToken(ctx, {
     from: ctx.callingUser,
     to: buyTokenDTO.vaultAddress,
     tokenInstanceKey: nativeToken,
-    quantity: nativeTokensToBuy,
+    quantity: nativeTokensRequired,
     allowancesToUse: [],
     authorizedOnBehalf: undefined
   });
@@ -122,7 +88,7 @@ export async function buyExactToken(
     from: buyTokenDTO.vaultAddress,
     to: ctx.callingUser,
     tokenInstanceKey: memeToken,
-    quantity: buyTokenDTO.tokenQuantity,
+    quantity: tokensToBuy,
     allowancesToUse: [],
     authorizedOnBehalf: {
       callingOnBehalf: buyTokenDTO.vaultAddress,
@@ -131,7 +97,7 @@ export async function buyExactToken(
   });
 
   // Update the sale record with the purchased token details
-  sale.buyToken(buyTokenDTO.tokenQuantity, nativeTokensToBuy);
+  sale.buyToken(tokensToBuy, nativeTokensRequired);
   await putChainObject(ctx, sale);
 
   // If the sale is finalized, create a V3 pool and add liquidity
@@ -142,9 +108,9 @@ export async function buyExactToken(
   // Return the updated balance response
   const token = await fetchTokenClass(ctx, sale.sellingToken);
   return {
-    inputQuantity: nativeTokensToBuy.toFixed(),
-    totalFees: transactionFees,
-    outputQuantity: buyTokenDTO.tokenQuantity.toFixed(),
+    inputQuantity: nativeTokensRequired.toFixed(),
+    totalFees: transactionFees.toFixed(),
+    outputQuantity: tokensToBuy.toFixed(),
     tokenName: token.name,
     tradeType: "Buy",
     vaultAddress: buyTokenDTO.vaultAddress,

package/src/chaincode/launchpad/buyWithNative.spec.ts

@@ -27,7 +27,13 @@ import { currency, fixture, transactionError, transactionSuccess, users } from "
 import BigNumber from "bignumber.js";
 import { plainToInstance } from "class-transformer";
 
-import { LaunchpadFeeConfig, LaunchpadSale, NativeTokenQuantityDto, TradeResDto } from "../../api/types";
+import {
+  ExactTokenQuantityDto,
+  LaunchpadFeeConfig,
+  LaunchpadSale,
+  NativeTokenQuantityDto,
+  TradeResDto
+} from "../../api/types";
 import { LaunchpadContract } from "../LaunchpadContract";
 import launchpadgala from "../test/launchpadgala";
 
@@ -46,13 +52,15 @@ describe("buyWithNative", () => {
 
   beforeEach(() => {
     //Given
-    currencyClass = currency.tokenClass();
+    currencyClass = plainToInstance(TokenClass, {
+      ...currency.tokenClassPlain(),
+      decimals: LaunchpadSale.SELLING_TOKEN_DECIMALS
+    });
     currencyInstance = currency.tokenInstance();
-    launchpadGalaClass = launchpadgala.tokenClass();
 
     launchpadGalaClass = plainToInstance(TokenClass, {
       ...launchpadgala.tokenClassPlain(),
-      decimals: 18
+      decimals: LaunchpadSale.NATIVE_TOKEN_DECIMALS
     });
 
     launchpadGalaInstance = launchpadgala.tokenInstance();
@@ -130,41 +138,6 @@ describe("buyWithNative", () => {
     );
   });
 
-  it("should reject buy when input dto has higher fractional precision than GALA TokenClass", async () => {
-    // Given
-    const zeroDecimalLaunchpadClass = plainToInstance(TokenClass, {
-      ...launchpadgala.tokenClassPlain(),
-      decimals: 0 // Integer-only meme token
-    });
-
-    const { ctx, contract } = fixture(LaunchpadContract)
-      .registeredUsers(users.testUser1)
-      .savedState(
-        currencyInstance,
-        currencyClass,
-        zeroDecimalLaunchpadClass,
-        launchpadGalaInstance,
-        sale,
-        salelaunchpadGalaBalance,
-        saleCurrencyBalance,
-        userlaunchpadGalaBalance,
-        userCurrencyBalance
-      );
-
-    // Use a native token amount that will produce fractional meme tokens from bonding curve
-    const dto = new NativeTokenQuantityDto(vaultAddress, new BigNumber("0.01"));
-    dto.uniqueKey = randomUniqueKey();
-    dto.sign(users.testUser1.privateKey);
-
-    // When
-    const buyTokenRes = await contract.BuyWithNative(ctx, dto);
-
-    // Then - Expect error due to decimal precision mismatch
-    expect(buyTokenRes).toEqual(
-      transactionError(new InvalidDecimalError(dto.nativeTokenQuantity, zeroDecimalLaunchpadClass.decimals))
-    );
-  });
-
   test("User buys tokens by providing native gala, without fee needing to be configured", async () => {
     //Given
     const { ctx, contract } = fixture(LaunchpadContract)
@@ -188,9 +161,9 @@ describe("buyWithNative", () => {
 
     const expectedResponse = plainToInstance(TradeResDto, {
       inputQuantity: "150",
-      totalFees: "0.00000000",
-      totalTokenSold: "2101667.8890651635",
-      outputQuantity: "2101667.8890651635",
+      totalFees: "0",
+      totalTokenSold: "2101667.889065163",
+      outputQuantity: "2101667.889065163",
       tokenName: "AUTOMATEDTESTCOIN",
       tradeType: "Buy",
       vaultAddress: "service|GALA$Unit$none$none$launchpad",
@@ -234,9 +207,9 @@ describe("buyWithNative", () => {
 
     const expectedResponse = plainToInstance(TradeResDto, {
       inputQuantity: "1000",
-      totalFees: "320.00000000",
-      totalTokenSold: "3663321.3628130557",
-      outputQuantity: "3663321.3628130557",
+      totalFees: "320",
+      totalTokenSold: "3663321.362813055",
+      outputQuantity: "3663321.362813055",
       tokenName: "AUTOMATEDTESTCOIN",
       tradeType: "Buy",
       vaultAddress: "service|GALA$Unit$none$none$launchpad",
@@ -291,4 +264,91 @@ describe("buyWithNative", () => {
       )
     );
   });
+
+  it("should return inverse native tokens when buying and selling tokens", async () => {
+    //Given
+    salelaunchpadGalaBalance.subtractQuantity(new BigNumber("1e+7"), 0);
+    saleCurrencyBalance.addQuantity(new BigNumber("1e+7"));
+    userlaunchpadGalaBalance.addQuantity(new BigNumber("1e+7"));
+    const { ctx, contract } = fixture(LaunchpadContract)
+      .registeredUsers(users.testUser1)
+      .savedState(
+        currencyClass,
+        currencyInstance,
+        launchpadGalaClass,
+        launchpadGalaInstance,
+        sale,
+        salelaunchpadGalaBalance,
+        saleCurrencyBalance,
+        userlaunchpadGalaBalance,
+        userCurrencyBalance
+      );
+
+    const arr: string[] = [
+      "31.27520343",
+      "100.3731319",
+      "322.1326962",
+      "1033.837164",
+      "3317.947211",
+      "10648.46001",
+      "34174.65481",
+      "109678.4915",
+      "351996.8694",
+      "1129679.88999"
+    ];
+
+    const sellingArr: string[] = [];
+    const sellArr: string[] = [
+      "1000000.000060721",
+      "1000000.000017497",
+      "999999.999868935",
+      "1000000.000187964",
+      "999999.999879254",
+      "999999.999929098",
+      "1000000.000096442",
+      "999999.999800915",
+      "1000000.000112742",
+      "999999.000293124"
+    ];
+
+    // When - Buy tokens using native token amounts from arr
+    for (let i = 0; i < arr.length; i++) {
+      let nativeCoins = Number(arr[i]);
+      nativeCoins = roundToDecimal(nativeCoins, 8);
+
+      const dto = new NativeTokenQuantityDto(vaultAddress, new BigNumber(nativeCoins));
+      dto.uniqueKey = randomUniqueKey();
+      dto.sign(users.testUser1.privateKey);
+
+      const buyTokenRes = await contract.BuyWithNative(ctx, dto);
+      expect(buyTokenRes).toEqual(transactionSuccess());
+    }
+
+    // When - Sell tokens back in reverse order
+    for (let i = sellArr.length - 1; i >= 0; i--) {
+      const sellDto = new ExactTokenQuantityDto(vaultAddress, new BigNumber(sellArr[i]));
+      sellDto.uniqueKey = randomUniqueKey();
+      sellDto.sign(users.testUser1.privateKey);
+
+      const sellTokenRes = await contract.SellExactToken(ctx, sellDto);
+      expect(sellTokenRes).toEqual(transactionSuccess());
+      sellingArr.push(sellTokenRes.Data?.outputQuantity || "0");
+    }
+
+    // Then - Verify sellingArr is the inverse of arr with the extra ""
+    const expectedSellingArr = [...arr].reverse();
+
+    // Compare each element, checking that values match up to 4 decimal places
+    const tolerance = new BigNumber("0.0001"); // 4 decimal places tolerance
+    for (let i = 1; i < sellingArr.length; i++) {
+      const sellingValue = new BigNumber(sellingArr[i]);
+      const expectedValue = new BigNumber(expectedSellingArr[i]);
+      const difference = sellingValue.minus(expectedValue).abs();
+      expect(difference.isLessThanOrEqualTo(tolerance)).toBe(true);
+    }
+  });
 });
+function roundToDecimal(value, decimals) {
+  const factor = Math.pow(10, decimals);
+  return Math.round(value * factor) / factor;
+}