@crewhaus/tool-defi 0.7.0 → 0.8.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,9 @@
+CrewHaus Factory
+Copyright 2026 Max Meier
+
+This product includes software developed by Max Meier
+(operating as StudioMax — https://studiomax.io) and contributors.
+
+The CrewHaus name and logo are trademarks of Max Meier. See
+https://github.com/crewhaus/factory/blob/main/TRADEMARK.md for the
+use-of-marks policy.

package/README.md

@@ -131,7 +131,24 @@ a holding goes to `unpriced[]` — never to zero, never to absence — when:
 - its Pyth confidence band is past the bound you supplied;
 - its token's `decimals()` could not be read and none was given (defaulting to
   18 on a six-decimal token is a factor of a trillion);
-- a provider refused, rate-limited, or answered in the wrong currency.
+- a provider refused, rate-limited, or answered in the wrong currency;
+- the call ran out of time, or out of provider requests, before reaching it.
+
+`timeoutMs` is one deadline for the **whole call**, every request it makes
+included (20 s by default; 60 s for `PortfolioValuation`, which reads
+holding by holding; 120 s at most). Once it passes, nothing more is asked of
+anybody: the holdings not yet priced are listed with that reason, and a note
+says how many. A `PortfolioValuation` also sends at most four requests to the
+public price providers per holding priced from one (what an asset nobody lists
+costs in a fiat currency), between 16 and 512 for the call; a single
+`PriceQuote` sends at most 16. A pair or a leg already fetched is reused rather
+than asked for again, so twenty holdings of BTC cost one quote. The requests
+go out in rounds, one per holding still unpriced, and a round runs only when
+every such holding can have one, so which holdings get priced never depends on
+where they sit in the list: tokens no provider lists, ahead of a holding, take
+no more of the budget than it gets. A route the budget did not ask is named as "not asked" in its
+row — never as something the provider does not publish — and a note counts
+those rows.
 
 `weightBps` is a share of the **priced** total, which is stated in the payload
 too — the weights of an incomplete portfolio still sum to 10000, and that is
@@ -192,8 +209,9 @@ than a negative number.
 
 ## Configuration
 
-Endpoints and pinned feeds come from the `defi` `tool_config` block, or from
-`registerDefiConfig(...)` at boot. **No caller ever supplies a URL** — that is
+Endpoints and pinned feeds come from the `defi` `tool_config` block (a
+compiled bundle and `crewhaus run` register it at boot), or from
+`registerDefiConfig(...)`. **No caller ever supplies a URL** — that is
 what keeps the network surface short: there is no model-chosen host to defend,
 so no allow-list to widen and no SSRF gate to get subtly wrong, and an
 operator's own node on `127.0.0.1:8545` is a first-class endpoint rather than
@@ -201,7 +219,7 @@ something a private-address rule has to be argued out of.
 
 ```jsonc
 {
-  "rpc":        { "1": "https://eth-mainnet.example/v2/KEY" },
+  "rpc":        { "1": "$ETH_RPC_URL" },
   "multicall3": { "1": "0xcA11bde05977b3631167028862bE2a173976CA11" },
   "feeds": {
     "eth-usd": {
@@ -214,6 +232,11 @@ something a private-address rule has to be argued out of.
 }
 ```
 
+A provider keeps its API key in the RPC URL's path, so write the endpoint as a
+`$VAR` reference: the bundle reads it from the environment when it starts, and
+the key never sits in the spec, the spec registry or the compiled bundle. An
+unset variable stops the start and names it.
+
 A per-call block **replaces** the boot registration rather than merging into it,
 which is the same replace semantics every other tool_config block here has.
 `multicall3` is an optimisation, not a requirement: with it, forty reads are one

package/dist/index.d.ts

@@ -3,6 +3,27 @@ import type { RegisteredTool } from "@crewhaus/tool-catalog";
 export { _setFetch, _setClock, _resetDefiConfig, registerDefiConfig, getDefiConfig, type Clock, type DefiConfig, type DefiConfigInput, type DefiFetch, DefiError, } from "./lib/rpc";
 export { PROVIDER_ORIGINS, type ProviderName } from "./lib/quotes";
 export { SUPPORTED_PROTOCOLS, REFUSED_PROTOCOLS, type Protocol } from "./lib/positions";
+/**
+ * PortfolioValuation's default deadline. It reads a balance batch, an oracle
+ * or a quote per holding, one after another, for up to 256 holdings, so it
+ * gets more time than a single read; every other tool here uses
+ * DEFAULT_TIMEOUT_MS.
+ */
+export declare const PORTFOLIO_DEFAULT_TIMEOUT_MS = 60000;
+/**
+ * How many requests one call may send to the public price providers. A single
+ * PriceQuote needs at most fifteen (direct, inverted, then crossed through two
+ * intermediates), so its budget is a backstop. PortfolioValuation's is four
+ * per holding priced from a provider — what an asset no provider lists costs
+ * in a fiat quote currency: direct, inverse, and both via USD — between
+ * PriceQuote's sixteen and {@link PORTFOLIO_PROVIDER_REQUESTS}; an answer
+ * already fetched in the same call is reused, not counted again. The
+ * requests go out in rounds, one per holding still unpriced, and only whole
+ * rounds run, so which holdings are priced does not depend on their order
+ * (see valuePortfolio and ProviderLedger.allowance).
+ */
+export declare const PRICE_QUOTE_PROVIDER_REQUESTS = 16;
+export declare const PORTFOLIO_PROVIDER_REQUESTS = 512;
 export declare const priceQuote: RegisteredTool;
 export declare const oraclePriceRead: RegisteredTool;
 export declare const defiPositionRead: RegisteredTool;