@aegis-engine/core 0.2.0 → 0.3.1

package/README.md

@@ -1,10 +1,11 @@
 # Aegis Core
 
-React-free swap operations for Aegis integrations.
+React-free Swap and Engine operations for Aegis integrations.
 
 `@aegis-engine/core` is the operations layer behind the Aegis swap experience.
-Use it when you want Aegis direct-pool swaps or KyberSwap aggregated routes
-inside your own UI instead of using a prebuilt widget.
+Use it when you want Aegis direct-pool swaps, KyberSwap aggregated routes, or
+Aegis Engine lend/borrow/position flows inside your own UI instead of using a
+prebuilt widget.
 
 ## Install
 
@@ -13,7 +14,8 @@ npm install @aegis-engine/core viem
 ```
 
 `viem` is a peer dependency because hosts usually already own their wallet and
-RPC setup.
+RPC setup. The protocol implementation used by Engine quotes is bundled into
+the published Core package; consumers do not need GitHub Packages credentials.
 
 ## What It Supports
 
@@ -23,6 +25,14 @@ RPC setup.
 - ERC-20 approvals, Permit2 signing, Permit2 on-chain fallback, wallet chain
   switching, transaction submission, replacement tracking, and receipt summaries.
 - Token, market, chain, metadata, polling, and progress helpers for custom UIs.
+- Display-only historical token prices through the public REST backend,
+  normalized into chronological typed points.
+- Engine REST market and wallet-position snapshots with runtime validation,
+  bounded session caches, and explicit indexed freshness.
+- Engine 12-hour market-metric history for optional rate, utilization, and
+  liquidity charts.
+- Engine lend and borrow quotes, exact rounded LP-shaped debt/carry
+  projections, collateral sizing, Permit2 preparation, and guarded execution.
 
 Direct pool swaps support `exactIn` and `exactOut`. KyberSwap routes currently
 support `exactIn` only because Kyber's route/build flow is exact-input.
@@ -30,6 +40,101 @@ support `exactIn` only because Kyber's route/build flow is exact-input.
 Core does not ship a hardcoded pool list. The widget or host app should own pool
 selection and pass the selected market into the operation functions.
 
+## Engine REST and protocol boundary
+
+Engine discovery and wallet positions default to partner-safe REST:
+
+```ts
+import {
+  fetchEngineMarketHistory,
+  fetchEngineMarkets,
+  fetchEnginePositionsSnapshot
+} from '@aegis-engine/core'
+
+const source = {
+  kind: 'rest' as const,
+  baseUrl: 'https://your-engine-api.example',
+  timeoutMs: 10_000
+}
+
+const markets = await fetchEngineMarkets({ source, chainId: 1 })
+const positions = await fetchEnginePositionsSnapshot({
+  source,
+  chainId: 1,
+  account
+})
+const marketHistory = await fetchEngineMarketHistory({
+  source,
+  marketId: markets[0].id,
+  window: '30d'
+})
+```
+
+Hosts that already own deterministic market/position metadata can instead use
+the typed `static` source. Engine market history remains a REST capability.
+
+The REST service supplies facts and provenance. Core owns live RPC reads,
+collateral/debt math, quote freshness, recipe construction, simulation,
+approval, and send. `positions.freshness` is indexed provenance:
+`lastLockedPips` / `lastLockedPct` are not current health. A current health
+claim requires a fresh StateView/RPC snapshot.
+
+Market snapshots preserve the backend's current Engine rate, fee, surge, and
+freshness fields, including `borrowAprPct`, `lendApyPct`, `rateSource`,
+`baseFeePpm`, `activeFeePpm`, `surgeFeePpm`, `surgeActive`, `inCapEvent`, and
+the associated read timestamps/block. Market history comes from
+`GET /v1/engine/markets/{marketId}/history`; pass the exact `market.id` returned
+by discovery because Engine market IDs are case-sensitive. Its status is
+`ready`, `warming_up`, or `no_data`, and unavailable metrics remain `null`.
+
+Position reads prefer `GET /v1/engine/positions/v2`, which returns borrow
+vaults and indexed lender-share positions. Core exposes them separately as
+`positions` and `lendPositions`. If a backend returns `404` for v2, Core falls
+back to the frozen v1 route; check `schemaVersion` before claiming lender
+coverage. Lender share balances are indexed raw share units and require a
+current share price before valuation.
+
+Shared REST reads have bounded in-memory caches and a 10-second default request
+timeout. A consumer abort only detaches that caller; it does not cancel a
+request shared by another mounted widget. Set `timeoutMs` on the REST source
+when a host needs a stricter boundary.
+
+Borrowing always requires collateral. Engine debt is a two-token full-range LP
+obligation, so carry is calculated from the exact rounded LP debt frame rather
+than only the token amount received. Repayment requires both pool tokens;
+remaining collateral stays in the vault until a separate withdrawal. A
+one-token lend is a zap into a two-sided full-range LP, not single-token
+lending.
+
+## Historical token prices
+
+Historical prices are intentionally separate from Engine market and
+transaction truth. A host reads one exact token through the public REST
+backend without placing private data-service credentials in the client:
+
+```ts
+import {
+  AEGIS_BACKEND_PROD_BASE_URL,
+  fetchTokenPriceHistory
+} from '@aegis-engine/core'
+
+const history = await fetchTokenPriceHistory({
+  baseUrl: AEGIS_BACKEND_PROD_BASE_URL,
+  chainId: 8453,
+  tokenAddress,
+  window: '30d'
+})
+```
+
+The helper calls
+`GET /v1/tokens/{chainId}/{address}/price-history?window=30d`, validates the
+response identity and status, and returns ascending `{ timestamp, priceUsd }`
+observations. Native-token sentinels are looked up under the backend's zero
+address key. `ready`, `warming_up`, and `no_data` are explicit; malformed or
+identity-mismatched responses reject so a UI can log them while failing soft.
+Use the series for display trends only; current quotes and executable prices
+still come from the live market/RPC boundary.
+
 ## Wallet Sessions
 
 Execution functions take a `WalletSession`:

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,211 @@
+# Third-party notices
+
+The lazy Engine implementation includes code from these MIT-licensed works:
+
+- `@labs-solo/aegis-engine-sdk` 0.30.0 — Copyright (c) 2026 Solo Labs
+- `@uniswap/sdk-core` 6.1.1 and 7.18.0 — Copyright (c) 2021 Uniswap Labs
+- `@uniswap/v3-sdk` 3.27.0 — Copyright (c) 2021 Uniswap Labs
+- `tiny-invariant` 1.3.3 — Copyright (c) 2019 Alexander Reardon
+- `big.js` 5.2.2 — Copyright (c) 2018 Michael Mclaughlin
+- `decimal.js-light` 2.5.1 — Copyright (c) 2020 Michael Mclaughlin
+- `toformat` 2.0.0 — Copyright (c) 2017 Michael Mclaughlin
+
+The following MIT License applies to each work listed above:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+The lazy Engine implementation also includes `jsbi` 3.2.5 under the Apache
+License, Version 2.0:
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/dist/actions/kyberSwap.d.ts

@@ -1,11 +1,12 @@
 import { type Address, type Hex, type PublicClient } from 'viem';
+import { UserFacingError } from '../errors.js';
 import type { AegisSwapChainConfig, AegisSwapToken } from '../config/index.js';
 import type { AegisSwapApprovalMode, WalletSession } from '../swap/types.js';
 import type { AggregatedSwapQuote } from '../types/aggregatedSwap.js';
 import type { AegisSwapActionCallbacks, AegisSwapActionResult } from './types.js';
-export declare const NATIVE_TOKEN_ADDRESS: Address;
+export { NATIVE_TOKEN_ADDRESS } from '../address.js';
 export declare function isNativeToken(token: AegisSwapToken): boolean;
-export declare class KyberSwapPriceMovedError extends Error {
+export declare class KyberSwapPriceMovedError extends UserFacingError {
     readonly quote: AggregatedSwapQuote;
     constructor(quote: AggregatedSwapQuote);
 }

package/dist/address.d.ts

@@ -1,4 +1,6 @@
-import type { Address, Hex } from 'viem';
+import { type Address, type Hex } from 'viem';
+export declare const NATIVE_TOKEN_ADDRESS: Address;
+export declare function isNativeAssetAddress(address: Address): boolean;
 export declare function addressKey(address: Address | null | undefined): string;
 export declare function sameAddress(a: Address, b: Address): boolean;
 export declare function sameOptionalAddress(a: Address | null, b: Address | null): boolean;