@gala-chain/launchpad 1.0.0

package/src/chaincode/launchpad/preMintCalculation.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 { BigNumber } from "bignumber.js";
+import Decimal from "decimal.js";
+
+import { LaunchpadSale, PreMintCalculationDto } from "../../api/types";
+import { getBondingConstants } from "../utils";
+
+BigNumber.config({
+  ROUNDING_MODE: BigNumber.ROUND_UP
+});
+
+/**
+ * Calculates the number of tokens that can be purchased using a specified amount
+ * of native tokens based on a bonding curve mechanism.
+ *
+ * This function applies the bonding curve formula for a brand new sale with zero tokens sold
+ * to determine the number of tokens the user can buy with the provided native token amount.
+ *
+ * @param buyTokenDTO - The Amount of native tokens to spend for the purchase.
+ *
+ * @returns A promise that resolves to a string representing the calculated amount of
+ *          tokens to be received, rounded down to 18 decimal places.
+ *
+ * @throws Error if the calculation results in an invalid state.
+ */
+export async function calculatePreMintTokens(buyTokenDTO: PreMintCalculationDto): Promise<string> {
+  const totalTokensSold = new Decimal(0); // current tokens sold / x
+  const nativeTokens = new Decimal(buyTokenDTO.nativeTokenQuantity.toString()); // native tokens used to buy / y
+  const basePrice = new Decimal(LaunchpadSale.BASE_PRICE); // base price / a
+  const { exponentFactor, euler, decimals } = getBondingConstants();
+
+  const constant = nativeTokens.mul(exponentFactor).div(basePrice);
+
+  const exponent1 = exponentFactor.mul(totalTokensSold).div(decimals);
+
+  const eResult1 = euler.pow(exponent1);
+
+  const ethScaled = constant.add(eResult1);
+
+  const lnEthScaled = ethScaled.ln().mul(decimals);
+
+  const lnEthScaledBase = lnEthScaled.div(exponentFactor);
+
+  const result = lnEthScaledBase.minus(totalTokensSold);
+  const roundedResult = result.toDecimalPlaces(18, Decimal.ROUND_DOWN);
+
+  return roundedResult.toString();
+}

package/src/chaincode/launchpad/sellExactToken.ts

