@compass-labs/api-sdk 0.0.25 → 0.0.26

package/docs/sdks/morpho/README.md

@@ -35,9 +35,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.morpho.vaults({
-    depositToken: "<value>",
-  });
+  const result = await compassApiSDK.morpho.vaults({});
 
   // Handle the result
   console.log(result);
@@ -61,9 +59,7 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await morphoVaults(compassApiSDK, {
-    depositToken: "<value>",
-  });
+  const res = await morphoVaults(compassApiSDK, {});
 
   if (!res.ok) {
     throw res.error;
@@ -355,7 +351,7 @@ async function run() {
   const result = await compassApiSDK.morpho.allowance({
     vaultAddress: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
     amount: 1.5,
-    chain: "base:mainnet",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -384,7 +380,7 @@ async function run() {
   const res = await morphoAllowance(compassApiSDK, {
     vaultAddress: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
     amount: 1.5,
-    chain: "base:mainnet",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -629,7 +625,7 @@ async function run() {
   const result = await compassApiSDK.morpho.supplyCollateral({
     amount: 1.5,
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-    chain: "base:mainnet",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -658,7 +654,7 @@ async function run() {
   const res = await morphoSupplyCollateral(compassApiSDK, {
     amount: 1.5,
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-    chain: "base:mainnet",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -808,7 +804,7 @@ async function run() {
   const result = await compassApiSDK.morpho.borrow({
     amount: 1.5,
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -837,7 +833,7 @@ async function run() {
   const res = await morphoBorrow(compassApiSDK, {
     amount: 1.5,
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -894,7 +890,7 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.morpho.repay({
-    amount: "ALL",
+    amount: "1.5",
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
@@ -923,7 +919,7 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await morphoRepay(compassApiSDK, {
-    amount: "ALL",
+    amount: "1.5",
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",

package/docs/sdks/sky/README.md

@@ -360,7 +360,7 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.sky.withdraw({
-    amount: "259.48",
+    amount: "797.31",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -387,7 +387,7 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await skyWithdraw(compassApiSDK, {
-    amount: "259.48",
+    amount: "797.31",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 

package/docs/sdks/token/README.md

@@ -189,7 +189,7 @@ async function run() {
   const result = await compassApiSDK.token.balance({
     chain: "arbitrum:mainnet",
     user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-    token: "<value>",
+    token: "KNC",
   });
 
   // Handle the result
@@ -217,7 +217,7 @@ async function run() {
   const res = await tokenBalance(compassApiSDK, {
     chain: "arbitrum:mainnet",
     user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-    token: "<value>",
+    token: "KNC",
   });
 
   if (!res.ok) {

package/docs/sdks/transactionbatching/README.md

@@ -113,7 +113,7 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.transactionBatching.execute({
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
     signedAuthorization: {
       nonce: 1000,
@@ -125,14 +125,11 @@ async function run() {
     },
     actions: [
       {
-        actionType: "UNISWAP_BUY_EXACTLY",
+        actionType: "ALLOWANCE_INCREASE",
         body: {
-          tokenIn: "WETH",
-          tokenOut: "USDC",
-          fee: "0.01",
+          token: "WETH",
+          contractName: "AaveV3Pool",
           amount: 1.5,
-          maxSlippagePercent: 0.5,
-          wrapEth: true,
         },
       },
     ],
@@ -161,7 +158,7 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await transactionBatchingExecute(compassApiSDK, {
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
     signedAuthorization: {
       nonce: 1000,
@@ -173,14 +170,11 @@ async function run() {
     },
     actions: [
       {
-        actionType: "UNISWAP_BUY_EXACTLY",
+        actionType: "ALLOWANCE_INCREASE",
         body: {
-          tokenIn: "WETH",
-          tokenOut: "USDC",
-          fee: "0.01",
+          token: "WETH",
+          contractName: "AaveV3Pool",
           amount: 1.5,
-          maxSlippagePercent: 0.5,
-          wrapEth: true,
         },
       },
     ],
@@ -244,7 +238,7 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.transactionBatching.aaveLoop({
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
     signedAuthorization: {
       nonce: 1000,
@@ -254,12 +248,12 @@ async function run() {
       s: 5.471500338403868e+76,
       yParity: 0,
     },
-    collateralToken: "osETH",
-    borrowToken: "sDAI",
+    collateralToken: "MKR",
+    borrowToken: "FXS",
     collateralAmount: "1000",
-    loopCount: 2,
-    maxSlippagePercent: 0.5,
-    loanToValue: 20.5,
+    loopCount: 3,
+    maxSlippagePercent: 10,
+    loanToValue: 70,
   });
 
   // Handle the result
@@ -285,7 +279,7 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await transactionBatchingAaveLoop(compassApiSDK, {
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
     signedAuthorization: {
       nonce: 1000,
@@ -295,12 +289,12 @@ async function run() {
       s: 5.471500338403868e+76,
       yParity: 0,
     },
-    collateralToken: "osETH",
-    borrowToken: "sDAI",
+    collateralToken: "MKR",
+    borrowToken: "FXS",
     collateralAmount: "1000",
-    loopCount: 2,
-    maxSlippagePercent: 0.5,
-    loanToValue: 20.5,
+    loopCount: 3,
+    maxSlippagePercent: 10,
+    loanToValue: 70,
   });
 
   if (!res.ok) {

package/docs/sdks/uniswapv3/README.md

@@ -469,9 +469,9 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.swapBuyExactly({
-    tokenIn: "SNX",
-    tokenOut: "cbETH",
-    fee: "1.0",
+    tokenIn: "FXS",
+    tokenOut: "ETHx",
+    fee: "0.01",
     amount: 1.5,
     maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
@@ -501,9 +501,9 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3SwapBuyExactly(compassApiSDK, {
-    tokenIn: "SNX",
-    tokenOut: "cbETH",
-    fee: "1.0",
+    tokenIn: "FXS",
+    tokenOut: "ETHx",
+    fee: "0.01",
     amount: 1.5,
     maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
@@ -565,7 +565,7 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   const result = await compassApiSDK.uniswapV3.swapSellExactly({
     tokenIn: "FXS",
-    tokenOut: "LUSD",
+    tokenOut: "UNI",
     fee: "0.05",
     amount: 1.5,
     maxSlippagePercent: 0.5,
@@ -597,7 +597,7 @@ const compassApiSDK = new CompassApiSDKCore({
 async function run() {
   const res = await uniswapV3SwapSellExactly(compassApiSDK, {
     tokenIn: "FXS",
-    tokenOut: "LUSD",
+    tokenOut: "UNI",
     fee: "0.05",
     amount: 1.5,
     maxSlippagePercent: 0.5,
@@ -661,12 +661,12 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.liquidityProvisionIncrease({
-    tokenId: 440649,
+    tokenId: 819447,
     amount0Desired: "1.5",
     amount1Desired: "1.7",
     amount0Min: "1.4",
     amount1Min: "1.6",
-    chain: "arbitrum:mainnet",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -693,12 +693,12 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3LiquidityProvisionIncrease(compassApiSDK, {
-    tokenId: 440649,
+    tokenId: 819447,
     amount0Desired: "1.5",
     amount1Desired: "1.7",
     amount0Min: "1.4",
     amount1Min: "1.6",
-    chain: "arbitrum:mainnet",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -758,9 +758,9 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.liquidityProvisionMint({
-    token0: "cbETH",
-    token1: "BAL",
-    fee: "0.01",
+    token0: "USDCe",
+    token1: "ARB",
+    fee: "0.3",
     tickLower: -1000,
     tickUpper: 1000,
     amount0Desired: "1.5",
@@ -768,7 +768,7 @@ async function run() {
     amount0Min: "1.4",
     amount1Min: "1.6",
     recipient: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-    chain: "base:mainnet",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -795,9 +795,9 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3LiquidityProvisionMint(compassApiSDK, {
-    token0: "cbETH",
-    token1: "BAL",
-    fee: "0.01",
+    token0: "USDCe",
+    token1: "ARB",
+    fee: "0.3",
     tickLower: -1000,
     tickUpper: 1000,
     amount0Desired: "1.5",
@@ -805,7 +805,7 @@ async function run() {
     amount0Min: "1.4",
     amount1Min: "1.6",
     recipient: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-    chain: "base:mainnet",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -866,9 +866,9 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.liquidityProvisionWithdraw({
-    tokenId: 486084,
-    percentageForWithdrawal: "50",
-    chain: "ethereum:mainnet",
+    tokenId: 719537,
+    percentageForWithdrawal: "100",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -895,9 +895,9 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3LiquidityProvisionWithdraw(compassApiSDK, {
-    tokenId: 486084,
-    percentageForWithdrawal: "50",
-    chain: "ethereum:mainnet",
+    tokenId: 719537,
+    percentageForWithdrawal: "100",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 

package/docs/sdks/universal/README.md

@@ -436,7 +436,7 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   const result = await compassApiSDK.universal.wrapEth({
     amount: 1.5,
-    chain: "base:mainnet",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -464,7 +464,7 @@ const compassApiSDK = new CompassApiSDKCore({
 async function run() {
   const res = await universalWrapEth(compassApiSDK, {
     amount: 1.5,
-    chain: "base:mainnet",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -607,7 +607,7 @@ async function run() {
     token: "rETH",
     contractName: "AaveV3Pool",
     amount: 1.5,
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -637,7 +637,7 @@ async function run() {
     token: "rETH",
     contractName: "AaveV3Pool",
     amount: 1.5,
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.0.25",
+  "version": "0.0.26",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.0.25",
+  "version": "0.0.26",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/lib/config.ts

@@ -57,8 +57,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "0.0.25",
-  genVersion: "2.599.0",
+  sdkVersion: "0.0.26",
+  genVersion: "2.603.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.0.25 2.599.0 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.0.26 2.603.1 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.0.25",
+    currentVersion: "0.0.26",
   },
 });
 

package/src/mcp-server/server.ts

@@ -83,7 +83,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.0.25",
+    version: "0.0.26",
   });
 
   const client = new CompassApiSDKCore({

package/src/models/operations/aavehistoricaltransactions.ts

@@ -25,12 +25,21 @@ export type AaveHistoricalTransactionsChain = ClosedEnum<
 >;
 
 export type AaveHistoricalTransactionsRequest = {
+  /**
+   * The offset of the first item to return.
+   */
   offset?: number | undefined;
+  /**
+   * The number of items to return.
+   */
   limit?: number | undefined;
   /**
    * The chain to use.
    */
   chain?: AaveHistoricalTransactionsChain | undefined;
+  /**
+   * The address of the user to get historical transactions for.
+   */
   userAddress?: string | undefined;
 };
 

package/src/models/operations/aaveliquiditychange.ts

@@ -96,15 +96,16 @@ export type AaveLiquidityChangeRequest = {
    */
   chain?: AaveLiquidityChangeChain | undefined;
   /**
-   * A class representing the token.
-   *
-   * @remarks
-   *
-   * This class is used to represent the token in the system. Notice individual
-   * endpoints' documentation where per chain tokens are presented.
+   * The symbol of the asset to get liquidity change for..
    */
   token?: AaveLiquidityChangeToken | undefined;
+  /**
+   * The start block to calculate liquidity change from.
+   */
   startBlock?: number | undefined;
+  /**
+   * The end block to calculate liquidity change to.
+   */
   endBlock?: number | undefined;
 };
 

package/src/models/operations/aaverate.ts

@@ -91,12 +91,7 @@ export type AaveRateRequest = {
    */
   chain?: AaveRateChain | undefined;
   /**
-   * A class representing the token.
-   *
-   * @remarks
-   *
-   * This class is used to represent the token in the system. Notice individual
-   * endpoints' documentation where per chain tokens are presented.
+   * The symbol of the asset to fetch the users' position on..
    */
   token?: AaveRateToken | undefined;
 };

package/src/models/operations/aavereserveoverview.ts

@@ -95,12 +95,7 @@ export type AaveReserveOverviewRequest = {
    */
   chain?: AaveReserveOverviewChain | undefined;
   /**
-   * A class representing the token.
-   *
-   * @remarks
-   *
-   * This class is used to represent the token in the system. Notice individual
-   * endpoints' documentation where per chain tokens are presented.
+   * The symbol of the asset..
    */
   token?: AaveReserveOverviewToken | undefined;
 };

package/src/models/operations/aavetokenprice.ts

@@ -91,12 +91,7 @@ export type AaveTokenPriceRequest = {
    */
   chain?: AaveTokenPriceChain | undefined;
   /**
-   * A class representing the token.
-   *
-   * @remarks
-   *
-   * This class is used to represent the token in the system. Notice individual
-   * endpoints' documentation where per chain tokens are presented.
+   * The symbol of the asset whose price you want..
    */
   token?: AaveTokenPriceToken | undefined;
 };

package/src/models/operations/aaveuserpositionpertoken.ts

@@ -94,14 +94,12 @@ export type AaveUserPositionPerTokenRequest = {
    * The chain to use.
    */
   chain?: AaveUserPositionPerTokenChain | undefined;
+  /**
+   * The user to fetch the token-specific position of.
+   */
   user?: string | undefined;
   /**
-   * A class representing the token.
-   *
-   * @remarks
-   *
-   * This class is used to represent the token in the system. Notice individual
-   * endpoints' documentation where per chain tokens are presented.
+   * The symbol of the asset to fetch the user's position on..
    */
   token?: AaveUserPositionPerTokenToken | undefined;
 };

package/src/models/operations/aaveuserpositionsummary.ts

@@ -28,6 +28,9 @@ export type AaveUserPositionSummaryRequest = {
    * The chain to use.
    */
   chain?: AaveUserPositionSummaryChain | undefined;
+  /**
+   * The user to get position summary for.
+   */
   user?: string | undefined;
 };
 

package/src/models/operations/aerodromeslipstreamliquidityprovisionpositions.ts

@@ -28,6 +28,9 @@ export type AerodromeSlipstreamLiquidityProvisionPositionsRequest = {
    * The chain to use.
    */
   chain?: AerodromeSlipstreamLiquidityProvisionPositionsChain | undefined;
+  /**
+   * The user to get positions for.
+   */
   user?: string | undefined;
 };
 

package/src/models/operations/aerodromeslipstreampoolprice.ts

@@ -162,23 +162,16 @@ export type AerodromeSlipstreamPoolPriceRequest = {
    */
   chain?: AerodromeSlipstreamPoolPriceChain | undefined;
   /**
-   * A class representing the token.
-   *
-   * @remarks
-   *
-   * This class is used to represent the token in the system. Notice individual
-   * endpoints' documentation where per chain tokens are presented.
+   * The symbol of a token in the pool.
    */
   tokenIn?: AerodromeSlipstreamPoolPriceTokenInToken | undefined;
   /**
-   * A class representing the token.
-   *
-   * @remarks
-   *
-   * This class is used to represent the token in the system. Notice individual
-   * endpoints' documentation where per chain tokens are presented.
+   * The symbol of a token in the pool.
    */
   tokenOut?: AerodromeSlipstreamPoolPriceTokenOutToken | undefined;
+  /**
+   * The tick spacing of the pool
+   */
   tickSpacing?: number | undefined;
 };
 

package/src/models/operations/genericallowance.ts

@@ -86,6 +86,9 @@ export const GenericAllowanceToken = {
  */
 export type GenericAllowanceToken = ClosedEnum<typeof GenericAllowanceToken>;
 
+/**
+ * The name of the contract to check allowance for.
+ */
 export const ContractName = {
   AaveV3Pool: "AaveV3Pool",
   AerodromeBasicRouter: "AerodromeBasicRouter",
@@ -99,6 +102,9 @@ export const ContractName = {
   SkyUsdcUsdsConverter: "SkyUsdcUsdsConverter",
   SkyUsdsVault: "SkyUsdsVault",
 } as const;
+/**
+ * The name of the contract to check allowance for.
+ */
 export type ContractName = ClosedEnum<typeof ContractName>;
 
 export type GenericAllowanceRequest = {
@@ -106,16 +112,17 @@ export type GenericAllowanceRequest = {
    * The chain to use.
    */
   chain?: GenericAllowanceChain | undefined;
+  /**
+   * The user to get the ERC20 allowance of.
+   */
   user?: string | undefined;
   /**
-   * A class representing the token.
-   *
-   * @remarks
-   *
-   * This class is used to represent the token in the system. Notice individual
-   * endpoints' documentation where per chain tokens are presented.
+   * The symbol of the token for which the allowance is checked..
    */
   token?: GenericAllowanceToken | undefined;
+  /**
+   * The name of the contract to check allowance for.
+   */
   contractName?: ContractName | undefined;
 };