@gala-chain/launchpad-sdk 8.0.1 → 8.1.0

package/dist/launchpad/sell-fee-ceiling.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Default reverse-bonding-curve fee ceiling for sells.
+ *
+ * On chain a sell pays a reverse-bonding-curve (RBC) fee, and `extraFees.maxAcceptableReverseBondingCurveFee`
+ * is the most the seller accepts to pay (launchpad-chaincode `payReverseBondingCurveFee`):
+ *
+ * - the field absent means "no ceiling" (the check is skipped);
+ * - any value present, `'0'` included, is a ceiling: a non-zero fee above it fails the sell with
+ *   "Fee exceeds maximum acceptable amount".
+ *
+ * A caller that names no ceiling therefore must not get `'0'` (every sell with an RBC fee would be
+ * rejected) and should not get "no ceiling" either. The launchpad frontend quotes the sell and
+ * allows the quoted fee plus a 1% fee slippage; this module does the same, from the same backend
+ * quote endpoint, and an explicit `extraFees` always wins.
+ *
+ * @packageDocumentation
+ */
+import type { AmountCalculationResult } from '../types/launchpad.dto';
+/** Which sell the ceiling is for. */
+export type SellFeeCeilingMethod = 'SellExactToken' | 'SellWithNative';
+/** What a ceiling resolver needs to know about the sell. */
+export interface SellFeeCeilingRequest {
+    /** `SellExactToken` (quantity is tokens sold) or `SellWithNative` (quantity is GALA received). */
+    method: SellFeeCeilingMethod;
+    /** The sale vault. */
+    vaultAddress: string;
+    /** The trade quantity exactly as it goes into the DTO. */
+    quantity: string;
+    /** The launchpad token name when the caller already has it (saves a lookup). */
+    tokenName?: string;
+    /** Fee slippage override; defaults to the SDK's `maxAcceptableReverseBondingCurveFeeSlippageFactor`. */
+    feeSlippageFactor?: number;
+}
+/** Resolves the fee ceiling (decimal string, GALA) for a sell. */
+export type SellFeeCeilingResolver = (request: SellFeeCeilingRequest) => Promise<string>;
+/** Collaborators of the default resolver. */
+export interface SellFeeCeilingDeps {
+    /** Quote a trade through the backend (`GET /v1/trading/quote`). */
+    getTradeQuote(params: {
+        tokenName: string;
+        amount: string;
+        type: 'MEME' | 'NATIVE';
+        method: 'IN' | 'OUT';
+    }): Promise<AmountCalculationResult>;
+    /** Find the token name of a vault (the quote endpoint is keyed by token name). */
+    findTokenNameByVault(vaultAddress: string, symbol: string): Promise<string | undefined>;
+    /** The SDK-wide default fee slippage factor, read at call time. */
+    defaultFeeSlippageFactor(): number;
+}
+/**
+ * The quoted fee plus fee slippage, rounded UP to the chain's 8 decimals so the ceiling can never
+ * end up below the fee the chain computes (the chain also rounds its fee up).
+ *
+ * @example
+ * feeCeilingFromQuotedFee('0.00003328', 0.01) // '0.00003362'
+ */
+export declare function feeCeilingFromQuotedFee(quotedFee: string, feeSlippageFactor: number): string;
+/**
+ * Build the default resolver: quote the sell, allow the quoted fee plus fee slippage.
+ *
+ * A sell of an exact token quantity is quoted as MEME/IN (tokens in, GALA out); a sell for an
+ * exact GALA amount is quoted as NATIVE/OUT. Both quotes carry the fee the chain will compute for
+ * that payout.
+ */
+export declare function createSellFeeCeilingResolver(deps: SellFeeCeilingDeps): SellFeeCeilingResolver;
+//# sourceMappingURL=sell-fee-ceiling.d.ts.map

package/dist/launchpad/sell-fee-ceiling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sell-fee-ceiling.d.ts","sourceRoot":"","sources":["../../src/launchpad/sell-fee-ceiling.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAIH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAOtE,qCAAqC;AACrC,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;AAEvE,4DAA4D;AAC5D,MAAM,WAAW,qBAAqB;IACpC,kGAAkG;IAClG,MAAM,EAAE,oBAAoB,CAAC;IAC7B,sBAAsB;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,CAAC;IACjB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wGAAwG;IACxG,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,kEAAkE;AAClE,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAEzF,6CAA6C;AAC7C,MAAM,WAAW,kBAAkB;IACjC,mEAAmE;IACnE,aAAa,CAAC,MAAM,EAAE;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;QACxB,MAAM,EAAE,IAAI,GAAG,KAAK,CAAC;KACtB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACrC,kFAAkF;IAClF,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACxF,mEAAmE;IACnE,wBAAwB,IAAI,MAAM,CAAC;CACpC;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAqB5F;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,kBAAkB,GAAG,sBAAsB,CAa7F"}

package/dist/launchpad/writes.d.ts

@@ -1,5 +1,6 @@
-import type { LaunchTokenData } from '../types/launchpad.dto.js';
+import type { LaunchTokenData, ReverseBondingCurveConfiguration } from '../types/launchpad.dto.js';
 import type { BundleSubmission } from './bundle-submission.js';
