@juanscilingo/vaults-cli 0.1.1-alpha.0 → 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Sentora Digital Holdings (BVI) Ltd
+
+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.

package/README.md

@@ -6,24 +6,24 @@ branchable exit codes, self-describing commands. Every command is a query —
 nothing here signs or sends.
 
 ```sh
-npm run build          # bundles to dist/cli.mjs (esbuild, single file)
-npx smart-yield --help
+npm install -g @juanscilingo/vaults-cli    # or run once: npx -p @juanscilingo/vaults-cli smart-yield --help
+smart-yield --help
 ```
 
 ## A yield evaluation in four commands
 
 ```sh
 # 1. What vaults exist? (filter by chain, family, curator; project fields)
-smart-yield yields list --chain 1 --fields name,family,contracts
+smart-yield yields list --chain eip155:1 --fields "name,family,contracts"
 
 # 2. How do candidates perform? (summary stats, not raw series)
-smart-yield yields analytics --chain-id 1 --address 0xVAULT --days 30 --summary
+smart-yield yields analytics --chain-id eip155:1 --address 0xVAULT --days 30 --summary
 
 # 3. Preflight several vaults in ONE call: family + meta + gates + your position
-smart-yield snapshot --vault 0xA,0xB,0xC --owner 0xYOU --rpc-url $RPC
+smart-yield snapshot --vault "0xA,0xB,0xC" --owner 0xYOU --rpc-url $RPC
 
 # 4. Build the deposit — unsigned steps, previewed outcome, named blockers
-smart-yield upshift-financial plan-deposit --vault 0xA --amount 10000 --human --owner 0xYOU --rpc-url $RPC
+smart-yield upshift_evm plan-deposit --vault 0xA --amount 10000 --human --owner 0xYOU --rpc-url $RPC
 ```
 
 Plans return ordered unsigned `{to, data, value}` steps for any signer, with
@@ -38,9 +38,9 @@ smart-yield <family> <command> [flags]
 
 | scope | commands |
 |---|---|
-| top-level | `describe [--family <f>]` · `detect --vault 0x…` · `snapshot --vault 0xA[,0xB…] [--owner]` |
-| `yields` (API) | `list` · `get` · `analytics` · `risk` · `balance` · `activity` · `positions` · `blockchains` |
-| `upshift-financial` | `meta` · `position` · `gates` · `plan-deposit` · `plan-redeem [--instant]` · `plan-claim` · `epoch` |
+| top-level | `describe [--family <f>]` · `detect --vault 0x…` · `snapshot --vault "0xA[,0xB…]" [--owner] [--base-url]` |
+| `yields` (API) | `list` · `get` · `analytics` · `risk` · `main-insights` · `balance` · `activity` · `positions` · `blockchains` |
+| `upshift_evm` | `meta` · `position` · `gates` · `plan-deposit` · `plan-redeem [--instant]` · `plan-claim` · `epoch` · `pending-withdrawals` |
 | `boring` (Veda) | `discover` · `position` · `plan-deposit` · `plan-withdraw` |
 | `morpho` | `meta` · `position` · `gates` · `plan-deposit` · `plan-redeem` |
 
@@ -62,15 +62,18 @@ classifies any address on-chain and refuses to guess unknown architectures
 - Plan results and `describe` carry `schemaVersion` — bumped on any breaking
   shape change; pin automations to it.
 - Amounts are base units by default (`1000000` = 1 USDC); `--human` accepts
-  decimals (`100.5`) and scales by on-chain token decimals. Outputs always
-  include human twins where decimals are known.
+  decimals (`100.5`) and scales by on-chain token decimals. Plans add
+  `expectedFormatted` when `expected` has values, and `morpho meta` /
+  `upshift_evm meta` add `formatted`. `yields` amounts come from the API and
+  are already token units or USD, except fields ending in `Raw`. Other
+  on-chain outputs carry only base units.
 
 ## Performance
 
