@gala-chain/launchpad 1.0.14 → 1.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gala-chain/launchpad",
-  "version": "1.0.14",
+  "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;
+    }
   }
 }
 

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,6 +50,10 @@ export class LaunchpadSale extends ChainObject {
   @IsNotEmpty()
   public saleStatus: SaleStatus;
 
+  @IsOptional()
+  @IsInt()
+  public saleStartTime?: number;
+
   @IsNotEmpty()
   @ValidateNested()
   @Type(() => TokenInstanceKey)
@@ -104,7 +109,7 @@ export class LaunchpadSale extends ChainObject {
   @JSONSchema({
     description: "The decimals of the selling token."
   })
-  public static SELLING_TOKEN_DECIMALS = 18;
+  public static SELLING_TOKEN_DECIMALS = 9;
 
   @JSONSchema({
     description: "The decimals of the native token."
@@ -115,7 +120,8 @@ export class LaunchpadSale extends ChainObject {
     vaultAddress: UserAlias,
     sellingToken: TokenInstanceKey,
     reverseBondingCurveConfiguration: ReverseBondingCurveConfigurationChainObject | undefined,
-    saleOwner: UserAlias
+    saleOwner: UserAlias,
+    saleStartTime?: number | undefined
   ) {
     super();
 
@@ -125,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";

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

@@ -60,7 +60,7 @@ describe("buyWithNative", () => {
 
     launchpadGalaClass = plainToInstance(TokenClass, {
       ...launchpadgala.tokenClassPlain(),
-      decimals: 8
+      decimals: LaunchpadSale.NATIVE_TOKEN_DECIMALS
     });
 
     vaultAddress = asValidUserAlias(`service|${launchpadGalaClassKey.toStringKey()}$launchpad`);

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();
@@ -154,8 +162,8 @@ describe("buyWithNative", () => {
     const expectedResponse = plainToInstance(TradeResDto, {
       inputQuantity: "150",
       totalFees: "0",
-      totalTokenSold: "2101667.8890651635",
-      outputQuantity: "2101667.8890651635",
+      totalTokenSold: "2101667.889065163",
+      outputQuantity: "2101667.889065163",
       tokenName: "AUTOMATEDTESTCOIN",
       tradeType: "Buy",
       vaultAddress: "service|GALA$Unit$none$none$launchpad",
@@ -200,8 +208,8 @@ describe("buyWithNative", () => {
     const expectedResponse = plainToInstance(TradeResDto, {
       inputQuantity: "1000",
       totalFees: "320",
-      totalTokenSold: "3663321.3628130557",
-      outputQuantity: "3663321.3628130557",
+      totalTokenSold: "3663321.362813055",
+      outputQuantity: "3663321.362813055",
       tokenName: "AUTOMATEDTESTCOIN",
       tradeType: "Buy",
       vaultAddress: "service|GALA$Unit$none$none$launchpad",
@@ -256,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;
+}

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

@@ -143,7 +143,7 @@ describe("callMemeTokenOut", () => {
 
     // Then
     expect(response.Data).toMatchObject({
-      calculatedQuantity: "458291.30295364487969",
+      calculatedQuantity: "458291.302953644",
       extraFees: { reverseBondingCurve: "0", transactionFees: "0.00000000" }
     });
   });

package/src/chaincode/launchpad/createSale.ts

@@ -12,7 +12,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ConflictError, TokenInstanceKey, asValidUserAlias } from "@gala-chain/api";
+import { ConflictError, DefaultError, TokenInstanceKey, asValidUserAlias } from "@gala-chain/api";
 import {
   GalaChainContext,
   createTokenClass,
@@ -23,7 +23,13 @@ import {
 } from "@gala-chain/chaincode";
 import BigNumber from "bignumber.js";
 
-import { CreateSaleResDto, CreateTokenSaleDTO, LaunchpadSale, NativeTokenQuantityDto } from "../../api/types";
+import {
+  CreateSaleResDto,
+  CreateTokenSaleDTO,
+  LaunchpadSale,
+  NativeTokenQuantityDto,
+  SaleStatus
+} from "../../api/types";
 import { PreConditionFailedError } from "../../api/utils/error";
 import { buyWithNative } from "./buyWithNative";
 
@@ -131,6 +137,23 @@ export async function createSale(
     isSaleFinalized = tradeStatus.isFinalized;
   }
 
+  // handling the optional saleStartTime after the preBuyQuantity allows
+  // creators to still optionally specify a pre-buy even when a
+  // sale is marked Upcoming / Coming Soon.
+  // Otherwise `buyWithNative` would throw an error when validating the sale is active.
+  if (launchpadDetails.saleStartTime !== undefined) {
+    launchpad.saleStartTime = launchpadDetails.saleStartTime;
+
+    // handle edge case
+    // if a sale was immediately sold out with a pre-buy on creation,
+    // do not set the ended sale back to UPCOMING
+    if (launchpad.saleStatus !== SaleStatus.END) {
+      launchpad.saleStatus = SaleStatus.UPCOMING;
+    }
+
+    await putChainObject(ctx, launchpad);
+  }
+
   // Return the response object
   return {
     image: launchpadDetails.tokenImage,

package/src/chaincode/launchpad/sellExactToken.ts

@@ -58,7 +58,7 @@ export async function sellExactToken(
   const memeToken = sale.fetchSellingTokenInstanceKey();
 
   // Abort if the vault doesn't have enough native tokens to pay the user
-  if (new BigNumber(sellTokenDTO.tokenQuantity).isGreaterThan(nativeTokensLeftInVault)) {
+  if (nativeTokensPayout.isGreaterThan(nativeTokensLeftInVault)) {
     throw new ValidationFailedError("Not enough GALA in sale contract to carry out this operation.");
   }
 

package/src/chaincode/utils/launchpadSaleUtils.ts

@@ -35,6 +35,18 @@ export async function fetchAndValidateSale(
   if (sale === undefined) {
     throw new NotFoundError("Sale record not found.");
   }
+
+  if (sale.saleStatus === SaleStatus.UPCOMING) {
+    if (sale.saleStartTime !== undefined && sale.saleStartTime > 0 && sale.saleStartTime < ctx.txUnixTime) {
+      sale.saleStatus = SaleStatus.ONGOING;
+    } else {
+      throw new DefaultError(
+        `Upcoming: This sale is coming soon. ` +
+          `${sale.saleStartTime ? "Sale starts at: " + sale.saleStartTime + " Unix time." : "Start time TBD."}`
+      );
+    }
+  }
+
   if (sale.saleStatus === SaleStatus.END) {
     throw new DefaultError("This sale has already ended.");
   }