aftermath-ts-sdk 2.3.0-dev.719b327 → 2.3.0

package/dist/index.d.ts

@@ -1547,20 +1547,16 @@ interface ApiNftAmmWithdrawBody {
  * that debits the specified wallet's gas pool.
  */
 interface PerpetualsSponsorConfig {
-    /**
-     * Wallet address to use for gas pool sponsorship. Must be the connected
-     * wallet: af-fe now verifies the sponsor and refuses a request naming any
-     * other address with error 2034 before it reaches the pool (AFX-382).
-     */
+    /** Wallet address to use for gas pool sponsorship. */
     walletAddress: SuiAddress;
     /**
-     * Base64 UTF-8 bytes of the Terms and Conditions message (see
-     * `UserData.createTermsAndConditionsMessage`), signed once by `walletAddress`
-     * and cached for the session. Sending this cached signature is all the gas
-     * pool needs; it replaces the old per-tx `SPONSOR_GAS` payload (AFX-382).
+     * Base64 of the JSON `{"action":"SPONSOR_GAS","date":<unix seconds>}` signed
+     * by `walletAddress`. Proves who is asking, not what for; the gas pool won't
+     * hand out a sponsorship without it. Reusable for a day either side of
+     * `date`, so sign once, cache it, and send it with every sponsored tx.
      */
     bytes?: string;
-    /** `walletAddress`'s signature over `bytes` (the cached T&C signature). */
+    /** `walletAddress`'s signature over `bytes`. */
     signature?: string;
 }
 /**
@@ -6418,13 +6414,6 @@ interface ApiReferralsCreateReferralLinkBody {
      * The signature of the message signed by the user's wallet. Required for authentication.
      */
     signature: string;
-    /**
-     * Desired referral code. Optional: when omitted the service defaults to
-     * `ref_{walletAddress}`. The signed message no longer carries it, so it must
-     * travel in the body (AFX-382). Note the default exceeds the 32-character
-     * limit, so callers should always send an explicit `refCode`.
-     */
-    refCode?: string;
 }
 interface ApiReferralsCreateReferralLinkResponse {
     /**
@@ -6457,11 +6446,6 @@ interface ApiReferralsSetReferrerBody {
      * The signature of the message signed by the referee's wallet. Required for authentication.
      */
     signature: string;
-    /**
-     * The referral code to link the referee to. Required: the signed message no
-     * longer carries it, so it must travel in the body (AFX-382).
-     */
-    refCode: string;
 }
 interface ApiReferralsSetReferrerResponse {
     /**
@@ -13437,11 +13421,6 @@ interface ApiDcaTransactionForCloseOrderBody {
      * The user's signature corresponding to `bytes`.
      */
     signature: string;
-    /**
-     * The order object IDs to cancel. Required: the signed message no longer
-     * carries them, so they must travel in the body (AFX-382).
-     */
-    orderObjectIds: string[];
 }
 /**
  * Enumerates reasons that a DCA trade might fail, e.g., the price was out of bounds
@@ -13766,11 +13745,15 @@ declare class Dca extends Caller {
      * The user can sign this message (converted to bytes) locally, then submit the signature to
      * `closeDcaOrder`.
      *
-     * @deprecated af-fe no longer accepts this per-action message. Sign
-     * `UserData.createTermsAndConditionsMessage` and pass `orderObjectIds` in the
-     * `closeDcaOrder` body instead (AFX-382).
      * @param inputs - An object containing `orderIds`, an array of order object IDs to cancel.
      * @returns An object with `action: "CANCEL_DCA_ORDERS"` and the `order_object_ids`.
+     *
+     * @example
+     * ```typescript
+     * const msg = dca.closeDcaOrdersMessageToSign({ orderIds: ["0x<order1>", "0x<order2>"] });
+     * console.log(msg);
+     * // sign this as JSON or string-encode, then pass to closeDcaOrder
+     * ```
      */
     closeDcaOrdersMessageToSign(inputs: {
         orderIds: ObjectId[];
@@ -13890,11 +13873,6 @@ interface ApiLimitOrdersCancelOrderTransactionBody {
      * The signature over those bytes, verifying user intent.
      */
     signature: string;
-    /**
-     * The order object IDs to cancel. Required: the signed message no longer
-     * carries them, so they must travel in the body (AFX-382).
-     */
-    orderObjectIds: string[];
 }
 /**
  * Enumerates all possible statuses for a limit order on Aftermath.
@@ -14095,11 +14073,16 @@ declare class LimitOrders extends Caller {
      * signs this message (converted to bytes), and the resulting signature is passed
      * to `cancelLimitOrder`.
      *
-     * @deprecated af-fe no longer accepts this per-action message. Sign
-     * `UserData.createTermsAndConditionsMessage` and pass `orderObjectIds` in the
-     * `cancelLimitOrder` body instead (AFX-382).
      * @param inputs - Object with `orderIds`, an array of order object IDs to cancel.
      * @returns A JSON structure with the action and order IDs to be canceled.
+     *
+     * @example
+     * ```typescript
+     * const msg = limitOrders.cancelLimitOrdersMessageToSign({
+     *   orderIds: ["0x<order1>", "0x<order2>"]
+     * });
+     * // user signs this JSON
+     * ```
      */
     cancelLimitOrdersMessageToSign(inputs: {
         orderIds: ObjectId[];
@@ -14196,11 +14179,6 @@ declare class Referrals extends Caller {
     isRefCodeTaken(inputs: ApiReferralsIsRefCodeTakenBody): Promise<ApiReferralsIsRefCodeTakenResponse>;
     createReferralLink(inputs: ApiReferralsCreateReferralLinkBody): Promise<ApiReferralsCreateReferralLinkResponse>;
     setReferrer(inputs: ApiReferralsSetReferrerBody): Promise<ApiReferralsSetReferrerResponse>;
-    /**
-     * @deprecated af-fe no longer accepts this per-action message. Sign
-     * `UserData.createTermsAndConditionsMessage` and pass `refCode` in the
-     * `createReferralLink` body instead (AFX-382).
-     */
     createReferralLinkMessageToSign(inputs: {
         refCode: string;
     }): {
@@ -14208,11 +14186,6 @@ declare class Referrals extends Caller {
         ref_code: string;
         date: number;
     };
-    /**
-     * @deprecated af-fe no longer accepts this per-action message. Sign
-     * `UserData.createTermsAndConditionsMessage` and pass `refCode` in the
-     * `setReferrer` body instead (AFX-382).
-     */
     setReferrerMessageToSign(inputs: {
         refCode: string;
     }): {
@@ -14340,39 +14313,19 @@ declare class UserData extends Caller {
         action: string;
     };
     /**
-     * The single message every wallet signs once per session to prove ownership.
-     * af-fe decodes the personal-message bytes and compares this text byte for
-     * byte, so it must stay exactly this string: no JSON wrapper, action, date,
-     * or trailing whitespace (AFX-382).
-     */
-    static readonly termsAndConditionsMessage = "Aftermath Terms and Conditions";
-    /**
-     * Returns the canonical Terms and Conditions message to sign. Sign it as a
-     * personal message over its UTF-8 bytes and reuse the signature for the whole
-     * session: it is the one credential af-fe verifies for referrals, rewards,
-     * stop/twap order datas, collateral/order history, the websocket `user`
-     * subscription, and gas-pool sponsorship (AFX-382).
+     * Generates a simple message object that the user should sign to confirm their agreement
+     * with the Terms and Conditions of the service.
      *
-     * @returns The exact string to sign.
+     * @returns An object with an `action` property set to "SIGN_TERMS_AND_CONDITIONS".
      *
      * @example
      * ```typescript
-     * const message = new UserData().createTermsAndConditionsMessage();
-     * const { bytes, signature } = await signPersonalMessage(
-     *   new TextEncoder().encode(message)
-     * );
+     * const userData = new UserData();
+     * const termsMsg = userData.createSignTermsAndConditionsMessageToSign();
+     * console.log(termsMsg.action); // "SIGN_TERMS_AND_CONDITIONS"
+     * // The user can sign this to show acceptance of the T&C.
      * ```
      */
-    createTermsAndConditionsMessage(): string;
-    /**
-     * Generates a simple message object that the user should sign to confirm their agreement
-     * with the Terms and Conditions of the service.
-     *
-     * @deprecated af-fe no longer accepts the `{action:...}` wrapper and rejects
-     * it with error 2034. Sign {@link createTermsAndConditionsMessage} instead
-     * (AFX-382).
-     * @returns An object with an `action` property set to "SIGN_TERMS_AND_CONDITIONS".
-     */
     createSignTermsAndConditionsMessageToSign(): {
         action: string;
     };

package/dist/index.js

@@ -15198,11 +15198,15 @@ var init_dca = __esm({
        * The user can sign this message (converted to bytes) locally, then submit the signature to
        * `closeDcaOrder`.
        *
-       * @deprecated af-fe no longer accepts this per-action message. Sign
-       * `UserData.createTermsAndConditionsMessage` and pass `orderObjectIds` in the
-       * `closeDcaOrder` body instead (AFX-382).
        * @param inputs - An object containing `orderIds`, an array of order object IDs to cancel.
        * @returns An object with `action: "CANCEL_DCA_ORDERS"` and the `order_object_ids`.
+       *
+       * @example
+       * ```typescript
+       * const msg = dca.closeDcaOrdersMessageToSign({ orderIds: ["0x<order1>", "0x<order2>"] });
+       * console.log(msg);
+       * // sign this as JSON or string-encode, then pass to closeDcaOrder
+       * ```
        */
       closeDcaOrdersMessageToSign(inputs) {
         return {
@@ -15386,11 +15390,16 @@ var init_limitOrders = __esm({
        * signs this message (converted to bytes), and the resulting signature is passed
        * to `cancelLimitOrder`.
        *
-       * @deprecated af-fe no longer accepts this per-action message. Sign
-       * `UserData.createTermsAndConditionsMessage` and pass `orderObjectIds` in the
-       * `cancelLimitOrder` body instead (AFX-382).
        * @param inputs - Object with `orderIds`, an array of order object IDs to cancel.
        * @returns A JSON structure with the action and order IDs to be canceled.
+       *
+       * @example
+       * ```typescript
+       * const msg = limitOrders.cancelLimitOrdersMessageToSign({
+       *   orderIds: ["0x<order1>", "0x<order2>"]
+       * });
+       * // user signs this JSON
+       * ```
        */
       cancelLimitOrdersMessageToSign(inputs) {
         return {
@@ -15557,11 +15566,6 @@ var init_referrals = __esm({
       // 		date: Date.now(),
       // 	};
       // }
-      /**
-       * @deprecated af-fe no longer accepts this per-action message. Sign
-       * `UserData.createTermsAndConditionsMessage` and pass `refCode` in the
-       * `createReferralLink` body instead (AFX-382).
-       */
       createReferralLinkMessageToSign(inputs) {
         return {
           action: "CREATE_REFERRAL",
@@ -15569,11 +15573,6 @@ var init_referrals = __esm({
           date: Math.round(Date.now() / 1e3)
         };
       }
-      /**
-       * @deprecated af-fe no longer accepts this per-action message. Sign
-       * `UserData.createTermsAndConditionsMessage` and pass `refCode` in the
-       * `setReferrer` body instead (AFX-382).
-       */
       setReferrerMessageToSign(inputs) {
         return {
           action: "LINK_REFERRAL",
@@ -15650,12 +15649,12 @@ var init_rewards = __esm({
 });
 
 // src/packages/userData/userData.ts
-var _UserData, UserData;
+var UserData;
 var init_userData = __esm({
   "src/packages/userData/userData.ts"() {
     "use strict";
     init_caller();
-    _UserData = class _UserData extends Caller {
+    UserData = class extends Caller {
       // =========================================================================
       //  Constructor
       // =========================================================================
@@ -15737,48 +15736,25 @@ var init_userData = __esm({
         };
       }
       /**
-       * Returns the canonical Terms and Conditions message to sign. Sign it as a
-       * personal message over its UTF-8 bytes and reuse the signature for the whole
-       * session: it is the one credential af-fe verifies for referrals, rewards,
-       * stop/twap order datas, collateral/order history, the websocket `user`
-       * subscription, and gas-pool sponsorship (AFX-382).
+       * Generates a simple message object that the user should sign to confirm their agreement
+       * with the Terms and Conditions of the service.
        *
-       * @returns The exact string to sign.
+       * @returns An object with an `action` property set to "SIGN_TERMS_AND_CONDITIONS".
        *
        * @example
        * ```typescript
-       * const message = new UserData().createTermsAndConditionsMessage();
-       * const { bytes, signature } = await signPersonalMessage(
-       *   new TextEncoder().encode(message)
-       * );
+       * const userData = new UserData();
+       * const termsMsg = userData.createSignTermsAndConditionsMessageToSign();
+       * console.log(termsMsg.action); // "SIGN_TERMS_AND_CONDITIONS"
+       * // The user can sign this to show acceptance of the T&C.
        * ```
        */
-      createTermsAndConditionsMessage() {
-        return _UserData.termsAndConditionsMessage;
-      }
-      /**
-       * Generates a simple message object that the user should sign to confirm their agreement
-       * with the Terms and Conditions of the service.
-       *
-       * @deprecated af-fe no longer accepts the `{action:...}` wrapper and rejects
-       * it with error 2034. Sign {@link createTermsAndConditionsMessage} instead
-       * (AFX-382).
-       * @returns An object with an `action` property set to "SIGN_TERMS_AND_CONDITIONS".
-       */
       createSignTermsAndConditionsMessageToSign() {
         return {
           action: "SIGN_TERMS_AND_CONDITIONS"
         };
       }
     };
-    /**
-     * The single message every wallet signs once per session to prove ownership.
-     * af-fe decodes the personal-message bytes and compares this text byte for
-     * byte, so it must stay exactly this string: no JSON wrapper, action, date,
-     * or trailing whitespace (AFX-382).
-     */
-    _UserData.termsAndConditionsMessage = "Aftermath Terms and Conditions";
-    UserData = _UserData;
   }
 });