-Reads batch through Multicall3 — one RPC round trip per command instead of
-one per contract call (`--no-multicall` opts out on chains without the
-canonical deployment). `--timeout <ms>` bounds every network call (default
-30s). `yields analytics --summary` / `--last N` and `list --fields/--limit/
+Reads batch through Multicall3, so a command makes a few RPC round trips
+instead of one per contract call (`--no-multicall` opts out on chains without
+the canonical deployment). `--timeout <ms>` bounds every network call (default
+30s, `0` = no limit). `yields analytics --summary` / `--last N` and `list --fields/--limit/
 --offset` keep responses small; truncation is always announced.
 
 ## Configuration
@@ -82,19 +85,13 @@ canonical deployment). `--timeout <ms>` bounds every network call (default
 | yields API key | — (env only, never a flag) | `YIELDS_API_KEY`, `SENTORA_API_KEY` |
 
 Shell note: pipes mask exit codes (`$?` is the last pipeline element) — branch
-on `${PIPESTATUS[0]}` or run unpiped. `npm run cli` flattens exit codes; invoke
-`npx smart-yield` or the bundle directly when branching.
-
-> **Note:** `yields list` currently serves an embedded catalog snapshot in the
-> [next API schema](../../docs/api-vault-schema-proposal.md); every response
-> carries a `notice` field saying so. All other `yields` commands hit the live
-> API.
+on `${PIPESTATUS[0]}` or run unpiped.
 
 ## Using from agent frameworks
 
 Shell-capable coding agents use this CLI directly (below). Frameworks that
 consume tools instead of binaries (LangChain, CrewAI, OpenAI Agents SDK, IDE
-MCP configs, …) use [`@sentora/vaults-mcp`](../vaults-mcp/README.md) — an MCP
+MCP configs, …) use [`@juanscilingo/vaults-mcp`](https://www.npmjs.com/package/@juanscilingo/vaults-mcp) — an MCP
 stdio server generated from this CLI's command registry. This package itself
 stays dependency-free either way.
 
@@ -113,7 +110,7 @@ CLI, …) or `CLAUDE.md`:
 ## smart-yield CLI
 Read-only Sentora vault CLI: discovery, yield analytics, positions, and
 UNSIGNED tx plans as JSON. Run `smart-yield describe` for the full surface.
-Exit codes: 0 ok · 2 usage · 3 not found · 4 rpc/network (retryable) ·
+Exit codes: 0 ok · 1 unexpected · 2 usage · 3 not found · 4 rpc/network (retryable) ·
 5 upstream api · 6 contract revert · 7 plan blocked (NEVER execute a blocked
 plan). Auth: YIELDS_API_KEY env (never a flag). RPC: VAULTS_RPC_URL env or
 --rpc-url. Plans are unsigned — hand them to the signer; never sign a plan
@@ -123,7 +120,7 @@ with non-empty blockers.
 Permission allowlists (the CLI is read-only, safe to pre-approve):
 
 - Claude Code `.claude/settings.json`:
-  `{"permissions": {"allow": ["Bash(smart-yield *)", "Bash(npx smart-yield *)"]}}`
+  `{"permissions": {"allow": ["Bash(smart-yield *)", "Bash(npx -p @juanscilingo/vaults-cli smart-yield *)"]}}`
 - Gemini CLI `settings.json`:
   `{"tools": {"core": ["run_shell_command(smart-yield)"]}}`
 - Codex: network egress is off in the default sandbox — set
@@ -136,5 +133,4 @@ Permission allowlists (the CLI is read-only, safe to pre-approve):
 Architecture in one line: this package is argv parsing, JSON serialization,
 and exit codes — all vault logic lives in the family SDKs
 (`@sentora/vaults-{upshift-financial,boring,morpho}`), plans in
-`@sentora/vaults-plan`, API access in `@sentora/yields-client`. Built per
-[docs/agent-cli-guidelines.md](../../docs/agent-cli-guidelines.md).
+`@juanscilingo/vaults-plan`, API access in `@juanscilingo/yields-client`.

package/dist/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,143 @@
+# Third-party notices
+
+This bundle includes the following packages.
+
+## @noble/curves@1.9.1
+
+License: MIT
+
+````text
+The MIT License (MIT)
+
+Copyright (c) 2022 Paul Miller (https://paulmillr.com)
+
+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.
+````
+
+## @noble/hashes@1.8.0
+
+License: MIT
+
+````text
+The MIT License (MIT)
+
+Copyright (c) 2022 Paul Miller (https://paulmillr.com)
+
+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.
+````
+
+## abitype@1.2.3
+
+License: MIT
+
+````text
+MIT License
+
+Copyright (c) 2022-present weth, LLC
+
+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.
+````
+
+## ox@0.14.33
+
+License: MIT
+
+````text
+MIT License
+
+Copyright (c) 2023-present wevm
+
+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.
+````
+
+## viem@2.55.15
+
+License: MIT
+
+````text
+MIT License
+
+Copyright (c) 2023-present weth, LLC
+
+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.
+````