new: adjustable total supply with same bonding curve

src/api/types/LaunchpadDtos.ts

@@ -125,6 +125,12 @@ export class CreateTokenSaleDTO extends SubmitCallDTO {
   @Type(() => ReverseBondingCurveConfigurationDto)
   public reverseBondingCurveConfiguration?: ReverseBondingCurveConfigurationDto;
 
+  @IsOptional()
+  @IsNumber()
+  @Min(100)
+  @Max(100)
+  public adjustableSupplyMultiplier?: number;
+
   constructor(
     tokenName: string,
     tokenSymbol: string,
@@ -134,7 +140,8 @@ export class CreateTokenSaleDTO extends SubmitCallDTO {
     tokenCollection: string,
     tokenCategory: string,
     reverseBondingCurveConfiguration?: ReverseBondingCurveConfigurationDto,
-    saleStartTime?: number
+    saleStartTime?: number,
+    adjustableSupplyMultiplier?: number
   ) {
     super();
     this.tokenName = tokenName;
@@ -149,6 +156,10 @@ export class CreateTokenSaleDTO extends SubmitCallDTO {
     if (saleStartTime !== undefined) {
       this.saleStartTime = saleStartTime;
     }
+
+    if (adjustableSupplyMultiplier !== undefined) {
+      this.adjustableSupplyMultiplier = adjustableSupplyMultiplier;
+    }
   }
 }
 

src/api/types/LaunchpadSale.ts

@@ -23,7 +23,16 @@
 } from "@gala-chain/api";
 import BigNumber from "bignumber.js";
 import { Exclude, Type } from "class-transformer";
-import { IsInt, IsNotEmpty, IsOptional, IsPositive, IsString, ValidateNested } from "class-validator";
+import {
+  IsInt,
+  IsNotEmpty,
+  IsNumber,
+  IsOptional,
+  IsPositive,
+  IsString,
+  Min,
+  ValidateNested
+} from "class-validator";
 import { JSONSchema } from "class-validator-jsonschema";
 
 import { ReverseBondingCurveConfigurationChainObject } from "./LaunchpadDtos";
@@ -93,6 +102,15 @@
   @Type(() => ReverseBondingCurveConfigurationChainObject)
   public reverseBondingCurveConfiguration?: ReverseBondingCurveConfigurationChainObject;
 
+  /**
+   * Optional multiplier used to scale token output (both in bonding curve calculations and initial
+   * minting) while preserving the same economics and curve shape.
+   */
+  @IsOptional()
+  @IsNumber()
+  @Min(0)
+  public adjustableSupplyMultiplier?: number;
+
   @JSONSchema({
     description:
       "The market cap has been calculated using the bonding curve equations to approximate a specific final price."
@@ -121,15 +139,15 @@
     sellingToken: TokenInstanceKey,
     reverseBondingCurveConfiguration: ReverseBondingCurveConfigurationChainObject | undefined,
     saleOwner: UserAlias,
-    saleStartTime?: number | undefined
+    saleStartTime?: number | undefined,
+    adjustableSupplyMultiplier?: number
   ) {
     super();
 
     this.vaultAddress = vaultAddress;
     this.saleOwner = saleOwner;
 
     this.sellingToken = sellingToken;
-    this.sellingTokenQuantity = "1e+7";
 
     if (saleStartTime) {
       this.saleStartTime = saleStartTime;
@@ -141,9 +159,19 @@
       this.saleStatus = SaleStatus.ONGOING;
     }
 
-    this.basePrice = new BigNumber(LaunchpadSale.BASE_PRICE);
-    this.exponentFactor = new BigNumber("1166069000000");
-    this.maxSupply = new BigNumber("1e+7");
+    if (adjustableSupplyMultiplier !== undefined) {
+      this.adjustableSupplyMultiplier = adjustableSupplyMultiplier;
+      this.basePrice = new BigNumber(LaunchpadSale.BASE_PRICE).dividedBy(adjustableSupplyMultiplier);
+      this.exponentFactor = new BigNumber("1166069000000");
+      this.maxSupply = new BigNumber("1e+7").times(adjustableSupplyMultiplier);
+      this.sellingTokenQuantity = new BigNumber("1e+7").times(adjustableSupplyMultiplier).toString();
+    } else {
+      this.basePrice = new BigNumber(LaunchpadSale.BASE_PRICE);
+      this.exponentFactor = new BigNumber("1166069000000");
+      this.maxSupply = new BigNumber("1e+7");
+      this.sellingTokenQuantity = "1e+7";
+    }
+
     this.euler = new BigNumber("2.7182818284590452353602874713527");
 
     const nativeTokenInstance = new TokenInstanceKey();

src/chaincode/launchpad/buyExactToken.spec.ts

@@ -32,6 +32,7 @@ import {
   LaunchpadFeeConfig,
   LaunchpadSale,
   NativeTokenQuantityDto,
+  SaleStatus,
   TradeResDto
 } from "../../api/types";
 import { LaunchpadContract } from "../LaunchpadContract";
@@ -304,4 +305,236 @@ describe("buyWithNative", () => {
       )
     );
   });
+
+  test("Full sale purchase yields expected totals for 10 Million token sale", async () => {
+    // Given
+    salelaunchpadGalaBalance = plainToInstance(TokenBalance, {
+      ...launchpadgala.tokenBalance(),
+      owner: vaultAddress,
+      quantity: new BigNumber("0")
+    });
+
+    saleCurrencyBalance = plainToInstance(TokenBalance, {
+      ...currency.tokenBalance(),
+      owner: vaultAddress,
+      quantity: new BigNumber("2e+7")
+    });
+
+    userlaunchpadGalaBalance = plainToInstance(TokenBalance, {
+      ...launchpadgala.tokenBalance(),
+      owner: users.testUser1.identityKey,
+      quantity: new BigNumber("100000000")
+    });
+
+    userCurrencyBalance = plainToInstance(TokenBalance, {
+      ...currency.tokenBalance(),
+      owner: users.testUser1.identityKey,
+      quantity: new BigNumber("0")
+    });
+
+    const launchpadConfig = new LaunchpadFeeConfig(users.testUser2.identityKey, Number("0.001"), [
+      users.testUser2.identityKey
+    ]);
+
+    const userStartingGalaQuantity = userlaunchpadGalaBalance.getQuantityTotal();
+
+    const { ctx, contract, getWrites } = fixture(LaunchpadContract)
+      .registeredUsers(users.testUser1)
+      .savedState(
+        currencyClass,
+        currencyInstance,
+        launchpadConfig,
+        launchpadGalaClass,
+        launchpadGalaInstance,
+        sale,
+        salelaunchpadGalaBalance,
+        saleCurrencyBalance,
+        userlaunchpadGalaBalance,
+        userCurrencyBalance
+      );
+
+    // When
+    for (let i = 0; i < 50; i++) {
+      const dto = new ExactTokenQuantityDto(vaultAddress, new BigNumber("200000"));
+
+      dto.uniqueKey = randomUniqueKey();
+      dto.sign(users.testUser1.privateKey);
+
+      const buyTokenRes = await contract.BuyExactToken(ctx, dto);
+
+      expect(buyTokenRes).toEqual(transactionSuccess());
+    }
+
+    // Then
+    const saleKey = sale.getCompositeKey();
+    const userGalaBalanceKey = userlaunchpadGalaBalance.getCompositeKey();
+    const userMemeBalanceKey = userCurrencyBalance.getCompositeKey();
+
+    const writes = getWrites();
+
+    const finalSaleData = JSON.parse(writes[saleKey]);
+    const finalUserGalaBalanceData = JSON.parse(writes[userGalaBalanceKey]);
+    const finalUserMemeBalanceData = JSON.parse(writes[userMemeBalanceKey]);
+
+    expect(finalSaleData).toEqual(
+      expect.objectContaining({
+        saleStatus: SaleStatus.END
+      })
+    );
+
+    const finalUserGalaQuantity = new BigNumber(finalUserGalaBalanceData.quantity);
+    const finalUserMemeQuantity = new BigNumber(finalUserMemeBalanceData.quantity);
+
+    // user bought full sale quantity of ten million
+    expect(finalUserMemeQuantity).toEqual(new BigNumber("10000000"));
+    expect(userStartingGalaQuantity.minus(finalUserGalaQuantity)).toEqual(new BigNumber("1560577.53780865"));
+  });
+
+  test("Adjustable supply: single transaction", async () => {
+    // Given
+    const multiplier = 100;
+
+    sale = new LaunchpadSale(
+      vaultAddress,
+      currencyInstance.instanceKeyObj(),
+      undefined,
+      users.testUser1.identityKey,
+      undefined,
+      multiplier
+    );
+
+    const { ctx, contract } = fixture(LaunchpadContract)
+      .registeredUsers(users.testUser1)
+      .savedState(
+        currencyClass,
+        currencyInstance,
+        launchpadGalaClass,
+        launchpadGalaInstance,
+        sale,
+        salelaunchpadGalaBalance,
+        saleCurrencyBalance,
+        userlaunchpadGalaBalance,
+        userCurrencyBalance
+      );
+
+    const dto = new ExactTokenQuantityDto(vaultAddress, new BigNumber("500").times(multiplier));
+
+    dto.uniqueKey = randomUniqueKey();
+    dto.sign(users.testUser1.privateKey);
+
+    const expectedResponse = plainToInstance(TradeResDto, {
+      inputQuantity: "0.00825575",
+      totalFees: "0",
+      totalTokenSold: new BigNumber("500").times(multiplier).toString(),
+      outputQuantity: new BigNumber("500").times(multiplier).toString(),
+      tokenName: "AUTOMATEDTESTCOIN",
+      tradeType: "Buy",
+      uniqueKey: dto.uniqueKey,
+      vaultAddress: "service|GALA$Unit$none$none$launchpad",
+      userAddress: "client|testUser1",
+      isFinalized: false,
+      functionName: "BuyExactToken"
+    });
+
+    // When
+    const buyTokenRes = await contract.BuyExactToken(ctx, dto);
+
+    // Then
+    expect(buyTokenRes).toEqual(transactionSuccess(expectedResponse));
+  });
+
+  test("Adjustable supply: Full sale purchase yields expected totals for 1 billion token sale", async () => {
+    // Given
+    const multiplier = 100;
+
+    sale = new LaunchpadSale(
+      vaultAddress,
+      currencyInstance.instanceKeyObj(),
+      undefined,
+      users.testUser1.identityKey,
+      undefined,
+      multiplier
+    );
+
+    salelaunchpadGalaBalance = plainToInstance(TokenBalance, {
+      ...launchpadgala.tokenBalance(),
+      owner: vaultAddress,
+      quantity: new BigNumber("0")
+    });
+
+    saleCurrencyBalance = plainToInstance(TokenBalance, {
+      ...currency.tokenBalance(),
+      owner: vaultAddress,
+      quantity: new BigNumber("2e+7").times(multiplier)
+    });
+
+    userlaunchpadGalaBalance = plainToInstance(TokenBalance, {
+      ...launchpadgala.tokenBalance(),
+      owner: users.testUser1.identityKey,
+      quantity: new BigNumber("100000000")
+    });
+
+    userCurrencyBalance = plainToInstance(TokenBalance, {
+      ...currency.tokenBalance(),
+      owner: users.testUser1.identityKey,
+      quantity: new BigNumber("0")
+    });
+
+    const launchpadConfig = new LaunchpadFeeConfig(users.testUser2.identityKey, Number("0.001"), [
+      users.testUser2.identityKey
+    ]);
+
+    const userStartingGalaQuantity = userlaunchpadGalaBalance.getQuantityTotal();
+
+    const { ctx, contract, getWrites } = fixture(LaunchpadContract)
+      .registeredUsers(users.testUser1)
+      .savedState(
+        currencyClass,
+        currencyInstance,
+        launchpadConfig,
+        launchpadGalaClass,
+        launchpadGalaInstance,
+        sale,
+        salelaunchpadGalaBalance,
+        saleCurrencyBalance,
+        userlaunchpadGalaBalance,
+        userCurrencyBalance
+      );
+
+    // When
+    for (let i = 0; i < 50; i++) {
+      const dto = new ExactTokenQuantityDto(vaultAddress, new BigNumber("200000").times(multiplier));
+
+      dto.uniqueKey = randomUniqueKey();
+      dto.sign(users.testUser1.privateKey);
+
+      const buyTokenRes = await contract.BuyExactToken(ctx, dto);
+
+      expect(buyTokenRes).toEqual(transactionSuccess());
+    }
+
+    // Then
+    const saleKey = sale.getCompositeKey();
+    const userGalaBalanceKey = userlaunchpadGalaBalance.getCompositeKey();
+    const userMemeBalanceKey = userCurrencyBalance.getCompositeKey();
+
+    const writes = getWrites();
+
+    const finalSaleData = JSON.parse(writes[saleKey]);
+    const finalUserGalaBalanceData = JSON.parse(writes[userGalaBalanceKey]);
+    const finalUserMemeBalanceData = JSON.parse(writes[userMemeBalanceKey]);
+
+    expect(finalSaleData).toEqual(
+      expect.objectContaining({
+        saleStatus: SaleStatus.END
+      })
+    );
+
+    const finalUserGalaQuantity = new BigNumber(finalUserGalaBalanceData.quantity);
+    const finalUserMemeQuantity = new BigNumber(finalUserMemeBalanceData.quantity);
+
+    // user bought full sale quantity of ten million
+    expect(finalUserMemeQuantity).toEqual(new BigNumber("10000000").times(multiplier));
+    expect(userStartingGalaQuantity.minus(finalUserGalaQuantity)).toEqual(new BigNumber("1560577.53780865"));
+  });
 });