@@ -0,0 +1,122 @@
+/*
+ * 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 { GalaChainContext, fetchTokenClass, putChainObject, transferToken } from "@gala-chain/chaincode";
+import { BigNumber } from "bignumber.js";
+
+import { ExactTokenQuantityDto, NativeTokenQuantityDto, TradeResDto } from "../../api/types";
+import { SlippageToleranceExceededError } from "../../api/utils/error";
+import { fetchAndValidateSale } from "../utils";
+import { callMemeTokenIn } from "./callMemeTokenIn";
+import { callNativeTokenOut } from "./callNativeTokenOut";
+import { payReverseBondingCurveFee } from "./fees";
+
+BigNumber.config({
+  ROUNDING_MODE: BigNumber.ROUND_UP
+});
+
+/**
+ * Executes the sale of an exact amount of tokens for native tokens (e.g., GALA).
+ *
+ * This function facilitates selling a specific token amount by transferring the tokens to
+ * the sale vault and providing the calculated native tokens in return. It ensures validation
+ * of the sale, handles insufficient vault balances, and checks expected vs. actual native tokens.
+ *
+ * @param ctx - The context object providing access to the GalaChain environment.
+ * @param sellTokenDTO - An object containing the sale details:
+ *   - `vaultAddress`: The address of the sale.
+ *   - `tokenAmount`: The exact amount of tokens to sell.
+ *   - `expectedNativeToken` (optional): The expected amount of native tokens in return.
+ *
+ * @returns A promise that resolves to a `TradeResDto` object containing the updated
+ *          balances of the seller's tokens and native tokens.
+ *
+ * @throws DefaultError if the expected native tokens exceed the actual amount to be provided.
+ */
+export async function sellExactToken(
+  ctx: GalaChainContext,
+  sellTokenDTO: ExactTokenQuantityDto
+): Promise<TradeResDto> {
+  const sale = await fetchAndValidateSale(ctx, sellTokenDTO.vaultAddress);
+
+  const callNativeTokenOutResult = await callNativeTokenOut(ctx, sellTokenDTO);
+  let nativeTokensToProvide = new BigNumber(callNativeTokenOutResult.calculatedQuantity);
+  const nativeTokensLeftInVault = new BigNumber(sale.nativeTokenQuantity);
+  const nativeToken = sale.fetchNativeTokenInstanceKey();
+  const memeToken = sale.fetchSellingTokenInstanceKey();
+
+  if (nativeTokensLeftInVault.comparedTo(nativeTokensToProvide) < 0) {
+    nativeTokensToProvide = nativeTokensLeftInVault;
+    const nativeTokensBeingSoldDto = new NativeTokenQuantityDto(
+      sellTokenDTO.vaultAddress,
+      nativeTokensToProvide
+    );
+    const callMemeTokenInResult = await callMemeTokenIn(ctx, nativeTokensBeingSoldDto);
+    sellTokenDTO.tokenQuantity = new BigNumber(callMemeTokenInResult.calculatedQuantity);
+  }
+
+  if (
+    sellTokenDTO.expectedNativeToken &&
+    sellTokenDTO.expectedNativeToken.comparedTo(nativeTokensToProvide) > 0
+  ) {
+    throw new SlippageToleranceExceededError(
+      "Expected Gala tokens from this operation exceeds the actual amount that will be provided."
+    );
+  }
+
+  // The fee must be paid BEFORE the sale can happen.
+  // That means you cannot pay the fee using proceeds from the sale.
+  await payReverseBondingCurveFee(
+    ctx,
+    sale,
+    nativeTokensToProvide,
+    sellTokenDTO.extraFees?.maxAcceptableReverseBondingCurveFee
+  );
+
+  await transferToken(ctx, {
+    from: ctx.callingUser,
+    to: sellTokenDTO.vaultAddress,
+    tokenInstanceKey: memeToken,
+    quantity: sellTokenDTO.tokenQuantity,
+    allowancesToUse: [],
+    authorizedOnBehalf: undefined
+  });
+
+  await transferToken(ctx, {
+    from: sellTokenDTO.vaultAddress,
+    to: ctx.callingUser,
+    tokenInstanceKey: nativeToken,
+    quantity: nativeTokensToProvide,
+    allowancesToUse: [],
+    authorizedOnBehalf: {
+      callingOnBehalf: sellTokenDTO.vaultAddress,
+      callingUser: ctx.callingUser
+    }
+  });
+
+  sale.sellToken(sellTokenDTO.tokenQuantity, nativeTokensToProvide);
+  await putChainObject(ctx, sale);
+
+  const token = await fetchTokenClass(ctx, sale.sellingToken);
+  return {
+    inputQuantity: sellTokenDTO.tokenQuantity.toFixed(),
+    outputQuantity: nativeTokensToProvide.toFixed(),
+    tokenName: token.name,
+    tradeType: "Sell",
+    vaultAddress: sellTokenDTO.vaultAddress,
+    userAddress: ctx.callingUser,
+    isFinalized: false,
+    functionName: "SellExactToken"
+  };
+}

package/src/chaincode/launchpad/sellWithNative.ts

