@ensofinance/checkout-widget 0.0.1

package/enso-api.yaml

@@ -0,0 +1,1982 @@
+openapi: 3.0.0
+paths:
+  /api/v1/networks:
+    get:
+      operationId: NetworksController_networks
+      summary: Returns networks supported by the API
+      parameters:
+        - name: name
+          required: false
+          in: query
+          description: Title of the network to search for
+          schema:
+            example: mainnet
+        - name: chainId
+          required: false
+          in: query
+          description: Chain ID of the network to search for
+          schema:
+            example: '1'
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ConnectedNetwork'
+      tags:
+        - metadata
+  /api/v1/prices/{chainId}/{address}:
+    get:
+      operationId: PricesController_getPrice
+      summary: Returns price for a token
+      parameters:
+        - name: address
+          required: true
+          in: path
+          description: Address of the token to search for
+          schema:
+            example: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2'
+        - name: chainId
+          required: true
+          in: path
+          description: Chain ID of the network to search for
+          schema:
+            example: '1'
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Price'
+      tags:
+        - metadata
+  /api/v1/prices/{chainId}:
+    get:
+      operationId: PricesController_getPrices
+      summary: Returns price for multiple tokens
+      parameters:
+        - name: chainId
+          required: true
+          in: path
+          description: Chain ID of the network to search for
+          schema:
+            example: '1'
+            type: number
+        - name: addresses
+          required: true
+          in: query
+          description: Ethereum address of the token to check price for.
+          schema:
+            example:
+              - '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2'
+            type: array
+            items:
+              type: string
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Price'
+      tags:
+        - metadata
+  /api/v1/aggregators:
+    get:
+      operationId: AggregatorsController_aggregators
+      summary: >-
+        Returns aggregators supported by the API (can be controled via
+        disableAggregators param)
+      parameters: []
+      responses:
+        '200':
+          description: Returns a list of aggregators
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+      tags:
+        - metadata
+  /api/v1/volume/{chainId}:
+    get:
+      operationId: VolumeController_getVolume
+      summary: Returns chain USD volume and total transactions
+      parameters:
+        - name: chainId
+          required: true
+          in: path
+          description: Chain ID of the network to search for
+          schema:
+            default: 1
+            example: '1'
+            type: number
+      responses:
+        '200':
+          description: ''
+      tags:
+        - metadata
+  /api/v1/account/accountId:
+    get:
+      operationId: AccountController_accountId
+      summary: Returns accountId connected to your api key used in the on-chain event.
+      parameters: []
+      responses:
+        '200':
+          description: Your accountId
+          content:
+            application/json:
+              schema:
+                type: string
+      tags:
+        - metadata
+  /api/v1/tokens:
+    get:
+      operationId: TokensController_tokens
+      summary: Returns tokens and their details
+      parameters:
+        - name: project
+          required: false
+          in: query
+          description: The overarching project or platform associated with the DeFi token
+          schema:
+            example: aave
+            type: string
+        - name: protocolSlug
+          required: false
+          in: query
+          description: The specific standard integration or version of the DeFi project
+          schema:
+            example: aave-v2
+            type: string
+        - name: underlyingTokens
+          required: false
+          in: query
+          description: Underlying tokens of defi token
+          schema:
+            example:
+              - '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
+            type: array
+            items:
+              type: string
+        - name: underlyingTokensExact
+          required: false
+          in: query
+          description: Exact composition of underlying tokens of defi token
+          schema:
+            example:
+              - '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
+            type: array
+            items:
+              type: string
+        - name: primaryAddress
+          required: false
+          in: query
+          description: Ethereum addresses for contract interaction of defi tokens
+          schema:
+            example:
+              - '0x7d2768dE32b0b80b7a3454c06BdAc94A69DDc7A9'
+            type: array
+            items:
+              type: string
+        - name: address
+          required: false
+          in: query
+          description: Ethereum addresses of the tokens
+          schema:
+            example:
+              - '0x030bA81f1c18d280636F32af80b9AAd02Cf0854e'
+            type: array
+            items:
+              type: string
+        - name: name
+          required: false
+          in: query
+          description: Names of the tokens
+          schema:
+            example:
+              - Bridged USDT
+            type: array
+            items:
+              type: string
+        - name: symbol
+          required: false
+          in: query
+          description: Symbols of the tokens
+          schema:
+            example:
+              - USDC
+            type: array
+            items:
+              type: string
+        - name: chainId
+          required: false
+          in: query
+          description: Chain ID of the network of the token
+          schema:
+            example: 1
+            type: number
+        - name: type
+          required: false
+          in: query
+          description: |-
+            Type of token.
+                  If not provided, both types will be taken into account
+          schema:
+            example: defi
+            enum:
+              - defi
+              - base
+            type: string
+        - name: page
+          required: false
+          in: query
+          description: Pagination page number. Pages are of length 1000
+          schema:
+            example: '1'
+            type: number
+        - name: pageSize
+          required: false
+          in: query
+          description: Number of items per page (max 1000)
+          schema:
+            default: 1000
+            example: 100
+            type: number
+        - name: cursor
+          required: false
+          in: query
+          description: Cursor for pagination. Pages are of length 1000
+          schema:
+            example: '1233456'
+            type: number
+        - name: includeMetadata
+          required: false
+          in: query
+          description: Whether to include token metadata (symbol, name and logos)
+          schema:
+            default: false
+            example: false
+            type: boolean
+        - name: includeUnderlying
+          required: false
+          in: query
+          description: Whether to include underlying tokes
+          schema:
+            default: true
+            example: false
+            type: boolean
+        - name: apyFrom
+          required: false
+          in: query
+          description: Only include tokens with APY over this value
+          schema:
+            example: 1
+            type: number
+        - name: apyTo
+          required: false
+          in: query
+          description: Only include tokens with APY below this value
+          schema:
+            example: 10
+            type: number
+        - name: tvlFrom
+          required: false
+          in: query
+          description: Only include tokens with TVL over this value
+          schema:
+            example: 0
+            type: number
+        - name: tvlTo
+          required: false
+          in: query
+          description: Only include tokens with TVL below this value
+          schema:
+            example: 10000000
+            type: number
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                allOf:
+                  - $ref: '#/components/schemas/PaginatedResult'
+                  - properties:
+                      data:
+                        type: array
+                        description: Returned data for current page
+                        items:
+                          $ref: '#/components/schemas/PositionModel'
+      tags:
+        - metadata
+  /api/v1/shortcuts/route:
+    get:
+      operationId: RouterController_routeShortcutTransaction
+      summary: Find optimal route between tokens (direct routes, zaps)
+      parameters:
+        - name: chainId
+          required: false
+          in: query
+          description: Chain ID of the network to execute the transaction on
+          schema:
+            default: 1
+            type: number
+        - name: fromAddress
+          required: true
+          in: query
+          description: Ethereum address of the wallet to send the transaction from
+          schema:
+            default: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: routingStrategy
+          required: false
+          in: query
+          description: Routing strategy to use
+          schema:
+            nullable: true
+            enum:
+              - ensowallet
+              - router
+              - delegate
+              - router-legacy
+              - delegate-legacy
+            type: string
+        - name: toEoa
+          required: false
+          in: query
+          description: Flag that indicates if gained tokenOut should be sent to EOA
+          deprecated: true
+          schema:
+            nullable: true
+            type: boolean
+        - name: receiver
+          required: false
+          in: query
+          description: Ethereum address of the receiver of the tokenOut
+          schema:
+            example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: spender
+          required: false
+          in: query
+          description: Ethereum address of the spender of the tokenIn
+          schema:
+            example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: refundReceiver
+          required: false
+          in: query
+          description: >-
+            Ethereum address of the receiver of any dust tokens that might be
+            produced during the execution of actions
+          schema:
+            example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: amountIn
+          required: true
+          in: query
+          description: Amount of tokenIn to swap in wei
+          schema:
+            example:
+              - '1000000000000000000'
+            type: array
+            items:
+              type: string
+        - name: minAmountOut
+          required: false
+          in: query
+          description: >-
+            Minimum amount out in wei. If specified, slippage should not be
+            specified
+          schema:
+            default: null
+            type: array
+            items:
+              type: string
+        - name: slippage
+          required: false
+          in: query
+          description: >-
+            Slippage in basis points (1/10000). e.g. 50 = 0.50%. If specified,
+            minAmountOut should not be specified
+          schema:
+            default: '50'
+            example: '300'
+            type: string
+        - name: fee
+          required: false
+          in: query
+          description: >-
+            Fee in basis points (1/10000) for each amountIn value. Must be in
+            range 0-100. If specified, this percentage of each amountIn value
+            will be sent to feeReceiver
+          schema:
+            example:
+              - '100'
+            type: array
+            items:
+              type: string
+        - name: feeReceiver
+          required: false
+          in: query
+          description: >-
+            The Ethereum address that will receive the collected fee. Required
+            if fee is provided
+          schema:
+            example: '0x220866B1A2219f40e72f5c628B65D54268cA3A9D'
+            type: string
+        - name: ignoreAggregators
+          required: false
+          in: query
+          description: A list of swap aggregators to be ignored from consideration
+          schema:
+            nullable: true
+            type: array
+            items:
+              type: string
+        - name: ignoreStandards
+          required: false
+          in: query
+          description: A list of standards to be ignored from consideration
+          schema:
+            nullable: true
+            type: array
+            items:
+              type: string
+        - name: referralCode
+          required: false
+          in: query
+          description: Referral code that will be included in an on-chain event.
+          schema:
+            maxLength: 16
+            example: 0123456789ABCDEF
+            type: string
+        - name: tokenIn
+          required: true
+          in: query
+          description: >-
+            Ethereum address of the token to swap from. For ETH, use
+            0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
+          schema:
+            example:
+              - '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
+            type: array
+            items:
+              type: string
+        - name: tokenOut
+          required: true
+          in: query
+          description: >-
+            Ethereum address of the token to swap to. For ETH, use
+            0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
+          schema:
+            example:
+              - '0x6b175474e89094c44da98b954eedeac495271d0f'
+            type: array
+            items:
+              type: string
+        - name: destinationChainId
+          required: false
+          in: query
+          description: Chain ID of the network to bridge to and receive tokenOut
+          schema:
+            type: number
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RouteShortcutTransaction'
+        '400':
+          description: ''
+      tags:
+        - shortcuts
+    post:
+      operationId: RouterController_postRouteShortcutTransaction
+      summary: Find optimal route between tokens (direct routes, zaps)
+      parameters: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RouteShortcutVariableInputs'
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RouteShortcutTransaction'
+        '400':
+          description: ''
+      tags:
+        - shortcuts
+  /api/v1/shortcuts/route/nontokenized:
+    get:
+      operationId: NontokenizedController_routeNontokenizedShorcutTransaction
+      summary: Find optimal route between token and nontokenized position
+      parameters:
+        - name: chainId
+          required: false
+          in: query
+          description: Chain ID of the network to execute the transaction on
+          schema:
+            default: 1
+            example: 80094
+            type: number
+        - name: fromAddress
+          required: true
+          in: query
+          description: Ethereum address of the wallet to send the transaction from
+          schema:
+            default: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: routingStrategy
+          required: false
+          in: query
+          description: Routing strategy to use
+          schema:
+            nullable: true
+            enum:
+              - delegate
+              - delegate-legacy
+            type: string
+        - name: referralCode
+          required: false
+          in: query
+          description: Referral code that will be included in an on-chain event.
+          schema:
+            maxLength: 16
+            example: 0123456789ABCDEF
+            type: string
+        - name: tokenIn
+          required: true
+          in: query
+          description: >-
+            Ethereum address of the token to swap from. For ETH, use
+            0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
+          schema:
+            example:
+              - '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
+            type: array
+            items:
+              type: string
+        - name: positionOut
+          required: true
+          in: query
+          description: Ethereum address of the position to receive
+          schema:
+            example: '0xf99be47baf0c22b7eb5eac42c8d91b9942dc7e84'
+            type: string
+        - name: slippage
+          required: false
+          in: query
+          description: >-
+            Slippage in basis points (1/10000). If specified, minAmountOut
+            should not be specified
+          schema:
+            default: '50'
+            example: '300'
+            type: string
+        - name: fee
+          required: false
+          in: query
+          description: >-
+            Fee in basis points (1/10000) for each amountIn value. Must be in
+            range 0-100. If specified, this percentage of each amountIn value
+            will be sent to feeReceiver
+          schema:
+            example:
+              - '100'
+            type: array
+            items:
+              type: string
+        - name: feeReceiver
+          required: false
+          in: query
+          description: >-
+            The Ethereum address that will receive the collected fee. Required
+            if fee is provided
+          schema:
+            example: '0x220866B1A2219f40e72f5c628B65D54268cA3A9D'
+            type: string
+        - name: amountIn
+          required: true
+          in: query
+          description: Amount of tokenIn to swap in wei
+          schema:
+            example:
+              - '1000000000000000000'
+            type: array
+            items:
+              type: string
+        - name: receiver
+          required: true
+          in: query
+          description: Ethereum address of the receiver of the positionOut
+          schema:
+            example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: spender
+          required: false
+          in: query
+          description: Ethereum address of the spender of the tokenIn
+          schema:
+            example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RouteShortcutTransaction'
+        '400':
+          description: ''
+      tags:
+        - shortcuts
+  /api/v1/wallet/approve:
+    get:
+      operationId: WalletController_createApproveTransaction
+      summary: Returns transaction that approves your EnsoWallet to spend tokens
+      parameters:
+        - name: chainId
+          required: false
+          in: query
+          description: Chain ID of the network to execute the transaction on
+          schema:
+            default: 1
+            type: number
+        - name: fromAddress
+          required: true
+          in: query
+          description: Ethereum address of the wallet to send the transaction from
+          schema:
+            default: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: routingStrategy
+          required: false
+          in: query
+          description: Routing strategy to use
+          schema:
+            nullable: true
+            enum:
+              - ensowallet
+              - router
+              - delegate
+              - router-legacy
+              - delegate-legacy
+            type: string
+        - name: tokenAddress
+          required: true
+          in: query
+          description: ERC20 token address of the token to approve
+          schema:
+            default: '0x6b175474e89094c44da98b954eedeac495271d0f'
+            type: string
+        - name: amount
+          required: true
+          in: query
+          description: Amount of tokens to approve in wei
+          schema:
+            default: '1000000000000000000000000000'
+            type: string
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WalletApproveTransaction'
+      tags:
+        - wallet
+  /api/v1/wallet/balances:
+    get:
+      operationId: WalletController_walletBalances
+      summary: Returns all balances for a given wallet
+      parameters:
+        - name: chainId
+          required: true
+          in: query
+          description: Chain ID (or list of chain IDs) of the network to fetch balances on
+          schema:
+            example: 1
+            type: number
+        - name: eoaAddress
+          required: true
+          in: query
+          description: >-
+            Address of the eoa with which to associate the ensoWallet for
+            balances
+          schema:
+            default: '0x93621DCA56fE26Cdee86e4F6B18E116e9758Ff11'
+            type: string
+        - name: useEoa
+          required: false
+          in: query
+          description: >-
+            If true returns balances for the provided address, instead of the
+            associated ensoWallet
+          schema:
+            type: boolean
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/WalletBalance'
+      tags:
+        - wallet
+  /api/v1/actions:
+    get:
+      operationId: ActionsController_findAll
+      summary: Returns actions available to use in bundle shortcuts
+      parameters: []
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Action'
+      tags:
+        - standards
+  /api/v1/actions/{slug}:
+    get:
+      operationId: ActionsController_getActionsBySlug
+      summary: >-
+        Returns actions available to use in bundle shortcuts for a given
+        protocol
+      parameters:
+        - name: slug
+          required: true
+          in: path
+          schema:
+            type: string
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Action'
+      tags:
+        - standards
+  /api/v1/standards:
+    get:
+      operationId: StandardsController_standards
+      summary: Returns standards and methods available to use in bundle shortcuts
+      parameters: []
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Standard'
+      tags:
+        - standards
+  /api/v1/standards/{slug}:
+    get:
+      operationId: StandardsController_getProtocolBySlug
+      summary: Returns a standard by slug
+      parameters:
+        - name: slug
+          required: true
+          in: path
+          description: The protocol slug
+          schema:
+            example: aave-v2
+            type: string
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ProtocolModel'
+      tags:
+        - standards
+  /api/v1/shortcuts/bundle:
+    post:
+      operationId: BundleController_bundleShortcutTransaction
+      summary: Bundle a list of actions into a single transaction
+      parameters:
+        - name: chainId
+          required: false
+          in: query
+          description: Chain ID of the network to execute the transaction on
+          schema:
+            default: 1
+            type: number
+        - name: fromAddress
+          required: true
+          in: query
+          description: Ethereum address of the wallet to send the transaction from
+          schema:
+            default: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: referralCode
+          required: false
+          in: query
+          description: Referral code that will be included in an on-chain event.
+          schema:
+            maxLength: 16
+            example: 0123456789ABCDEF
+            type: string
+        - name: routingStrategy
+          required: false
+          in: query
+          description: Routing strategy to use
+          schema:
+            nullable: true
+            enum:
+              - ensowallet
+              - router
+              - delegate
+              - router-legacy
+              - delegate-legacy
+            type: string
+        - name: receiver
+          required: false
+          in: query
+          description: Ethereum address of the receiver of the tokenOut
+          schema:
+            example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: spender
+          required: false
+          in: query
+          description: Ethereum address of the spender of the tokenIn
+          schema:
+            example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: refundReceiver
+          required: false
+          in: query
+          description: >-
+            Ethereum address of the receiver of any dust tokens that might be
+            produced during the execution of actions
+          schema:
+            example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+        - name: ignoreAggregators
+          required: false
+          in: query
+          description: A list of swap aggregators to be ignored from consideration
+          schema:
+            nullable: true
+            type: array
+            items:
+              type: string
+        - name: skipQuote
+          required: false
+          in: query
+          description: >-
+            Flag to skip quoting (if true, amountOut and gas will not be
+            returned)
+          schema:
+            type: boolean
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/ActionToBundle'
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/BundleShortcutTransaction'
+      tags:
+        - shortcuts
+  /api/v1/shortcuts/static/ipor:
+    post:
+      operationId: IporController_iporShortcutTransaction
+      summary: Get transaction for IPOR shortcut
+      parameters:
+        - name: chainId
+          required: false
+          in: query
+          description: Chain ID of the network to execute the transaction on
+          schema:
+            default: 1
+            type: number
+        - name: fromAddress
+          required: true
+          in: query
+          description: Ethereum address of the wallet to send the transaction from
+          schema:
+            default: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/IporShortcutInput'
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/IporShortcutTransaction'
+      tags:
+        - shortcuts
+  /api/v1/nontokenized:
+    get:
+      operationId: NonTokenizedController_tokens
+      summary: Returns nontokenized positions and their details
+      parameters:
+        - name: project
+          required: false
+          in: query
+          description: The overarching project or platform associated with the DeFi token
+          schema:
+            example: beradrome
+            type: string
+        - name: protocolSlug
+          required: false
+          in: query
+          description: The specific standard integration or version of the DeFi project
+          schema:
+            example: beradrome-farms
+            type: string
+        - name: chainId
+          required: false
+          in: query
+          description: Chain ID of the network of the nontokenized position
+          schema:
+            example: 80094
+            type: number
+        - name: address
+          required: false
+          in: query
+          description: Ethereum addresses of the nontokenized positions
+          schema:
+            type: array
+            items:
+              type: string
+        - name: primaryAddress
+          required: false
+          in: query
+          description: Ethereum addresses for contract interaction of nontokenized position
+          schema:
+            type: array
+            items:
+              type: string
+        - name: page
+          required: false
+          in: query
+          description: Pagination page number. Pages are of length 1000
+          schema:
+            type: number
+        - name: cursor
+          required: false
+          in: query
+          description: Cursor for pagination. Pages are of length 1000
+          schema:
+            type: number
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                allOf:
+                  - $ref: '#/components/schemas/PaginatedResult'
+                  - properties:
+                      data:
+                        type: array
+                        description: Returned data for current page
+                        items:
+                          $ref: '#/components/schemas/NonTokenizedModel'
+      tags:
+        - metadata
+  /api/v1/projects:
+    get:
+      operationId: ProjectsController_standards
+      summary: >-
+        Returns the overarching projects or platforms associated with the
+        available projects
+      parameters: []
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Project'
+      tags:
+        - projects
+  /api/v1/projects/{project}/protocols:
+    get:
+      operationId: ProjectsController_getStandardsByProject
+      summary: Returns protocols available by project
+      parameters:
+        - name: project
+          required: true
+          in: path
+          description: The overarching project or platform
+          schema:
+            example: aave
+            type: string
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ProtocolModel'
+      tags:
+        - projects
+  /api/v1/protocols:
+    get:
+      operationId: ProtocolsController_findAll
+      summary: Returns projects and relevant protocols available to use
+      parameters:
+        - name: chainId
+          required: false
+          in: query
+          description: Chain ID of the network to search for
+          schema:
+            example: '1'
+        - name: slug
+          required: false
+          in: query
+          description: slug of the project to search for
+          schema:
+            example: uniswap-v2
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ProtocolModel'
+      tags:
+        - metadata
+info:
+  title: ''
+  description: >-
+    #### Enso API
+
+    - Find detailed documentation on
+    [docs.enso.finance](https://docs.enso.finance).
+
+    - To use the API, **you must include your API Key in the Authorization
+    header** (Bearer format).
+
+    - For testing, Swagger pre-authorizes you using the key:
+    `1e02632d-6feb-4a75-a157-documentation` (1rps).
+
+    - Get your own API Key at
+    [enso.finance/developers](https://enso.finance/developers).
+  version: '1.0'
+  contact: {}
+tags:
+  - name: shortcuts
+    description: ''
+servers:
+  - url: https://api.enso.finance
+components:
+  securitySchemes:
+    bearer:
+      scheme: bearer
+      bearerFormat: apiKey
+      type: http
+  schemas:
+    ConnectedNetwork:
+      type: object
+      properties:
+        id:
+          type: number
+          example: 1
+        name:
+          type: string
+          example: Ethereum
+        isConnected:
+          type: boolean
+          example: true
+      required:
+        - id
+        - name
+        - isConnected
+    Price:
+      type: object
+      properties:
+        decimals:
+          type: number
+          example: 8
+        price:
+          type: number
+          example: 27052
+        address:
+          type: string
+          example: '0x2260fac5e5542a773aa44fbcfedf7c193bc2c599'
+        symbol:
+          type: string
+          example: WBTC
+        timestamp:
+          type: number
+          example: 1695197412
+        chainId:
+          type: number
+          example: 1
+        confidence:
+          type: number
+          example: 0.99
+      required:
+        - decimals
+        - price
+        - address
+        - chainId
+    PaginationMeta:
+      type: object
+      properties:
+        total:
+          type: number
+          description: Total amount of pages
+        lastPage:
+          type: number
+          description: Last page number
+        currentPage:
+          type: number
+          description: Current page number
+        perPage:
+          type: number
+          description: Amount of elements per page
+        prev:
+          type: number
+          description: Previous page
+        next:
+          type: number
+          description: Next page
+        cursor:
+          type: number
+          description: Cursor for pagination
+      required:
+        - total
+        - lastPage
+        - currentPage
+        - perPage
+        - prev
+        - next
+        - cursor
+    PaginatedResult:
+      type: object
+      properties:
+        meta:
+          description: Metadata for pagination
+          allOf:
+            - $ref: '#/components/schemas/PaginationMeta'
+      required:
+        - meta
+    TokenModel:
+      type: object
+      properties:
+        address:
+          type: string
+          description: Ethereum address of the token
+        chainId:
+          type: number
+          description: Chain ID of the network of the token
+        type:
+          type: string
+          description: Type of token
+        decimals:
+          type: number
+          description: Token decimals
+        symbol:
+          type: string
+          description: Token name
+          nullable: true
+        name:
+          type: string
+          description: Token symbol
+          nullable: true
+        logosUri:
+          description: A list of logos for the token
+          nullable: true
+          type: array
+          items:
+            type: string
+      required:
+        - address
+        - chainId
+        - type
+        - decimals
+        - symbol
+        - name
+        - logosUri
+    PositionModel:
+      type: object
+      properties:
+        address:
+          type: string
+          description: Ethereum address of the token
+        chainId:
+          type: number
+          description: Chain ID of the network of the token
+        type:
+          type: string
+          description: Type of token
+        decimals:
+          type: number
+          description: Token decimals
+        symbol:
+          type: string
+          description: Token name
+          nullable: true
+        name:
+          type: string
+          description: Token symbol
+          nullable: true
+        logosUri:
+          description: A list of logos for the token
+          nullable: true
+          type: array
+          items:
+            type: string
+        underlyingTokens:
+          description: Underlying tokens of defi token
+          nullable: true
+          type: array
+          items:
+            $ref: '#/components/schemas/TokenModel'
+        project:
+          type: string
+          description: The overarching project or platform associated with the DeFi token
+          example: aave
+          nullable: true
+        protocolSlug:
+          type: string
+          description: The specific standard integration or version of the DeFi project
+          nullable: true
+        apy:
+          type: number
+          description: The defi position APY
+          nullable: true
+          example: 3.8
+        apyBase:
+          type: number
+          description: The defi position base APY
+          nullable: true
+          example: 2.6
+        apyReward:
+          type: number
+          description: The defi position reward APY
+          nullable: true
+          example: 1.2
+        tvl:
+          type: number
+          description: The defi position TVL
+          nullable: true
+          example: 3001020.8
+        primaryAddress:
+          type: string
+          description: Ethereum address for contract interaction of defi token
+          nullable: true
+      required:
+        - address
+        - chainId
+        - type
+        - decimals
+        - symbol
+        - name
+        - logosUri
+        - underlyingTokens
+        - project
+        - protocolSlug
+        - apy
+        - apyBase
+        - apyReward
+        - tvl
+        - primaryAddress
+    Transaction:
+      type: object
+      properties:
+        data:
+          type: string
+        to:
+          type: string
+        from:
+          type: string
+        value:
+          type: string
+      required:
+        - data
+        - to
+        - from
+        - value
+    Hop:
+      type: object
+      properties:
+        tokenIn:
+          type: array
+          items:
+            type: string
+        tokenOut:
+          type: array
+          items:
+            type: string
+        protocol:
+          type: string
+        action:
+          type: string
+        primary:
+          type: string
+        internalRoutes:
+          type: array
+          items:
+            type: string
+        args:
+          type: object
+        chainId:
+          type: number
+        sourceChainId:
+          type: number
+        destinationChainId:
+          type: number
+      required:
+        - tokenIn
+        - tokenOut
+        - protocol
+        - action
+        - primary
+        - internalRoutes
+        - args
+    RouteShortcutTransaction:
+      type: object
+      properties:
+        gas:
+          type: string
+        amountOut:
+          type: string
+        priceImpact:
+          type: number
+          description: Price impact in basis points, null if USD price not found
+        feeAmount:
+          description: An array of the fee amount collected for each tokenIn
+          type: array
+          items:
+            type: string
+        createdAt:
+          type: number
+          description: Block number the transaction was created on
+        tx:
+          description: The tx object to use in `ethers`
+          allOf:
+            - $ref: '#/components/schemas/Transaction'
+        route:
+          description: The route the shortcut will use
+          type: array
+          items:
+            $ref: '#/components/schemas/Hop'
+        ensoFeeAmount:
+          type: array
+          items:
+            type: string
+      required:
+        - gas
+        - amountOut
+        - priceImpact
+        - feeAmount
+        - createdAt
+        - tx
+        - route
+        - ensoFeeAmount
+    RouteShortcutVariableInputs:
+      type: object
+      properties:
+        chainId:
+          type: number
+          description: Chain ID of the network to execute the transaction on
+          default: 1
+        fromAddress:
+          type: string
+          description: Ethereum address of the wallet to send the transaction from
+          default: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+        routingStrategy:
+          type: string
+          description: Routing strategy to use
+          nullable: true
+          enum:
+            - ensowallet
+            - router
+            - delegate
+            - router-legacy
+            - delegate-legacy
+        toEoa:
+          type: boolean
+          description: Flag that indicates if gained tokenOut should be sent to EOA
+          nullable: true
+          deprecated: true
+        receiver:
+          type: string
+          description: Ethereum address of the receiver of the tokenOut
+          example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+        spender:
+          type: string
+          description: Ethereum address of the spender of the tokenIn
+          example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+        refundReceiver:
+          type: string
+          description: >-
+            Ethereum address of the receiver of any dust tokens that might be
+            produced during the execution of actions
+          example: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+        amountIn:
+          description: Amount of tokenIn to swap in wei
+          example:
+            - '1000000000000000000'
+          type: array
+          items:
+            type: string
+        minAmountOut:
+          description: >-
+            Minimum amount out in wei. If specified, slippage should not be
+            specified
+          default: null
+          type: array
+          items:
+            type: string
+        slippage:
+          type: string
+          description: >-
+            Slippage in basis points (1/10000). e.g. 50 = 0.50%. If specified,
+            minAmountOut should not be specified
+          example: '300'
+          default: '50'
+        fee:
+          description: >-
+            Fee in basis points (1/10000) for each amountIn value. Must be in
+            range 0-100. If specified, this percentage of each amountIn value
+            will be sent to feeReceiver
+          example:
+            - '100'
+          type: array
+          items:
+            type: string
+        feeReceiver:
+          type: string
+          description: >-
+            The Ethereum address that will receive the collected fee. Required
+            if fee is provided
+          example: '0x220866B1A2219f40e72f5c628B65D54268cA3A9D'
+        ignoreAggregators:
+          description: A list of swap aggregators to be ignored from consideration
+          nullable: true
+          type: array
+          items:
+            type: string
+        ignoreStandards:
+          description: A list of standards to be ignored from consideration
+          nullable: true
+          type: array
+          items:
+            type: string
+        referralCode:
+          type: string
+          description: Referral code that will be included in an on-chain event.
+          example: 0123456789ABCDEF
+          maxLength: 16
+        tokenIn:
+          description: >-
+            Ethereum address of the token to swap from. For ETH, use
+            0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
+          example:
+            - '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
+          type: array
+          items:
+            type: string
+        tokenOut:
+          description: >-
+            Ethereum address of the token to swap to. For ETH, use
+            0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
+          example:
+            - '0x6b175474e89094c44da98b954eedeac495271d0f'
+          type: array
+          items:
+            type: string
+        destinationChainId:
+          type: number
+          description: Chain ID of the network to bridge to and receive tokenOut
+        variableEstimates:
+          type: object
+          default: null
+      required:
+        - fromAddress
+        - amountIn
+        - tokenIn
+        - tokenOut
+        - variableEstimates
+    WalletApproveTransaction:
+      type: object
+      properties:
+        tx:
+          type: object
+          description: The tx object to use in `ethers`
+        gas:
+          type: string
+          description: The gas estimate for the transaction
+        token:
+          type: string
+          description: The token address to approve
+        amount:
+          type: string
+          description: The amount of tokens to approve
+        spender:
+          type: string
+          description: The spender address to approve
+      required:
+        - tx
+        - gas
+        - token
+        - amount
+        - spender
+    WalletBalance:
+      type: object
+      properties:
+        token:
+          type: string
+          description: The address of the token
+        amount:
+          type: string
+          description: The unformatted balance of the token
+          example: '0x0000000'
+        chainId:
+          type: number
+          description: Chain ID of the network
+        decimals:
+          type: number
+          description: The unformatted balance of the token
+          example: 18
+        price:
+          type: string
+          description: Price of the token in usd
+          example: '0.0'
+        name:
+          type: string
+          description: Name of the token
+        symbol:
+          type: string
+          description: Symbol of the token
+        logoUri:
+          type: string
+          description: Logo of the token
+      required:
+        - token
+        - amount
+        - chainId
+        - decimals
+        - price
+        - name
+        - symbol
+        - logoUri
+    Action:
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+            - approve
+            - borrow
+            - bridge
+            - deposit
+            - singledeposit
+            - multideposit
+            - tokenizedsingledeposit
+            - tokenizedmultideposit
+            - multioutsingledeposit
+            - depositclmm
+            - harvest
+            - permittransferfrom
+            - redeem
+            - singleredeem
+            - multiredeem
+            - tokenizedsingleredeem
+            - tokenizedmultiredeem
+            - redeemclmm
+            - repay
+            - swap
+            - transfer
+            - transferfrom
+            - route
+            - call
+            - split
+            - merge
+            - balance
+            - minamountout
+            - slippage
+            - fee
+            - ensofee
+        inputs:
+          type: object
+          additionalProperties:
+            type: string
+      required:
+        - action
+        - inputs
+    Protocol:
+      type: object
+      properties:
+        slug:
+          type: string
+        url:
+          type: string
+      required:
+        - slug
+        - url
+    Network:
+      type: object
+      properties:
+        id:
+          type: number
+        name:
+          type: string
+      required:
+        - id
+        - name
+    StandardAction:
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+            - approve
+            - borrow
+            - bridge
+            - deposit
+            - singledeposit
+            - multideposit
+            - tokenizedsingledeposit
+            - tokenizedmultideposit
+            - multioutsingledeposit
+            - depositclmm
+            - harvest
+            - permittransferfrom
+            - redeem
+            - singleredeem
+            - multiredeem
+            - tokenizedsingleredeem
+            - tokenizedmultiredeem
+            - redeemclmm
+            - repay
+            - swap
+            - transfer
+            - transferfrom
+            - route
+            - call
+            - split
+            - merge
+            - balance
+            - minamountout
+            - slippage
+            - fee
+            - ensofee
+        name:
+          type: string
+        functionNames:
+          type: array
+          items:
+            type: string
+        supportedChains:
+          type: array
+          items:
+            $ref: '#/components/schemas/Network'
+        inputs:
+          type: array
+          items:
+            type: string
+      required:
+        - action
+        - name
+        - functionNames
+        - supportedChains
+        - inputs
+    Standard:
+      type: object
+      properties:
+        protocol:
+          $ref: '#/components/schemas/Protocol'
+        forks:
+          type: array
+          items:
+            $ref: '#/components/schemas/Protocol'
+        actions:
+          type: array
+          items:
+            $ref: '#/components/schemas/StandardAction'
+      required:
+        - protocol
+        - forks
+        - actions
+    ProtocolModel:
+      type: object
+      properties:
+        project:
+          type: string
+          example: uniswap
+        slug:
+          type: string
+          example: uniswap-v2
+        name:
+          type: string
+          example: Uniswap V2
+          nullable: true
+        description:
+          type: string
+          nullable: true
+        url:
+          type: string
+          example: https://app.uniswap.org/swap
+          nullable: true
+        logosUri:
+          example: https://icons.llama.fi/uniswap-v2.png
+          nullable: true
+          type: array
+          items:
+            type: string
+        chains:
+          nullable: true
+          example:
+            - id: 1
+              name: mainnet
+          type: array
+          items:
+            $ref: '#/components/schemas/Network'
+      required:
+        - project
+        - slug
+        - name
+        - description
+        - url
+        - logosUri
+        - chains
+    ActionToBundle:
+      type: object
+      properties:
+        protocol:
+          type: string
+          description: Protocol to interact with
+          example: enso
+        action:
+          type: string
+          enum:
+            - approve
+            - borrow
+            - bridge
+            - deposit
+            - singledeposit
+            - multideposit
+            - tokenizedsingledeposit
+            - tokenizedmultideposit
+            - multioutsingledeposit
+            - depositclmm
+            - harvest
+            - permittransferfrom
+            - redeem
+            - singleredeem
+            - multiredeem
+            - tokenizedsingleredeem
+            - tokenizedmultiredeem
+            - redeemclmm
+            - repay
+            - swap
+            - transfer
+            - transferfrom
+            - route
+            - call
+            - split
+            - merge
+            - balance
+            - minamountout
+            - slippage
+            - fee
+            - ensofee
+          example: route
+        args:
+          type: object
+          example:
+            tokenIn: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
+            tokenOut: '0xae7ab96520DE3A18E5e111B5EaAb095312D7fE84'
+            amountIn: '100000000000'
+            slippage: '300'
+            fee:
+              - '100'
+            feeReceiver: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045'
+      required:
+        - protocol
+        - action
+        - args
+    BundleShortcutTransaction:
+      type: object
+      properties:
+        bundle:
+          type: array
+          items:
+            $ref: '#/components/schemas/ActionToBundle'
+        gas:
+          type: string
+          description: Gas estimate for the transaction
+        amountsOut:
+          type: object
+          description: Expected output amounts by token address
+        route:
+          description: The route the shortcut will use
+          type: array
+          items:
+            $ref: '#/components/schemas/Hop'
+        createdAt:
+          type: number
+          description: Block number the transaction was created on
+        tx:
+          description: The tx object to use in `ethers`
+          allOf:
+            - $ref: '#/components/schemas/Transaction'
+      required:
+        - bundle
+        - route
+        - createdAt
+        - tx
+    IporShortcutInput:
+      type: object
+      properties:
+        isRouter:
+          type: boolean
+          description: Flag that indicates whether to use the shared router
+          nullable: true
+        amountIn:
+          type: string
+          description: Amount of tokenIn in wei
+          example: '1000000000000000'
+        tokenIn:
+          type: string
+          description: >-
+            Address of the tokenIn. For ETH, use
+            0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
+          example: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
+        tokenBToBuy:
+          type: string
+          description: Address of the tokenBToBuy
+          example: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'
+        percentageForTokenB:
+          type: string
+          description: Percentage of tokenB to buy in basis points (1/10000)
+          example: '5000'
+        slippage:
+          type: string
+          description: Slippage in basis points (1/10000). Default is 300
+          example: '300'
+          default: '300'
+        simulate:
+          type: boolean
+          description: >-
+            Flag that indicates whether to simulate the transaction, verify some
+            assertions, return simulationURL and events
+          nullable: true
+          default: false
+      required:
+        - amountIn
+        - tokenIn
+        - tokenBToBuy
+        - percentageForTokenB
+    IporShortcutTransaction:
+      type: object
+      properties:
+        createdAt:
+          type: number
+          description: Block number the transaction was created on
+        tx:
+          description: The tx object to use in `ethers`
+          allOf:
+            - $ref: '#/components/schemas/Transaction'
+        logs:
+          description: Logs from the simulated transaction
+          type: array
+          items:
+            type: string
+        simulationURL:
+          type: string
+          description: Tenderly simulation URL
+      required:
+        - createdAt
+        - tx
+        - logs
+        - simulationURL
+    NonTokenizedModel:
+      type: object
+      properties:
+        chainId:
+          type: number
+          description: Chain ID of the network of the nontokenized position
+        protocol:
+          type: string
+          description: >-
+            The specific standard integration or version of the nontokenized
+            position
+        address:
+          type: string
+          description: Ethereum address of the nontokenized position
+        primaryAddress:
+          type: string
+          description: Ethereum address of the nontokenized position
+        underlyingTokens:
+          description: Underlying tokens of nontokenized position
+          nullable: true
+          type: array
+          items:
+            $ref: '#/components/schemas/TokenModel'
+      required:
+        - chainId
+        - protocol
+        - address
+        - primaryAddress
+        - underlyingTokens
+    Project:
+      type: object
+      properties:
+        id:
+          type: string
+        chains:
+          type: array
+          items:
+            type: string
+      required:
+        - id
+        - chains
+security:
+  - bearer: []