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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1550,14 +1550,14 @@ interface PerpetualsSponsorConfig {
1550
1550
  /**
1551
1551
  * Wallet address to use for gas pool sponsorship. Must be the connected
1552
1552
  * wallet: af-fe now verifies the sponsor and refuses a request naming any
1553
- * other address with error 2034 before it reaches the pool (AFX-382).
1553
+ * other address with error 2034 before it reaches the pool.
1554
1554
  */
1555
1555
  walletAddress: SuiAddress;
1556
1556
  /**
1557
1557
  * Base64 UTF-8 bytes of the Terms and Conditions message (see
1558
1558
  * `UserData.createTermsAndConditionsMessage`), signed once by `walletAddress`
1559
1559
  * and cached for the session. Sending this cached signature is all the gas
1560
- * pool needs; it replaces the old per-tx `SPONSOR_GAS` payload (AFX-382).
1560
+ * pool needs; it replaces the old per-tx `SPONSOR_GAS` payload.
1561
1561
  */
1562
1562
  bytes?: string;
1563
1563
  /** `walletAddress`'s signature over `bytes` (the cached T&C signature). */
@@ -6419,12 +6419,10 @@ interface ApiReferralsCreateReferralLinkBody {
6419
6419
  */
6420
6420
  signature: string;
6421
6421
  /**
6422
- * Desired referral code. Optional: when omitted the service defaults to
6423
- * `ref_{walletAddress}`. The signed message no longer carries it, so it must
6424
- * travel in the body (AFX-382). Note the default exceeds the 32-character
6425
- * limit, so callers should always send an explicit `refCode`.
6422
+ * The referral code to create. The signed message no longer carries it, so
6423
+ * it travels in the body.
6426
6424
  */
6427
- refCode?: string;
6425
+ refCode: string;
6428
6426
  }
6429
6427
  interface ApiReferralsCreateReferralLinkResponse {
6430
6428
  /**
@@ -6459,7 +6457,7 @@ interface ApiReferralsSetReferrerBody {
6459
6457
  signature: string;
6460
6458
  /**
6461
6459
  * The referral code to link the referee to. Required: the signed message no
6462
- * longer carries it, so it must travel in the body (AFX-382).
6460
+ * longer carries it, so it must travel in the body.
6463
6461
  */
6464
6462
  refCode: string;
6465
6463
  }
@@ -13439,7 +13437,7 @@ interface ApiDcaTransactionForCloseOrderBody {
13439
13437
  signature: string;
13440
13438
  /**
13441
13439
  * The order object IDs to cancel. Required: the signed message no longer
13442
- * carries them, so they must travel in the body (AFX-382).
13440
+ * carries them, so they must travel in the body.
13443
13441
  */
13444
13442
  orderObjectIds: string[];
13445
13443
  }
@@ -13768,7 +13766,7 @@ declare class Dca extends Caller {
13768
13766
  *
13769
13767
  * @deprecated af-fe no longer accepts this per-action message. Sign
13770
13768
  * `UserData.createTermsAndConditionsMessage` and pass `orderObjectIds` in the
13771
- * `closeDcaOrder` body instead (AFX-382).
13769
+ * `closeDcaOrder` body instead.
13772
13770
  * @param inputs - An object containing `orderIds`, an array of order object IDs to cancel.
13773
13771
  * @returns An object with `action: "CANCEL_DCA_ORDERS"` and the `order_object_ids`.
13774
13772
  */
@@ -13892,7 +13890,7 @@ interface ApiLimitOrdersCancelOrderTransactionBody {
13892
13890
  signature: string;
13893
13891
  /**
13894
13892
  * The order object IDs to cancel. Required: the signed message no longer
13895
- * carries them, so they must travel in the body (AFX-382).
13893
+ * carries them, so they must travel in the body.
13896
13894
  */
13897
13895
  orderObjectIds: string[];
13898
13896
  }
@@ -14097,7 +14095,7 @@ declare class LimitOrders extends Caller {
14097
14095
  *
14098
14096
  * @deprecated af-fe no longer accepts this per-action message. Sign
14099
14097
  * `UserData.createTermsAndConditionsMessage` and pass `orderObjectIds` in the
14100
- * `cancelLimitOrder` body instead (AFX-382).
14098
+ * `cancelLimitOrder` body instead.
14101
14099
  * @param inputs - Object with `orderIds`, an array of order object IDs to cancel.
14102
14100
  * @returns A JSON structure with the action and order IDs to be canceled.
14103
14101
  */
@@ -14199,7 +14197,7 @@ declare class Referrals extends Caller {
14199
14197
  /**
14200
14198
  * @deprecated af-fe no longer accepts this per-action message. Sign
14201
14199
  * `UserData.createTermsAndConditionsMessage` and pass `refCode` in the
14202
- * `createReferralLink` body instead (AFX-382).
14200
+ * `createReferralLink` body instead.
14203
14201
  */
14204
14202
  createReferralLinkMessageToSign(inputs: {
14205
14203
  refCode: string;
@@ -14211,7 +14209,7 @@ declare class Referrals extends Caller {
14211
14209
  /**
14212
14210
  * @deprecated af-fe no longer accepts this per-action message. Sign
14213
14211
  * `UserData.createTermsAndConditionsMessage` and pass `refCode` in the
14214
- * `setReferrer` body instead (AFX-382).
14212
+ * `setReferrer` body instead.
14215
14213
  */
14216
14214
  setReferrerMessageToSign(inputs: {
14217
14215
  refCode: string;
@@ -14343,7 +14341,7 @@ declare class UserData extends Caller {
14343
14341
  * The single message every wallet signs once per session to prove ownership.
14344
14342
  * af-fe decodes the personal-message bytes and compares this text byte for
14345
14343
  * byte, so it must stay exactly this string: no JSON wrapper, action, date,
14346
- * or trailing whitespace (AFX-382).
14344
+ * or trailing whitespace.
14347
14345
  */
14348
14346
  static readonly termsAndConditionsMessage = "Aftermath Terms and Conditions";
14349
14347
  /**
@@ -14351,7 +14349,7 @@ declare class UserData extends Caller {
14351
14349
  * personal message over its UTF-8 bytes and reuse the signature for the whole
14352
14350
  * session: it is the one credential af-fe verifies for referrals, rewards,
14353
14351
  * stop/twap order datas, collateral/order history, the websocket `user`
14354
- * subscription, and gas-pool sponsorship (AFX-382).
14352
+ * subscription, and gas-pool sponsorship.
14355
14353
  *
14356
14354
  * @returns The exact string to sign.
14357
14355
  *
@@ -14369,8 +14367,7 @@ declare class UserData extends Caller {
14369
14367
  * with the Terms and Conditions of the service.
14370
14368
  *
14371
14369
  * @deprecated af-fe no longer accepts the `{action:...}` wrapper and rejects
14372
- * it with error 2034. Sign {@link createTermsAndConditionsMessage} instead
14373
- * (AFX-382).
14370
+ * it with error 2034. Sign {@link createTermsAndConditionsMessage} instead.
14374
14371
  * @returns An object with an `action` property set to "SIGN_TERMS_AND_CONDITIONS".
14375
14372
  */
14376
14373
  createSignTermsAndConditionsMessageToSign(): {
package/dist/index.js CHANGED
@@ -15200,7 +15200,7 @@ var init_dca = __esm({
15200
15200
  *
15201
15201
  * @deprecated af-fe no longer accepts this per-action message. Sign
15202
15202
  * `UserData.createTermsAndConditionsMessage` and pass `orderObjectIds` in the
15203
- * `closeDcaOrder` body instead (AFX-382).
15203
+ * `closeDcaOrder` body instead.
15204
15204
  * @param inputs - An object containing `orderIds`, an array of order object IDs to cancel.
15205
15205
  * @returns An object with `action: "CANCEL_DCA_ORDERS"` and the `order_object_ids`.
15206
15206
  */
@@ -15388,7 +15388,7 @@ var init_limitOrders = __esm({
15388
15388
  *
15389
15389
  * @deprecated af-fe no longer accepts this per-action message. Sign
15390
15390
  * `UserData.createTermsAndConditionsMessage` and pass `orderObjectIds` in the
15391
- * `cancelLimitOrder` body instead (AFX-382).
15391
+ * `cancelLimitOrder` body instead.
15392
15392
  * @param inputs - Object with `orderIds`, an array of order object IDs to cancel.
15393
15393
  * @returns A JSON structure with the action and order IDs to be canceled.
15394
15394
  */
@@ -15560,7 +15560,7 @@ var init_referrals = __esm({
15560
15560
  /**
15561
15561
  * @deprecated af-fe no longer accepts this per-action message. Sign
15562
15562
  * `UserData.createTermsAndConditionsMessage` and pass `refCode` in the
15563
- * `createReferralLink` body instead (AFX-382).
15563
+ * `createReferralLink` body instead.
15564
15564
  */
15565
15565
  createReferralLinkMessageToSign(inputs) {
15566
15566
  return {
@@ -15572,7 +15572,7 @@ var init_referrals = __esm({
15572
15572
  /**
15573
15573
  * @deprecated af-fe no longer accepts this per-action message. Sign
15574
15574
  * `UserData.createTermsAndConditionsMessage` and pass `refCode` in the
15575
- * `setReferrer` body instead (AFX-382).
15575
+ * `setReferrer` body instead.
15576
15576
  */
15577
15577
  setReferrerMessageToSign(inputs) {
15578
15578
  return {
@@ -15741,7 +15741,7 @@ var init_userData = __esm({
15741
15741
  * personal message over its UTF-8 bytes and reuse the signature for the whole
15742
15742
  * session: it is the one credential af-fe verifies for referrals, rewards,
15743
15743
  * stop/twap order datas, collateral/order history, the websocket `user`
15744
- * subscription, and gas-pool sponsorship (AFX-382).
15744
+ * subscription, and gas-pool sponsorship.
15745
15745
  *
15746
15746
  * @returns The exact string to sign.
15747
15747
  *
@@ -15761,8 +15761,7 @@ var init_userData = __esm({
15761
15761
  * with the Terms and Conditions of the service.
15762
15762
  *
15763
15763
  * @deprecated af-fe no longer accepts the `{action:...}` wrapper and rejects
15764
- * it with error 2034. Sign {@link createTermsAndConditionsMessage} instead
15765
- * (AFX-382).
15764
+ * it with error 2034. Sign {@link createTermsAndConditionsMessage} instead.
15766
15765
  * @returns An object with an `action` property set to "SIGN_TERMS_AND_CONDITIONS".
15767
15766
  */
15768
15767
  createSignTermsAndConditionsMessageToSign() {
@@ -15775,7 +15774,7 @@ var init_userData = __esm({
15775
15774
  * The single message every wallet signs once per session to prove ownership.
15776
15775
  * af-fe decodes the personal-message bytes and compares this text byte for
15777
15776
  * byte, so it must stay exactly this string: no JSON wrapper, action, date,
15778
- * or trailing whitespace (AFX-382).
15777
+ * or trailing whitespace.
15779
15778
  */
15780
15779
  _UserData.termsAndConditionsMessage = "Aftermath Terms and Conditions";
15781
15780
  UserData = _UserData;