@@ -0,0 +1,112 @@
+/*
+ * 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 { GalaChainContext, fetchTokenClass, putChainObject, transferToken } from "@gala-chain/chaincode";
+import { BigNumber } from "bignumber.js";
+
+import { NativeTokenQuantityDto, TradeResDto } from "../../api/types";
+import { SlippageToleranceExceededError } from "../../api/utils/error";
+import { fetchAndValidateSale } from "../utils";
+import { callMemeTokenIn } from "./callMemeTokenIn";
+import { payReverseBondingCurveFee } from "./fees";
+
+BigNumber.config({
+  ROUNDING_MODE: BigNumber.ROUND_UP
+});
+
+/**
+ * Executes a sale of tokens using native tokens (e.g., GALA) in exchange for the specified token amount.
+ *
+ * This function handles the process of selling tokens for native tokens in the sale vault, ensuring
+ * that the token amount and native token quantity are properly adjusted based on the sale vault's
+ * available balance. It also checks if the expected token amount matches the actual amount required.
+ *
+ * @param ctx - The context object that provides access to the GalaChain environment.
+ * @param sellTokenDTO - An object containing the sale details:
+ *   - `vaultAddress`: The address of the sale.
+ *   - `nativeTokenAmount`: The amount of native tokens to be used in the sale.
+ *   - `expectedToken` (optional): The expected amount of tokens to be received in return.
+ *
+ * @returns A promise that resolves to a `TradeResDto` object containing the updated
+ *          balances of the seller's tokens and native tokens.
+ *
+ * @throws DefaultError if the expected token amount is less than the actual amount required
+ *         for the operation.
+ */
+export async function sellWithNative(
+  ctx: GalaChainContext,
+  sellTokenDTO: NativeTokenQuantityDto
+): Promise<TradeResDto> {
+  const sale = await fetchAndValidateSale(ctx, sellTokenDTO.vaultAddress);
+
+  const nativeTokensLeftInVault = new BigNumber(sale.nativeTokenQuantity);
+  if (nativeTokensLeftInVault.comparedTo(sellTokenDTO.nativeTokenQuantity) < 0) {
+    sellTokenDTO.nativeTokenQuantity = nativeTokensLeftInVault;
+  }
+
+  const callMemeTokenInResult = await callMemeTokenIn(ctx, sellTokenDTO);
+  const tokensToSell = new BigNumber(callMemeTokenInResult.calculatedQuantity);
+  const nativeToken = sale.fetchNativeTokenInstanceKey();
+  const memeToken = sale.fetchSellingTokenInstanceKey();
+
+  if (sellTokenDTO.expectedToken && sellTokenDTO.expectedToken.comparedTo(tokensToSell) < 0) {
+    throw new SlippageToleranceExceededError(
+      "Token amount expected to cost for this operation is less than the the actual amount required."
+    );
+  }
+
+  // The fee must be paid BEFORE the sale can happen.
+  // That means you cannot pay the fee using proceeds from the sale.
+  await payReverseBondingCurveFee(
+    ctx,
+    sale,
+    sellTokenDTO.nativeTokenQuantity,
+    sellTokenDTO.extraFees?.maxAcceptableReverseBondingCurveFee
+  );
+
+  await transferToken(ctx, {
+    from: ctx.callingUser,
+    to: sellTokenDTO.vaultAddress,
+    tokenInstanceKey: memeToken,
+    quantity: tokensToSell,
+    allowancesToUse: [],
+    authorizedOnBehalf: undefined
+  });
+  await transferToken(ctx, {
+    from: sellTokenDTO.vaultAddress,
+    to: ctx.callingUser,
+    tokenInstanceKey: nativeToken,
+    quantity: sellTokenDTO.nativeTokenQuantity,
+    allowancesToUse: [],
+    authorizedOnBehalf: {
+      callingOnBehalf: sellTokenDTO.vaultAddress,
+      callingUser: ctx.callingUser
+    }
+  });
+
+  sale.sellToken(tokensToSell, sellTokenDTO.nativeTokenQuantity);
+  await putChainObject(ctx, sale);
+
+  const token = await fetchTokenClass(ctx, sale.sellingToken);
+  return {
+    inputQuantity: tokensToSell.toFixed(),
+    outputQuantity: sellTokenDTO.nativeTokenQuantity.toFixed(),
+    tokenName: token.name,
+    tradeType: "Sell",
+    vaultAddress: sellTokenDTO.vaultAddress,
+    userAddress: ctx.callingUser,
+    isFinalized: false,
+    functionName: "SellWithNative"
+  };
+}

package/src/chaincode/utils/index.ts

