@compass-labs/api-sdk 0.5.45 → 0.5.46

package/dist/esm/sdk/pendle.d.ts

@@ -42,6 +42,13 @@ export declare class Pendle extends ClientSDK {
      *
      * @remarks
      * Buy Principal Token (PT) with market's Underlying Token.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     buyPt(request: components.PendleBuyPtRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -49,6 +56,13 @@ export declare class Pendle extends ClientSDK {
      *
      * @remarks
      * Sell Principal Token (PT) for the market's Underlying Token.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     sellPt(request: components.PendleSellPtRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -56,6 +70,13 @@ export declare class Pendle extends ClientSDK {
      *
      * @remarks
      * Buy Yield Token (YT) with market's Underlying Token.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     buyYt(request: components.PendleBuyYtRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -63,6 +84,13 @@ export declare class Pendle extends ClientSDK {
      *
      * @remarks
      * Sell Yield Token (YT) for the market's Underlying Token.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     sellYt(request: components.PendleSellYtRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -70,6 +98,13 @@ export declare class Pendle extends ClientSDK {
      *
      * @remarks
      * Redeem claimable yield from the market's associated Yield Token (YT).
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     redeemYield(request: components.PendleRedeemYieldRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -80,6 +115,13 @@ export declare class Pendle extends ClientSDK {
      *
      * Liquidity is added in the form of the market's Underlying Token. Representation of
      * the liquidity received is the market's Liquidity Provider Token (LP).
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     addLiquidity(request: components.PendleAddLiquidityRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -91,6 +133,13 @@ export declare class Pendle extends ClientSDK {
      * Liquidity is removed in the form of the market's Liquidity Provider Token (LP) into
      * the market's Underlying Token. An appropriate allowance for the Pendle Router on the
      * market contract must be set beforehand
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     removeLiquidity(request: components.PendleRemoveLiquidityRequest, options?: RequestOptions): Promise<components.TxResponse>;
 }

package/dist/esm/sdk/pendle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pendle.d.ts","sourceRoot":"","sources":["../../../src/sdk/pendle.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;OAOG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;OAKG;IACG,SAAS,CACb,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC;IAQtD;;;;;OAKG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAQhD;;;;;;;;;;OAUG;IACG,KAAK,CACT,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;OAKG;IACG,KAAK,CACT,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;OAKG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;OAKG;IACG,KAAK,CACT,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;OAKG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;OAKG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;OAQG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;OASG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;CAOlC"}
+{"version":3,"file":"pendle.d.ts","sourceRoot":"","sources":["../../../src/sdk/pendle.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;OAOG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;OAKG;IACG,SAAS,CACb,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC;IAQtD;;;;;OAKG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAQhD;;;;;;;;;;OAUG;IACG,KAAK,CACT,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;;;;;;OAYG;IACG,KAAK,CACT,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;OAYG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;OAYG;IACG,KAAK,CACT,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;OAYG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;OAYG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;;;;OAgBG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;CAOlC"}

package/dist/esm/sdk/pendle.js

@@ -63,6 +63,13 @@ export class Pendle extends ClientSDK {
      *
      * @remarks
      * Buy Principal Token (PT) with market's Underlying Token.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     async buyPt(request, options) {
         return unwrapAsync(pendleBuyPt(this, request, options));
@@ -72,6 +79,13 @@ export class Pendle extends ClientSDK {
      *
      * @remarks
      * Sell Principal Token (PT) for the market's Underlying Token.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     async sellPt(request, options) {
         return unwrapAsync(pendleSellPt(this, request, options));
@@ -81,6 +95,13 @@ export class Pendle extends ClientSDK {
      *
      * @remarks
      * Buy Yield Token (YT) with market's Underlying Token.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     async buyYt(request, options) {
         return unwrapAsync(pendleBuyYt(this, request, options));
@@ -90,6 +111,13 @@ export class Pendle extends ClientSDK {
      *
      * @remarks
      * Sell Yield Token (YT) for the market's Underlying Token.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     async sellYt(request, options) {
         return unwrapAsync(pendleSellYt(this, request, options));
@@ -99,6 +127,13 @@ export class Pendle extends ClientSDK {
      *
      * @remarks
      * Redeem claimable yield from the market's associated Yield Token (YT).
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     async redeemYield(request, options) {
         return unwrapAsync(pendleRedeemYield(this, request, options));
@@ -111,6 +146,13 @@ export class Pendle extends ClientSDK {
      *
      * Liquidity is added in the form of the market's Underlying Token. Representation of
      * the liquidity received is the market's Liquidity Provider Token (LP).
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     async addLiquidity(request, options) {
         return unwrapAsync(pendleAddLiquidity(this, request, options));
@@ -124,6 +166,13 @@ export class Pendle extends ClientSDK {
      * Liquidity is removed in the form of the market's Liquidity Provider Token (LP) into
      * the market's Underlying Token. An appropriate allowance for the Pendle Router on the
      * market contract must be set beforehand
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `PendleRouter`
+     * </Info>
      */
     async removeLiquidity(request, options) {
         return unwrapAsync(pendleRemoveLiquidity(this, request, options));

package/dist/esm/sdk/pendle.js.map

@@ -1 +1 @@
-{"version":3,"file":"pendle.js","sourceRoot":"","sources":["../../../src/sdk/pendle.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,eAAe,CAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAChB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CACnB,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"pendle.js","sourceRoot":"","sources":["../../../src/sdk/pendle.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,eAAe,CAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CACT,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,MAAM,CACV,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAAW,CACf,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,YAAY,CAChB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,eAAe,CACnB,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/sky.d.ts

@@ -20,6 +20,13 @@ export declare class Sky extends ClientSDK {
      *
      * If buying with USDC, user will need to set an allowance on the USDC contract for the
      * 'SkyUsdcUsdsConverter' contract beforehand.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `SkyUsdcUsdsConverter`
+     * </Info>
      */
     buy(request: components.SkyBuyRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -33,6 +40,13 @@ export declare class Sky extends ClientSDK {
      *
      * If swapping to USDC, user will need to set an allowance on the USDS contract for the
      * 'SkyUsdcUsdsConverter' contract beforehand.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `SkyUsdcUsdsConverter`
+     * </Info>
      */
     sell(request: components.SkySellRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -44,6 +58,13 @@ export declare class Sky extends ClientSDK {
      * Allowance must be set on USDS contract for UsdsVault.
      *
      * There are no fees.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `SkyUsdsVault`
+     * </Info>
      */
     deposit(request: components.SkyDepositRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -55,6 +76,14 @@ export declare class Sky extends ClientSDK {
      * Allowance must be set on USDS contract for UsdsVault.
      *
      * There are no fees.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `SkyUsdcUsdsConverter`
+     *  - `SkyUsdsVault`
+     * </Info>
      */
     withdraw(request: components.SkyWithdrawRequest, options?: RequestOptions): Promise<components.TxResponse>;
 }

package/dist/esm/sdk/sky.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sky.d.ts","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;OAWG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,aAAa,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;OAWG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,cAAc,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;OASG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;OASG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;CAOlC"}
+{"version":3,"file":"sky.d.ts","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;;;;;;;;OAkBG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,aAAa,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,cAAc,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;;;;OAgBG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;;;;;OAiBG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;CAOlC"}

package/dist/esm/sdk/sky.js

@@ -29,6 +29,13 @@ export class Sky extends ClientSDK {
      *
      * If buying with USDC, user will need to set an allowance on the USDC contract for the
      * 'SkyUsdcUsdsConverter' contract beforehand.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `SkyUsdcUsdsConverter`
+     * </Info>
      */
     async buy(request, options) {
         return unwrapAsync(skyBuy(this, request, options));
@@ -44,6 +51,13 @@ export class Sky extends ClientSDK {
      *
      * If swapping to USDC, user will need to set an allowance on the USDS contract for the
      * 'SkyUsdcUsdsConverter' contract beforehand.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `SkyUsdcUsdsConverter`
+     * </Info>
      */
     async sell(request, options) {
         return unwrapAsync(skySell(this, request, options));
@@ -57,6 +71,13 @@ export class Sky extends ClientSDK {
      * Allowance must be set on USDS contract for UsdsVault.
      *
      * There are no fees.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `SkyUsdsVault`
+     * </Info>
      */
     async deposit(request, options) {
         return unwrapAsync(skyDeposit(this, request, options));
@@ -70,6 +91,14 @@ export class Sky extends ClientSDK {
      * Allowance must be set on USDS contract for UsdsVault.
      *
      * There are no fees.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `SkyUsdcUsdsConverter`
+     *  - `SkyUsdsVault`
+     * </Info>
      */
     async withdraw(request, options) {
         return unwrapAsync(skyWithdraw(this, request, options));

package/dist/esm/sdk/sky.js.map

@@ -1 +1 @@
-{"version":3,"file":"sky.js","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,GAAG,CACP,OAAiC,EACjC,OAAwB;QAExB,OAAO,WAAW,CAAC,MAAM,CACvB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CACR,OAAkC,EAClC,OAAwB;QAExB,OAAO,WAAW,CAAC,OAAO,CACxB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAO,CACX,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,UAAU,CAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"sky.js","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,GAAG,CACP,OAAiC,EACjC,OAAwB;QAExB,OAAO,WAAW,CAAC,MAAM,CACvB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,IAAI,CACR,OAAkC,EAClC,OAAwB;QAExB,OAAO,WAAW,CAAC,OAAO,CACxB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,OAAO,CACX,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,UAAU,CAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/uniswapv3.d.ts

@@ -71,6 +71,13 @@ export declare class UniswapV3 extends ClientSDK {
      * provide the necessary transaction details, including the token to buy, the token to
      * pay with, and the exact amount to receive. If the token being paid with is WETH and
      * needs to be wrapped, the appropriate amount will be wrapped automatically.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `UniswapV3Router`
+     * </Info>
      */
     swapBuyExactly(request: components.UniswapBuyExactlyRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -84,6 +91,13 @@ export declare class UniswapV3 extends ClientSDK {
      * provide the necessary transaction details, including the token to sell, the token to
      * receive, and the amount to sell. If the token being sold is WETH and needs to be
      * wrapped, the appropriate amount will be wrapped automatically.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `UniswapV3Router`
+     * </Info>
      */
     swapSellExactly(request: components.UniswapSellExactlyRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -99,6 +113,13 @@ export declare class UniswapV3 extends ClientSDK {
      * enabling them to earn fees from trades that occur within the pool. The endpoint
      * requires details such as the token pair, amount, and any additional parameters
      * needed for the minting process.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `UniswapV3NFTPositionManager`
+     * </Info>
      */
     liquidityProvisionMint(request: components.UniswapMintLiquidityProvisionRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -114,6 +135,13 @@ export declare class UniswapV3 extends ClientSDK {
      * within the pool. The endpoint requires details such as the token pair, additional
      * amount to be added, and any other parameters necessary for the liquidity increase
      * process.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `AerodromeSlipstreamRouter`
+     * </Info>
      */
     liquidityProvisionIncrease(request: components.UniswapIncreaseLiquidityProvisionRequest, options?: RequestOptions): Promise<components.TxResponse>;
     /**
@@ -130,6 +158,13 @@ export declare class UniswapV3 extends ClientSDK {
      * amount to be withdrawn, and any additional parameters needed for the withdrawal
      * process. Users should ensure they meet any protocol requirements or conditions
      * before initiating a withdrawal to avoid potential issues or penalties.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `UniswapV3NFTPositionManager`
+     * </Info>
      */
     liquidityProvisionWithdraw(request: components.UniswapWithdrawLiquidityProvisionRequest, options?: RequestOptions): Promise<components.TxResponse>;
 }

package/dist/esm/sdk/uniswapv3.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uniswapv3.d.ts","sourceRoot":"","sources":["../../../src/sdk/uniswapv3.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,SAAU,SAAQ,SAAS;IACtC;;;;;;;;;OASG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;OASG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAQnD;;;;;;;OAOG;IACG,SAAS,CACb,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;;OAYG;IACG,yBAAyB,CAC7B,OAAO,EAAE,UAAU,CAAC,uCAAuC,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;;;OAWG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8BAA8B,CAAC;IAQrD;;;;;;;;;;;OAWG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;OAWG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;OAaG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;OAaG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,wCAAwC,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;;OAcG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,wCAAwC,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;CAOlC"}
+{"version":3,"file":"uniswapv3.d.ts","sourceRoot":"","sources":["../../../src/sdk/uniswapv3.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,SAAU,SAAQ,SAAS;IACtC;;;;;;;;;OASG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;OASG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAQnD;;;;;;;OAOG;IACG,SAAS,CACb,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;;OAYG;IACG,yBAAyB,CAC7B,OAAO,EAAE,UAAU,CAAC,uCAAuC,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;;;OAWG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,8BAA8B,CAAC;IAQrD;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;;;;;;OAkBG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,wCAAwC,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,wCAAwC,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;CAOlC"}

package/dist/esm/sdk/uniswapv3.js

@@ -93,6 +93,13 @@ export class UniswapV3 extends ClientSDK {
      * provide the necessary transaction details, including the token to buy, the token to
      * pay with, and the exact amount to receive. If the token being paid with is WETH and
      * needs to be wrapped, the appropriate amount will be wrapped automatically.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `UniswapV3Router`
+     * </Info>
      */
     async swapBuyExactly(request, options) {
         return unwrapAsync(uniswapV3SwapBuyExactly(this, request, options));
@@ -108,6 +115,13 @@ export class UniswapV3 extends ClientSDK {
      * provide the necessary transaction details, including the token to sell, the token to
      * receive, and the amount to sell. If the token being sold is WETH and needs to be
      * wrapped, the appropriate amount will be wrapped automatically.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `UniswapV3Router`
+     * </Info>
      */
     async swapSellExactly(request, options) {
         return unwrapAsync(uniswapV3SwapSellExactly(this, request, options));
@@ -125,6 +139,13 @@ export class UniswapV3 extends ClientSDK {
      * enabling them to earn fees from trades that occur within the pool. The endpoint
      * requires details such as the token pair, amount, and any additional parameters
      * needed for the minting process.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `UniswapV3NFTPositionManager`
+     * </Info>
      */
     async liquidityProvisionMint(request, options) {
         return unwrapAsync(uniswapV3LiquidityProvisionMint(this, request, options));
@@ -142,6 +163,13 @@ export class UniswapV3 extends ClientSDK {
      * within the pool. The endpoint requires details such as the token pair, additional
      * amount to be added, and any other parameters necessary for the liquidity increase
      * process.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `AerodromeSlipstreamRouter`
+     * </Info>
      */
     async liquidityProvisionIncrease(request, options) {
         return unwrapAsync(uniswapV3LiquidityProvisionIncrease(this, request, options));
@@ -160,6 +188,13 @@ export class UniswapV3 extends ClientSDK {
      * amount to be withdrawn, and any additional parameters needed for the withdrawal
      * process. Users should ensure they meet any protocol requirements or conditions
      * before initiating a withdrawal to avoid potential issues or penalties.
+     * <Info>
+     *   **Required Allowances**
+     *
+     *     In order to make this transaction, token allowances need to be set on the following contracts.
+     *
+     *  - `UniswapV3NFTPositionManager`
+     * </Info>
      */
     async liquidityProvisionWithdraw(request, options) {
         return unwrapAsync(uniswapV3LiquidityProvisionWithdraw(this, request, options));

package/dist/esm/sdk/uniswapv3.js.map

@@ -1 +1 @@
-{"version":3,"file":"uniswapv3.js","sourceRoot":"","sources":["../../../src/sdk/uniswapv3.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,kCAAkC,EAAE,MAAM,gDAAgD,CAAC;AACpG,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,oCAAoC,EAAE,MAAM,kDAAkD,CAAC;AACxG,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CACnB,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,CACb,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAA2D,EAC3D,OAAwB;QAExB,OAAO,WAAW,CAAC,kCAAkC,CACnD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAA6D,EAC7D,OAAwB;QAExB,OAAO,WAAW,CAAC,oCAAoC,CACrD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,cAAc,CAClB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,eAAe,CACnB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,+BAA+B,CAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"uniswapv3.js","sourceRoot":"","sources":["../../../src/sdk/uniswapv3.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,kCAAkC,EAAE,MAAM,gDAAgD,CAAC;AACpG,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,oCAAoC,EAAE,MAAM,kDAAkD,CAAC;AACxG,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CACnB,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,CACb,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAA2D,EAC3D,OAAwB;QAExB,OAAO,WAAW,CAAC,kCAAkC,CACnD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAA6D,EAC7D,OAAwB;QAExB,OAAO,WAAW,CAAC,oCAAoC,CACrD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,cAAc,CAClB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,eAAe,CACnB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,+BAA+B,CAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/sdks/aavev3/README.md

@@ -707,6 +707,14 @@ create leverage.
 Overall, this endpoint is a critical component for users looking to maximize their
 asset utility within the AAVEv3 ecosystem, providing both earning potential and
 borrowing flexibility.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AaveV3Pool`
+</Info>
+
 
 ### Example Usage
 
@@ -789,6 +797,14 @@ You will pay interest for your borrows.
 
 Price changes in the assets may lead to some or all of your collateral being
 liquidated, if the borrow position becomes unhealthy.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AaveV3Pool`
+</Info>
+
 
 ### Example Usage
 
@@ -877,6 +893,14 @@ measure of the safety of their loan position. A higher health factor reduces the
 risk of liquidation, ensuring a more secure borrowing experience. The endpoint
 requires specifying the chain and the details of the repayment transaction,
 including the amount and the asset to be repaid.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AaveV3Pool`
+</Info>
+
 
 ### Example Usage
 
@@ -966,6 +990,14 @@ for users to carefully consider their outstanding debts and the potential impact
 their liquidation threshold before proceeding with a withdrawal. This endpoint is
 designed to provide a seamless and efficient way to manage your collateral within
 the Aave ecosystem.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AaveV3Pool`
+</Info>
+
 
 ### Example Usage
 

package/docs/sdks/aerodromeslipstream/README.md

@@ -175,6 +175,14 @@ received. The operation ensures that the trade is conducted within the constrain
 of the current market conditions, taking into account the liquidity and price
 impact. This endpoint is suitable for users who want to sell a precise quantity of a
 token and are willing to accept the resulting amount of the other token.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AerodromeSlipstreamRouter`
+</Info>
+
 
 ### Example Usage
 
@@ -269,6 +277,14 @@ in mind and are willing to provide the corresponding input token amount. The
 transaction is executed with consideration of current market conditions, including
 liquidity and price impact, ensuring that the trade is completed efficiently and
 effectively.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AerodromeSlipstreamRouter`
+</Info>
+
 
 ### Example Usage
 
@@ -362,6 +378,14 @@ confirm the successful creation of the LP position, providing users with the
 necessary information to manage their newly minted position. This functionality is
 crucial for users looking to expand their liquidity provision activities, offering
 them the opportunity to engage in decentralized finance (DeFi) markets effectively.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AerodromeSlipstreamNonfungiblePositionManager`
+</Info>
+
 
 ### Example Usage
 
@@ -467,6 +491,14 @@ users with updated information about their enhanced position. This functionality
 vital for users aiming to optimize their liquidity provision strategy, enabling them
 to adapt to market conditions and maximize their returns in decentralized finance
 (DeFi) markets.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AerodromeSlipstreamRouter`
+</Info>
+
 
 ### Example Usage
 
@@ -562,6 +594,14 @@ wish to exit their liquidity provision activities, enabling them to reclaim thei
 assets and potentially reallocate them to other investment opportunities. The
 endpoint ensures a smooth and secure withdrawal process, facilitating users'
 strategic management of their decentralized finance (DeFi) portfolios.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AerodromeSlipstreamNonfungiblePositionManager`
+</Info>
+
 
 ### Example Usage
 

package/docs/sdks/erc4626vaults/README.md

@@ -85,6 +85,14 @@ run();
 Deposit tokens into a Vault (ERC-4626 Standard) to earn passive yield.
 
 Each vault accepts one unique token that can be deposited.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `<vault_address>`
+</Info>
+
 
 ### Example Usage
 
@@ -168,6 +176,14 @@ Withdraw deposited tokens from a Vault (ERC-4626 Standard).
 The passive yield earned on token deposits is represented by the increased value of
 the shares received upon depositing tokens. Trade in these shares for the tokens you
 deposited plus any accrued yield.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `<vault address>`
+</Info>
+
 
 ### Example Usage