+import type { SellFeeCeilingResolver } from './sell-fee-ceiling.js';
 import type { LaunchpadWriteTransport } from './transport.js';
 /** Common fee fields copied into every frontend trade DTO. */
 export interface LaunchpadExtraFees {
@@ -10,9 +11,23 @@ export interface LaunchpadTradeInput {
     vaultAddress: string;
     quantity: string;
     expectedAmount: string;
+    /**
+     * The most reverse-bonding-curve fee (GALA) a sell may pay. Omit it on a sell and the SDK quotes
+     * the fee and allows it plus the SDK fee slippage; pass it to take over (an explicit `'0'` means
+     * "reject any fee", which the chain does for every sell on a pool that charges one). Buys pay no
+     * such fee and ignore the value.
+     */
     extraFees?: LaunchpadExtraFees;
+    /** The launchpad token name of `vaultAddress`; saves the SDK one lookup when it quotes a sell. */
+    tokenName?: string;
     uniqueKey?: string;
 }
+/**
+ * Reverse bonding curve (sell fee) configuration a CreateSale carries when the caller names none:
+ * 10% at the start of the curve to 50% at the end, the documented defaults and the bundler's
+ * allowed range (min >= 0.1, max <= 0.5).
+ */
+export declare const DEFAULT_REVERSE_BONDING_CURVE_CONFIGURATION: Readonly<ReverseBondingCurveConfiguration>;
 /** Input for a CreateSale bundler write. */
 export interface CreateSaleInput extends Omit<LaunchTokenData, 'tokenImage'> {
     tokenImage: string;
@@ -22,10 +37,17 @@ export interface CreateSaleInput extends Omit<LaunchTokenData, 'tokenImage'> {
 export declare class LaunchpadWrites {
     private readonly transport;
     private readonly walletAddress;
-    /** Construct launchpad write methods around an injected transport. */
+    private readonly sellFeeCeiling;
+    /**
+     * Construct launchpad write methods around an injected transport.
+     *
+     * `sellFeeCeiling` supplies the fee ceiling of a sell that names no `extraFees`; without it such a
+     * sell is refused instead of being sent with a ceiling the chain would reject.
+     */
     constructor(options: {
         transport: LaunchpadWriteTransport;
         walletAddress: string;
+        sellFeeCeiling?: SellFeeCeilingResolver;
     });
     /**
      * Create a sale using the frontend's CreateSale DTO and instruction set.
@@ -70,5 +92,11 @@ export declare class LaunchpadWrites {
      */
     sellExactToken(input: LaunchpadTradeInput): Promise<BundleSubmission>;
     private submitTrade;
+    /**
+     * The `extraFees` of a trade whose caller named none. Buys pay no reverse-bonding-curve fee, so
+     * their ceiling is moot. A sell must carry a ceiling the chain accepts: the chain treats a
+     * present `'0'` as "accept nothing", so the default is the quoted fee plus fee slippage.
+     */
+    private defaultExtraFees;
 }
 //# sourceMappingURL=writes.d.ts.map

package/dist/launchpad/writes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writes.d.ts","sourceRoot":"","sources":["../../src/launchpad/writes.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,OAAO,KAAK,EAAwB,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAEpF,8DAA8D;AAC9D,MAAM,WAAW,kBAAkB;IACjC,mCAAmC,EAAE,MAAM,CAAC;CAC7C;AAED,2CAA2C;AAC3C,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC;IAC1E,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,wFAAwF;AACxF,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IACpD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC,sEAAsE;gBACnD,OAAO,EAAE;QAAE,SAAS,EAAE,uBAAuB,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE;IAKzF;;;;;;;OAOG;IACI,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYpE;;;;;;;OAOG;IACI,aAAa,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO3E;;;;;;OAMG;IACI,aAAa,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO3E;;;;;;OAMG;IACI,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO5E;;;;;;OAMG;IACI,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO5E,OAAO,CAAC,WAAW;CAiBpB"}
+{"version":3,"file":"writes.d.ts","sourceRoot":"","sources":["../../src/launchpad/writes.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,gCAAgC,EAAE,MAAM,2BAA2B,CAAC;AAGnG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAEpE,OAAO,KAAK,EAAwB,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAEpF,8DAA8D;AAC9D,MAAM,WAAW,kBAAkB;IACjC,mCAAmC,EAAE,MAAM,CAAC;CAC7C;AAED,2CAA2C;AAC3C,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,kGAAkG;IAClG,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,eAAO,MAAM,2CAA2C,EAAE,QAAQ,CAAC,gCAAgC,CAGlG,CAAC;AAEF,4CAA4C;AAC5C,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC;IAC1E,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,wFAAwF;AACxF,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IACpD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAqC;IAEpE;;;;;OAKG;gBACgB,OAAO,EAAE;QAC1B,SAAS,EAAE,uBAAuB,CAAC;QACnC,aAAa,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,sBAAsB,CAAC;KACzC;IAMD;;;;;;;OAOG;IACI,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYpE;;;;;;;OAOG;IACI,aAAa,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO3E;;;;;;OAMG;IACI,aAAa,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO3E;;;;;;OAMG;IACI,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO5E;;;;;;OAMG;IACI,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;YAO9D,WAAW;IAkBzB;;;;OAIG;YACW,gBAAgB;CAsB/B"}