@@ -0,0 +1,15 @@
+/*
+ * 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 "./launchpadSaleUtils";

package/src/chaincode/utils/launchpadSaleUtils.ts

@@ -0,0 +1,68 @@
+/*
+ * 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 { ChainError, DefaultError, ErrorCode, NotFoundError } from "@gala-chain/api";
+import { GalaChainContext, getObjectByKey } from "@gala-chain/chaincode";
+import Decimal from "decimal.js";
+
+import { LaunchpadFeeConfig, LaunchpadSale, SaleStatus } from "../../api/types";
+
+export async function fetchAndValidateSale(
+  ctx: GalaChainContext,
+  vaultAddress: string
+): Promise<LaunchpadSale> {
+  const key = ctx.stub.createCompositeKey(LaunchpadSale.INDEX_KEY, [vaultAddress]);
+  const sale = await getObjectByKey(ctx, LaunchpadSale, key).catch((e) => {
+    const chainError = ChainError.from(e);
+    if (chainError.matches(ErrorCode.NOT_FOUND)) {
+      return undefined;
+    } else {
+      throw chainError;
+    }
+  });
+
+  if (sale === undefined) {
+    throw new NotFoundError("Sale record not found.");
+  }
+  if (sale.saleStatus === SaleStatus.END) {
+    throw new DefaultError("This sale has already ended.");
+  }
+
+  return sale;
+}
+
+export function getBondingConstants() {
+  return {
+    exponentFactor: new Decimal("1166069000000"), // exponent factor / b
+    euler: new Decimal("2.7182818284590452353602874713527"), // e
+    decimals: new Decimal("1e+18") // scaling factor for decimals
+  };
+}
+
+export async function fetchLaunchpadFeeAddress(
+  ctx: GalaChainContext
+): Promise<LaunchpadFeeConfig | undefined> {
+  const key = ctx.stub.createCompositeKey(LaunchpadFeeConfig.INDEX_KEY, []);
+
+  const platformFeeAddress = await getObjectByKey(ctx, LaunchpadFeeConfig, key).catch((e) => {
+    const chainError = ChainError.from(e);
+    if (chainError.matches(ErrorCode.NOT_FOUND)) {
+      return undefined;
+    } else {
+      throw chainError;
+    }
+  });
+
+  return platformFeeAddress;
+}

package/src/cli.ts

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+
+/*
+ * 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 and run standard fabric-chaincode-node cli
+import type { ContractAPI } from "@gala-chain/api";
+import type { GalaContract } from "@gala-chain/chaincode";
+import "fabric-shim/cli";
+import fs from "fs";
+
+const [, , customCommand] = process.argv;
+if (customCommand === "get-contract-names") {
+  printContractNames();
+  process.exit(0);
+}
+
+if (customCommand === "get-contract-api") {
+  saveContractAPI("/tmp/contract-api.json");
+  process.exit(0);
+}
+
+function getContractInstances(): GalaContract[] {
+  // importing contracts would produce a lot of noise, so we set the log level to error
+  process.env.CORE_CHAINCODE_LOGGING_LEVEL = "error";
+  process.env.LOG_LEVEL = "error";
+
+  const { contracts } = require("./index");
+  return (contracts ?? [])
+    .filter((c: any) => typeof c === "function")
+    .map((Cls) => new Cls())
+    .filter((c: GalaContract) => typeof c.getName === "function");
+}
+
+function printContractNames() {
+  const response = getContractInstances()
+    .map((c) => c.getName())
+    .filter((name: string) => name !== undefined)
+    .sort()
+    .map((contractName: string) => ({ contractName }));
+
+  console.log(JSON.stringify(response));
+}
+
+function saveContractAPI(path: string) {
+  const response = getContractInstances()
+    .map((c) => c.getContractAPI())
+    .filter((api: ContractAPI) => api !== undefined)
+    .sort((a, b) => a.contractName.localeCompare(b.contractName));
+
+  fs.writeFileSync(path, JSON.stringify(response));
+}

package/src/index.ts

@@ -0,0 +1,32 @@
+// sort-imports-ignore
+/*
+ * 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 "dotenv/config";
+
+import { GalaContract, GalaJSONSerializer } from "@gala-chain/chaincode";
+
+import { LaunchpadContract } from "./chaincode";
+
+export const contracts: { new (): GalaContract }[] = [LaunchpadContract];
+
+export * from "./chaincode";
+export * from "./api";
+
+export const serializers = {
+  transaction: "galaJsonSerializer",
+  serializers: {
+    galaJsonSerializer: GalaJSONSerializer
+  }
+};

package/tsconfig.base.json

@@ -0,0 +1,29 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "moduleDetection": "force",
+    "baseUrl": ".",
+    "rootDir": ".",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "target": "ES2019",
+    "lib": ["ES2019"],
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "importHelpers": true,
+    "esModuleInterop": true,
+    "strictNullChecks": true,
+    "composite": true,
+    "skipLibCheck": true,
+    "noPropertyAccessFromIndexSignature": false,
+    "strictPropertyInitialization": false
+  },
+  "exclude": ["node_modules"],
+  "include": [
+    "package.json"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "lib",
+    "declarationDir": "lib",
+    "composite": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "files": [],
+  "include": ["**/*", "package.json"],
+  "exclude": ["lib", "**/*spec.ts", "src/__mocks__", "src/__test__"],
+  "references": [
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.spec.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"],
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
+}