@gala-chain/launchpad 1.0.0

package/src/api/types/LaunchpadDtos.ts

@@ -0,0 +1,362 @@
+/*
+ * Copyright (c) Gala Games Inc. All rights reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import {
+  BigNumberProperty,
+  ChainCallDTO,
+  ChainObject,
+  IsUserAlias,
+  SubmitCallDTO,
+  TokenBalance,
+  UserAlias
+} from "@gala-chain/api";
+import BigNumber from "bignumber.js";
+import { Type } from "class-transformer";
+import {
+  IsBoolean,
+  IsNotEmpty,
+  IsNumber,
+  IsOptional,
+  IsString,
+  Max,
+  Min,
+  ValidateNested
+} from "class-validator";
+
+// TODO: Move to @gala-chain/api
+import { BigNumberIsNotNegative, BigNumberLessThanOrEqualOther, BigNumberMax } from "../validators";
+import { IsNonZeroBigNumber } from "../validators";
+
+export class ReverseBondingCurveConfigurationChainObject extends ChainObject {
+  @BigNumberProperty()
+  @BigNumberIsNotNegative()
+  @BigNumberMax("0.5")
+  @BigNumberLessThanOrEqualOther("maxFeePortion")
+  minFeePortion: BigNumber;
+
+  @BigNumberProperty()
+  @BigNumberIsNotNegative()
+  @BigNumberMax("0.5")
+  maxFeePortion: BigNumber;
+
+  constructor(minFeePortion: BigNumber, maxFeePortion: BigNumber) {
+    super();
+    this.minFeePortion = minFeePortion;
+    this.maxFeePortion = maxFeePortion;
+  }
+}
+
+export class ReverseBondingCurveConfigurationDto extends ChainCallDTO {
+  @BigNumberProperty()
+  @BigNumberIsNotNegative()
+  @BigNumberMax("0.5")
+  @BigNumberLessThanOrEqualOther("maxFeePortion")
+  minFeePortion: BigNumber;
+
+  @BigNumberProperty()
+  @BigNumberIsNotNegative()
+  @BigNumberMax("0.5")
+  maxFeePortion: BigNumber;
+
+  toChainObject(): ReverseBondingCurveConfigurationChainObject {
+    return new ReverseBondingCurveConfigurationChainObject(this.minFeePortion, this.maxFeePortion);
+  }
+}
+
+export class CreateTokenSaleDTO extends SubmitCallDTO {
+  @IsString()
+  @IsNotEmpty()
+  public tokenName: string;
+
+  @IsString()
+  @IsNotEmpty()
+  public tokenSymbol: string;
+
+  @IsString()
+  @IsNotEmpty()
+  public tokenDescription: string;
+
+  @IsString()
+  @IsNotEmpty()
+  public tokenCollection: string;
+
+  @IsString()
+  @IsNotEmpty()
+  public tokenCategory: string;
+
+  @IsString()
+  @IsNotEmpty()
+  public tokenImage: string;
+
+  @BigNumberProperty()
+  public preBuyQuantity: BigNumber;
+
+  @IsString()
+  @IsOptional()
+  public websiteUrl?: string;
+
+  @IsString()
+  @IsOptional()
+  public telegramUrl?: string;
+
+  @IsString()
+  @IsOptional()
+  public twitterUrl?: string;
+
+  @IsOptional()
+  @ValidateNested()
+  @Type(() => ReverseBondingCurveConfigurationDto)
+  public reverseBondingCurveConfiguration?: ReverseBondingCurveConfigurationDto;
+
+  constructor(
+    tokenName: string,
+    tokenSymbol: string,
+    tokenDescription: string,
+    tokenImage: string,
+    preBuyQuantity: BigNumber,
+    tokenCollection: string,
+    tokenCategory: string,
+    reverseBondingCurveConfiguration?: ReverseBondingCurveConfigurationDto
+  ) {
+    super();
+    this.tokenName = tokenName;
+    this.tokenSymbol = tokenSymbol;
+    this.tokenDescription = tokenDescription;
+    this.tokenImage = tokenImage;
+    this.preBuyQuantity = preBuyQuantity;
+    this.tokenCollection = tokenCollection;
+    this.tokenCategory = tokenCategory;
+    this.reverseBondingCurveConfiguration = reverseBondingCurveConfiguration;
+  }
+}
+
+export class CreateSaleResDto {
+  @IsNotEmpty()
+  public image: string;
+
+  @IsNotEmpty()
+  public tokenName: string;
+
+  @IsNotEmpty()
+  public symbol: string;
+
+  @IsNotEmpty()
+  public description: string;
+
+  @IsOptional()
+  public websiteUrl?: string;
+
+  @IsOptional()
+  public telegramUrl?: string;
+
+  @IsOptional()
+  public twitterUrl?: string;
+
+  @IsNotEmpty()
+  public initialBuyQuantity: string;
+
+  @IsUserAlias()
+  @IsNotEmpty()
+  public vaultAddress: UserAlias;
+
+  @IsUserAlias()
+  @IsNotEmpty()
+  public creatorAddress: UserAlias;
+
+  @IsNotEmpty()
+  public collection: string;
+
+  @IsNotEmpty()
+  public category: string;
+
+  @IsNotEmpty()
+  public functionName: string;
+
+  @IsNotEmpty()
+  @IsBoolean()
+  public isFinalized: boolean;
+
+  @IsString()
+  @IsNotEmpty()
+  public tokenStringKey: string;
+
+  @IsOptional()
+  @ValidateNested()
+  @Type(() => ReverseBondingCurveConfigurationDto)
+  public reverseBondingCurveConfiguration?: ReverseBondingCurveConfigurationDto;
+}
+
+export class TokenExtraFeesDto {
+  @BigNumberProperty()
+  @IsOptional()
+  public maxAcceptableReverseBondingCurveFee?: BigNumber;
+}
+
+export class ExactTokenQuantityDto extends SubmitCallDTO {
+  @IsUserAlias()
+  @IsNotEmpty()
+  public vaultAddress: UserAlias;
+
+  @BigNumberProperty()
+  @IsNonZeroBigNumber({ message: "tokenQuantity cannot be zero" })
+  public tokenQuantity: BigNumber;
+
+  @BigNumberProperty()
+  @IsOptional()
+  public expectedNativeToken?: BigNumber;
+
+  @ValidateNested()
+  @Type(() => TokenExtraFeesDto)
+  @IsOptional()
+  public extraFees?: TokenExtraFeesDto;
+
+  constructor(vaultAddress: UserAlias, tokenQuantity: BigNumber = new BigNumber(0)) {
+    super();
+    this.vaultAddress = vaultAddress;
+    this.tokenQuantity = tokenQuantity;
+  }
+}
+
+export class NativeTokenQuantityDto extends SubmitCallDTO {
+  @IsUserAlias()
+  @IsNotEmpty()
+  public vaultAddress: UserAlias;
+
+  @BigNumberProperty()
+  @IsNonZeroBigNumber({ message: "nativeTokenQuanity cannot be zero" })
+  public nativeTokenQuantity: BigNumber;
+
+  @BigNumberProperty()
+  @IsOptional()
+  public expectedToken?: BigNumber;
+
+  @ValidateNested()
+  @Type(() => TokenExtraFeesDto)
+  @IsOptional()
+  public extraFees?: TokenExtraFeesDto;
+
+  constructor(vaultAddress: UserAlias, nativeTokenQuantity: BigNumber = new BigNumber(0)) {
+    super();
+    this.vaultAddress = vaultAddress;
+    this.nativeTokenQuantity = nativeTokenQuantity;
+  }
+}
+
+export class TradeResDto {
+  @IsOptional()
+  public tokenBalance?: TokenBalance;
+
+  @IsOptional()
+  public nativeTokenBalance?: TokenBalance;
+
+  @IsOptional()
+  public tokenQuantity?: string;
+
+  @IsOptional()
+  public nativeTokenAmount?: string;
+
+  @IsNotEmpty()
+  public inputQuantity: string;
+
+  @IsNotEmpty()
+  public outputQuantity: string;
+
+  @IsNotEmpty()
+  public tokenName: string;
+
+  @IsNotEmpty()
+  public tradeType: string;
+
+  @IsUserAlias()
+  @IsNotEmpty()
+  public vaultAddress: UserAlias;
+
+  @IsNotEmpty()
+  @IsUserAlias()
+  public userAddress: UserAlias;
+
+  @IsNotEmpty()
+  @IsBoolean()
+  public isFinalized: boolean;
+
+  @IsNotEmpty()
+  public functionName: string;
+}
+
+export class FetchSaleDto extends ChainCallDTO {
+  // TODO: UserAlias?
+  @IsUserAlias()
+  @IsNotEmpty()
+  public vaultAddress: UserAlias;
+  constructor(vaultAddress: UserAlias) {
+    super();
+    this.vaultAddress = vaultAddress;
+  }
+}
+
+export class PreMintCalculationDto extends ChainCallDTO {
+  @BigNumberProperty()
+  @IsNonZeroBigNumber()
+  @IsNotEmpty()
+  public nativeTokenQuantity: BigNumber;
+
+  constructor(nativeTokenQuantity: BigNumber = new BigNumber(0)) {
+    super();
+    this.nativeTokenQuantity = nativeTokenQuantity;
+  }
+}
+
+export class ConfigureLaunchpadFeeAddressDto extends SubmitCallDTO {
+  @IsOptional()
+  @IsUserAlias()
+  public newPlatformFeeAddress?: UserAlias;
+
+  @IsOptional()
+  @IsUserAlias({ each: true })
+  public newAuthorities?: UserAlias[];
+}
+
+export class FinalizeTokenAllocationDto extends SubmitCallDTO {
+  @IsNumber()
+  @Min(0)
+  @Max(1)
+  public platformFeePercentage: number;
+
+  @IsNumber()
+  @Min(0)
+  @Max(1)
+  public ownerFeePercentage: number;
+}
+
+export class CollectFeeAddressDto extends ChainCallDTO {
+  @IsNotEmpty()
+  @IsUserAlias()
+  public platformFeeCollectAddress: UserAlias;
+}
+
+export class TradeCalculationResFeesDto {
+  @IsNotEmpty()
+  @IsString()
+  reverseBondingCurve: string;
+}
+
+export class TradeCalculationResDto {
+  @IsNotEmpty()
+  @IsString()
+  public calculatedQuantity: string;
+
+  @ValidateNested({ each: true })
+  @Type(() => TradeCalculationResFeesDto)
+  public extraFees: TradeCalculationResFeesDto;
+}

package/src/api/types/LaunchpadFeeConfig.ts

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) Gala Games Inc. All rights reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ChainObject, IsUserAlias, UserAlias } from "@gala-chain/api";
+import { Exclude } from "class-transformer";
+import { ArrayNotEmpty, IsNotEmpty } from "class-validator";
+import { JSONSchema } from "class-validator-jsonschema";
+
+@JSONSchema({
+  description: "Defines the platform fee address and authorized owners for modification."
+})
+export class LaunchpadFeeConfig extends ChainObject {
+  @Exclude()
+  public static INDEX_KEY = "GCLFC"; // GalaChain Launchpad Fee Configuration
+
+  @IsNotEmpty()
+  @IsUserAlias()
+  feeAddress: UserAlias;
+
+  @ArrayNotEmpty()
+  @IsUserAlias({ each: true })
+  authorities: UserAlias[];
+
+  constructor(feeAddress: UserAlias, authorities: UserAlias[]) {
+    super();
+    this.feeAddress = feeAddress;
+    this.authorities = authorities;
+  }
+
+  public setNewFeeAddress(newfeeAddress: UserAlias, newAuthorities: UserAlias[]) {
+    this.feeAddress = newfeeAddress;
+    this.authorities = newAuthorities;
+  }
+}

package/src/api/types/LaunchpadFinalizeAllocation.ts

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) Gala Games Inc. All rights reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ChainObject } from "@gala-chain/api";
+import { Exclude } from "class-transformer";
+import { IsNumber, Max, Min } from "class-validator";
+import { JSONSchema } from "class-validator-jsonschema";
+
+@JSONSchema({
+  description: "Defines the platform fee and owner allocation percentages."
+})
+export class LaunchpadFinalizeFeeAllocation extends ChainObject {
+  @Exclude()
+  static INDEX_KEY = "GCLFFA"; //GalaChain Launchpad Final Fee Allocatoin
+
+  @IsNumber()
+  @Min(0)
+  @Max(1)
+  public platformFeePercentage: number;
+
+  @IsNumber()
+  @Min(0)
+  @Max(1)
+  public ownerAllocationPercentage: number;
+
+  public liquidityAllocationPercentage: number;
+
+  constructor(platformFeePercentage: number, ownerAllocationPercentage: number) {
+    super();
+    const total = platformFeePercentage + ownerAllocationPercentage;
+    if (total > 1) {
+      throw new Error("Total allocation (Platform Fee + Owner Allocation) cannot exceed 1.");
+    }
+
+    this.platformFeePercentage = platformFeePercentage;
+    this.ownerAllocationPercentage = ownerAllocationPercentage;
+
+    const liquidity = 1 - total;
+    this.liquidityAllocationPercentage = Number(Math.max(liquidity, 0).toFixed(5));
+  }
+
+  public setAllocation(platformFee: number, ownerAllocation: number) {
+    const total = platformFee + ownerAllocation;
+    if (total > 1) {
+      throw new Error("Total allocation (Platform Fee + Owner Allocation) cannot exceed 1.");
+    }
+
+    this.platformFeePercentage = platformFee;
+    this.ownerAllocationPercentage = ownerAllocation;
+
+    const liquidity = 1 - total;
+    this.liquidityAllocationPercentage = Number(Math.max(liquidity, 0).toFixed(5)); // Ensure it doesn't go negative
+  }
+}

package/src/api/types/LaunchpadSale.ts

@@ -0,0 +1,200 @@
+/*
+ * Copyright (c) Gala Games Inc. All rights reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import {
+  BigNumberProperty,
+  ChainKey,
+  ChainObject,
+  IsUserAlias,
+  StringEnumProperty,
+  TokenInstanceKey,
+  UserAlias
+} from "@gala-chain/api";
+import BigNumber from "bignumber.js";
+import { Exclude, Type } from "class-transformer";
+import { IsNotEmpty, IsOptional, IsString, ValidateNested } from "class-validator";
+import { JSONSchema } from "class-validator-jsonschema";
+
+import { ReverseBondingCurveConfigurationChainObject } from "./LaunchpadDtos";
+
+export enum SaleStatus {
+  ONGOING = "Ongoing",
+  END = "Finished"
+}
+
+@JSONSchema({
+  description: "Represents a launchpad sale, defining token quantities, pricing, and sale operations."
+})
+export class LaunchpadSale extends ChainObject {
+  @Exclude()
+  static INDEX_KEY = "GCLPS"; //GalaChain LaunchPad Sale
+
+  @ChainKey({ position: 0 })
+  @IsUserAlias()
+  @IsNotEmpty()
+  public vaultAddress: UserAlias;
+
+  @StringEnumProperty(SaleStatus)
+  @IsNotEmpty()
+  public saleStatus: SaleStatus;
+
+  @Type(() => TokenInstanceKey)
+  @IsNotEmpty()
+  public sellingToken: TokenInstanceKey;
+
+  @Type(() => TokenInstanceKey)
+  @IsNotEmpty()
+  public nativeToken: TokenInstanceKey;
+
+  @IsString()
+  @IsNotEmpty()
+  public sellingTokenQuantity: string;
+
+  @IsString()
+  @IsNotEmpty()
+  public nativeTokenQuantity: string;
+
+  @IsUserAlias()
+  @IsNotEmpty()
+  public saleOwner: UserAlias;
+
+  @BigNumberProperty()
+  public basePrice: BigNumber;
+
+  @BigNumberProperty()
+  public exponentFactor: BigNumber;
+
+  @BigNumberProperty()
+  public maxSupply: BigNumber;
+
+  @BigNumberProperty()
+  public euler: BigNumber;
+
+  @IsOptional()
+  @ValidateNested()
+  @Type(() => ReverseBondingCurveConfigurationChainObject)
+  public reverseBondingCurveConfiguration?: ReverseBondingCurveConfigurationChainObject;
+
+  @JSONSchema({
+    description:
+      "The market cap has been calculated using the bonding curve equations to approximate a specific final price."
+  })
+  public static MARKET_CAP = "1640985.8441726";
+
+  @JSONSchema({
+    description:
+      "This base price has been calculated using the bonding curve equations to ensure that a MARKET_CAP amount of " +
+      "native tokens will correspond to 10 million native tokens."
+  })
+  public static BASE_PRICE = "16506671506650";
+
+  constructor(
+    vaultAddress: UserAlias,
+    sellingToken: TokenInstanceKey,
+    reverseBondingCurveConfiguration: ReverseBondingCurveConfigurationChainObject | undefined,
+    saleOwner: UserAlias
+  ) {
+    super();
+
+    this.vaultAddress = vaultAddress;
+    this.saleOwner = saleOwner;
+
+    this.sellingToken = sellingToken;
+    this.sellingTokenQuantity = "1e+7";
+
+    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";
+    nativeTokenInstance.category = "Unit";
+    nativeTokenInstance.type = "none";
+    nativeTokenInstance.additionalKey = "none";
+    nativeTokenInstance.instance = new BigNumber(0);
+
+    this.nativeToken = nativeTokenInstance;
+    this.nativeTokenQuantity = "0";
+    this.reverseBondingCurveConfiguration = reverseBondingCurveConfiguration;
+  }
+
+  public buyToken(sellingTokenAmount: BigNumber, nativeTokenAmount: BigNumber) {
+    const tokenLeftInVault = new BigNumber(this.sellingTokenQuantity);
+    const nativeTokensLeftInVault = new BigNumber(this.nativeTokenQuantity);
+    this.sellingTokenQuantity = tokenLeftInVault.minus(sellingTokenAmount).toString();
+    this.nativeTokenQuantity = nativeTokensLeftInVault.plus(nativeTokenAmount).toString();
+  }
+
+  public sellToken(sellingTokenAmount: BigNumber, nativeTokenAmount: BigNumber) {
+    const tokenLeftInVault = new BigNumber(this.sellingTokenQuantity);
+    const nativeTokensLeftInVault = new BigNumber(this.nativeTokenQuantity);
+    this.sellingTokenQuantity = tokenLeftInVault.plus(sellingTokenAmount).toString();
+    this.nativeTokenQuantity = nativeTokensLeftInVault.minus(nativeTokenAmount).toString();
+  }
+
+  public fetchTokensSold() {
+    const tokenLeftInVault = new BigNumber(this.sellingTokenQuantity);
+    const tokensSold = new BigNumber(this.maxSupply).minus(tokenLeftInVault);
+    return tokensSold.toString();
+  }
+
+  // Returns the portion of the max supply that is circulating (that is, not in the vault)
+  // This is a value between 0 and 1. If a quarter of the max supply is circulating, this
+  // will return 0.25
+  public fetchCirculatingSupplyProportional() {
+    const tokenLeftInVault = new BigNumber(this.sellingTokenQuantity);
+    const graduationProgress = BigNumber(1).minus(tokenLeftInVault.dividedBy(this.maxSupply));
+    return graduationProgress;
+  }
+
+  public fetchNativeTokensInVault() {
+    const nativeTokenInVault = new BigNumber(this.nativeTokenQuantity);
+    return nativeTokenInVault.toString();
+  }
+
+  public fetchBasePrice() {
+    const basePriceBigNumber = new BigNumber(this.basePrice);
+    return basePriceBigNumber.toString();
+  }
+
+  public finalizeSale() {
+    this.saleStatus = SaleStatus.END;
+    this.nativeTokenQuantity = "0";
+    this.sellingTokenQuantity = "0";
+  }
+
+  public fetchSellingTokenInstanceKey() {
+    const tokenInstanceKey = new TokenInstanceKey();
+    tokenInstanceKey.collection = this.sellingToken.collection;
+    tokenInstanceKey.category = this.sellingToken.category;
+    tokenInstanceKey.type = this.sellingToken.type;
+    tokenInstanceKey.additionalKey = this.sellingToken.additionalKey;
+    tokenInstanceKey.instance = this.sellingToken.instance;
+
+    return tokenInstanceKey;
+  }
+
+  public fetchNativeTokenInstanceKey() {
+    const tokenInstanceKey = new TokenInstanceKey();
+    tokenInstanceKey.collection = this.nativeToken.collection;
+    tokenInstanceKey.category = this.nativeToken.category;
+    tokenInstanceKey.type = this.nativeToken.type;
+    tokenInstanceKey.additionalKey = this.nativeToken.additionalKey;
+    tokenInstanceKey.instance = this.nativeToken.instance;
+
+    return tokenInstanceKey;
+  }
+}

package/src/api/types/index.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) Gala Games Inc. All rights reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from "./LaunchpadDtos";
+export * from "./LaunchpadFinalizeAllocation";
+export * from "./LaunchpadFeeConfig";
+export * from "./LaunchpadSale";