aftermath-ts-sdk 2.3.0-dev.ae28999 → 2.3.0-dev.c42d7d2

package/dist/index.d.ts

@@ -1547,16 +1547,20 @@ interface ApiNftAmmWithdrawBody {
  * that debits the specified wallet's gas pool.
  */
 interface PerpetualsSponsorConfig {
-    /** Wallet address to use for gas pool sponsorship. */
+    /**
+     * 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.
+     */
     walletAddress: SuiAddress;
     /**
-     * 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.
+     * 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.
      */
     bytes?: string;
-    /** `walletAddress`'s signature over `bytes`. */
+    /** `walletAddress`'s signature over `bytes` (the cached T&C signature). */
     signature?: string;
 }
 /**
@@ -6414,6 +6418,11 @@ interface ApiReferralsCreateReferralLinkBody {
      * The signature of the message signed by the user's wallet. Required for authentication.
      */
     signature: string;
+    /**
+     * The referral code to create. The signed message no longer carries it, so
+     * it travels in the body.
+     */
+    refCode: string;
 }
 interface ApiReferralsCreateReferralLinkResponse {
     /**
@@ -6446,6 +6455,11 @@ 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.
+     */
+    refCode: string;
 }
 interface ApiReferralsSetReferrerResponse {
     /**
@@ -13421,6 +13435,11 @@ 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.
+     */
+    orderObjectIds: string[];
 }
 /**
  * Enumerates reasons that a DCA trade might fail, e.g., the price was out of bounds
@@ -13745,15 +13764,11 @@ 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.
      * @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[];
@@ -13873,6 +13888,11 @@ 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.
+     */
+    orderObjectIds: string[];
 }
 /**
  * Enumerates all possible statuses for a limit order on Aftermath.
@@ -14073,16 +14093,11 @@ 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.
      * @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[];
@@ -14179,6 +14194,11 @@ 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.
+     */
     createReferralLinkMessageToSign(inputs: {
         refCode: string;
     }): {
@@ -14186,6 +14206,11 @@ 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.
+     */
     setReferrerMessageToSign(inputs: {
         refCode: string;
     }): {
@@ -14313,19 +14338,38 @@ declare class UserData extends Caller {
         action: string;
     };
     /**
-     * Generates a simple message object that the user should sign to confirm their agreement
-     * with the Terms and Conditions of the service.
+     * 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.
+     */
+    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.
      *
-     * @returns An object with an `action` property set to "SIGN_TERMS_AND_CONDITIONS".
+     * @returns The exact string to sign.
      *
      * @example
      * ```typescript
-     * 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.
+     * const message = new UserData().createTermsAndConditionsMessage();
+     * const { bytes, signature } = await signPersonalMessage(
+     *   new TextEncoder().encode(message)
+     * );
      * ```
      */
+    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.
+     * @returns An object with an `action` property set to "SIGN_TERMS_AND_CONDITIONS".
+     */
     createSignTermsAndConditionsMessageToSign(): {
         action: string;
     };

package/dist/index.js

@@ -15198,15 +15198,11 @@ 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.
        * @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 {
@@ -15390,16 +15386,11 @@ 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.
        * @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 {
@@ -15566,6 +15557,11 @@ 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.
+       */
       createReferralLinkMessageToSign(inputs) {
         return {
           action: "CREATE_REFERRAL",
@@ -15573,6 +15569,11 @@ 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.
+       */
       setReferrerMessageToSign(inputs) {
         return {
           action: "LINK_REFERRAL",
@@ -15649,12 +15650,12 @@ var init_rewards = __esm({
 });
 
 // src/packages/userData/userData.ts
-var UserData;
+var _UserData, UserData;
 var init_userData = __esm({
   "src/packages/userData/userData.ts"() {
     "use strict";
     init_caller();
-    UserData = class extends Caller {
+    _UserData = class _UserData extends Caller {
       // =========================================================================
       //  Constructor
       // =========================================================================
@@ -15736,25 +15737,47 @@ var init_userData = __esm({
         };
       }
       /**
-       * Generates a simple message object that the user should sign to confirm their agreement
-       * with the Terms and Conditions of the service.
+       * 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.
        *
-       * @returns An object with an `action` property set to "SIGN_TERMS_AND_CONDITIONS".
+       * @returns The exact string to sign.
        *
        * @example
        * ```typescript
-       * 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.
+       * const message = new UserData().createTermsAndConditionsMessage();
+       * const { bytes, signature } = await signPersonalMessage(
+       *   new TextEncoder().encode(message)
+       * );
        * ```
        */
+      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.
+       * @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.
+     */
+    _UserData.termsAndConditionsMessage = "Aftermath Terms and Conditions";
+    UserData = _UserData;
   }
 });