@sage-protocol/sdk 0.0.3

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/README.md

@@ -0,0 +1,281 @@
+[![Node.js Package](https://github.com/sage-protocol/sdk/actions/workflows/npm-publish-github-packages.yml/badge.svg)](https://github.com/sage-protocol/sdk/actions/workflows/npm-publish-github-packages.yml)
+
+Sage Protocol SDK
+=================
+
+Purpose
+-------
+- Backend-agnostic helpers for interacting with Sage Protocol contracts (governance, SubDAOs, libraries, prompts, tokens).
+- Shared foundation for the CLI, backend services, and upcoming web UI.
+
+Design Principles
+-----------------
+- Pure data in/out; no console prompts or environment coupling.
+- Minimal ABI fragments maintained alongside the contracts (see `src/abi`).
+- Composable modules – import only what you need.
+
+Quick Start
+-----------
+```bash
+npm i --workspace sage-protocol-sdk
+```
+
+```js
+import sdk from 'sage-protocol-sdk';
+
+const provider = sdk.getProvider({ rpcUrl: 'https://base-sepolia.publicnode.com' });
+
+// Discover SubDAOs deployed by the latest factory
+const subdaos = await sdk.subdao.discoverSubDAOs({
+  provider,
+  factoryAddress: '0x396Ac71fa8145a89a38B02a7235798c1cD350966',
+  fromBlock: 0,
+});
+
+// Fetch governance metadata for a SubDAO governor
+const info = await sdk.governance.getGovernorInfo({ provider, governor: subdaos[0].governor });
+```
+
+**CommonJS usage**
+
+```js
+const sdk = require('sage-protocol-sdk');
+```
+
+Module Overview
+---------------
+
+| Module | Highlights | Typical Use |
+| ------ | ---------- | ----------- |
+| `getProvider()` | Minimal ethers v6 RPC helper | Shared provider across mini app, CLI, agents |
+| `governance` | Governor metadata, proposal listings, tx builders | Voting dashboards, automation bots |
+| `timelock` | Min delay, queued operation inspection, schedule/cancel builders | Safe workflows, monitoring |
+| `factory` | Config reads, template enumeration, SubDAO create/fork builders | Launch tooling, analytics |
+| `library` | Manifest listings & scoped ownership checks | Prompt library browsers |
+| `prompt` | Prompt metadata, fork counts, usage counters | UI prompt catalogues, agent prompt selection |
+| `subdao` | Discovery, staking helpers, per-user stats | SubDAO directories, onboarding |
+| `token` | SXXX balances/allowances, burner discovery, tx builders | Wallet gating, burner dashboards |
+| `treasury` | Reserve/POL snapshot, pending withdrawals, liquidity plans | Treasury analytics, Safe operators |
+| `boost` | Merkle/Direct boost readers + builders | Incentive distribution tooling |
+| `subgraph` | GraphQL helpers for proposals/libraries | Historical analytics |
+| `adapters` | Normalized governance adapters (OZ) | UI layers needing a unified model |
+| `errors` | `SageSDKError` codes | Consistent downstream error handling |
+
+### Examples
+
+- [Legacy base mini app hook](examples/base-mini-app/README.md) – React-friendly context mirroring the former in-repo app (now maintained externally).
+- [Eliza agent recipe](examples/agent-eliza/README.md) – exposes SDK helpers to agent toolchains.
+
+Important
+- For all write calls to the factory (create/fork/stable-fee flows), pass the SubDAOFactory diamond proxy address as `factoryAddress`. Legacy monolithic factory routes have been removed.
+
+Deprecations
+------------
+- `resolveGovernanceContext` is still exported for compatibility but now logs a deprecation warning. Use the richer `governance` + `subdao` helpers instead.
+
+Next Phases
+-----------
+Phase 6 focuses on integration polish and packaging. Track progress in the [SDK Improvement Specification](../../docs/SDK_Improvement_Specification.md).
+
+API Notes and Examples
+----------------------
+
+Salted Proposal Descriptions
+```js
+import sdk from 'sage-protocol-sdk';
+// buildProposeTx() auto‑salts descriptions unless you pass a bytes32 description hash
+const tx = sdk.governance.buildProposeTx({
+  governor: '0xGov',
+  targets: ['0xTarget'],
+  values: [0n],
+  calldatas: ['0x...'],
+  descriptionOrHash: 'My Title', // will append \n\n[SALT:0x...] automatically
+});
+```
+
+Private Transaction Submission
+```js
+import sdk from 'sage-protocol-sdk';
+// Submit signed private transaction via builder/relay RPC (eth_sendPrivateTransaction)
+const { hash } = await sdk.utils.privateTx.sendTransaction({
+  signer, // ethers v6 signer
+  tx: { to: '0xGov', data: '0x...', value: 0n },
+  privateRpcUrl: process.env.SAGE_PRIVATE_RPC,
+});
+```
+
+Subgraph‑First Prompt Reads (with tag filters)
+```js
+import sdk from 'sage-protocol-sdk';
+
+// Bulk listing by registry (subgraph)
+const items = await sdk.subgraph.listRegistryPrompts({
+  url: process.env.SAGE_SUBGRAPH_URL,
+  registry: '0xRegistry',
+  first: 50,
+});
+
+// Filter by tagsHash (bytes32), optionally scope to a registry
+const tagged = await sdk.subgraph.listPromptsByTag({
+  url: process.env.SAGE_SUBGRAPH_URL,
+  tagsHash: '0xabc123...'
+});
+
+// On‑chain bounded fallback (IDs): latest prompts
+const onchainLatest = await sdk.prompt.listPrompts({ provider, registry: '0xRegistry', limit: 50 });
+
+// On‑chain bounded tag page
+const onchainPage = await sdk.prompt.listByTagPage({ provider, registry: '0xRegistry', tagHash: '0xabc123...', offset: 0, limit: 25 });
+```
+
+Environment Controls
+```bash
+# Private txs
+export SAGE_PRIVATE_RPC=https://builder.your-relay.example/rpc
+
+# Deterministic proposal salt (for reproducible ids)
+export SAGE_GOV_SALT=0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+
+# Disable auto‑salt (not recommended)
+export SAGE_GOV_SALT_DISABLE=1
+```
+# New/Updated Helpers (2025-10)
+
+Factory enumeration (CLI parity)
+```js
+// Full list of SubDAO addresses from factory storage
+const addrs = await sdk.factory.listSubDAOs({ provider, factory: FACTORY });
+
+// Indexed range with indices returned
+const indexed = await sdk.factory.listSubDAOsIndexed({ provider, factory: FACTORY, from: 0n, to: 99n });
+// → [{ index: 0, address: '0x...' }, ...]
+```
+
+Governance overloads and quorum
+```js
+// Build queue/execute using arrays+descriptionHash when supported; else fall back to id-based
+const ol = await sdk.governance.detectGovernorOverloads({ provider, governor });
+if (ol.hasQueueArrays) {
+  const q = sdk.governance.buildQueueTx({ governor, targets, values, calldatas, descriptionOrHash: descHash });
+} else if (ol.hasQueueById) {
+  const q = sdk.governance.buildQueueByIdTx({ governor, proposalId });
+}
+
+// Quorum at a snapshot
+const quorum = await sdk.governance.getQuorumAt({ provider, governor, blockTag: 12_345n });
+// Convenience: quorum at latest-1
+const qLatest = await sdk.governance.getQuorumLatestMinusOne({ provider, governor });
+```
+
+Self‑delegate convenience (ERC20Votes)
+```js
+// Build a delegate(self) tx from a Governor (reads sxxxToken address)
+const tx = await sdk.governance.buildDelegateSelfTx({ provider, governor, account: user });
+// send via userOp (CDP) or EOA
+```
+
+Proposal timeline (subgraph)
+```js
+const t = await sdk.subgraph.getProposalTimeline({ url: SUBGRAPH_URL, id: idHexOrDecimal });
+// { id, createdAt, queuedAt, executedAt, canceledAt, eta, state }
+```
+
+Prompt pagination helpers
+```js
+const totalByTag = await sdk.prompt.getByTagCount({ provider, registry, tagHash });
+const page = await sdk.prompt.listByTagPage({ provider, registry, tagHash, offset: 0, limit: 25 });
+```
+
+Operator SubDAO helpers
+```js
+// One-click create + operatorize
+const res = await sdk.subdao.createOperatorSubDAO({
+  signer,
+  factoryAddress: FACTORY,
+  operator: '0xSafeOrEOA',
+  name: 'My SubDAO',
+  description: 'Operator controlled',
+  accessModel: 0,
+  minStakeAmount: 0n,
+  burnAmount: 1500n * 10n**18n,
+  sxxx: SXXX,
+});
+
+// Convert existing SubDAO to operator mode
+await sdk.subdao.makeOperator({ signer, subdao: res.subdao, operator: '0xSafeOrEOA', grantAdmin: false });
+
+// Ensure SXXX approval for factory burn if needed
+await sdk.subdao.ensureSxxxBurnAllowance({ signer, sxxx: SXXX, spender: FACTORY, amount: 1500n * 10n**18n });
+```
+# Governance Adapter (OpenZeppelin)
+
+Normalize proposals/timelines across OZ governors with a compact adapter, inspired by Boardroom’s pattern.
+
+```js
+import sdk from 'sage-protocol-sdk';
+import { getProvider } from 'sage-protocol-sdk';
+
+const provider = getProvider({ rpcUrl: process.env.RPC_URL });
+const tr = sdk.adapters.transports.createTransports({ provider, signer: null, subgraph: process.env.SAGE_SUBGRAPH_URL });
+
+// List proposals (paged by block ranges)
+const page = await sdk.adapters.governance.openzeppelin.getProposals({
+  provider,
+  governor: '0xGovernor',
+  fromBlock: 0,
+  toBlock: 'latest',
+  pageSize: 10_000,
+  // Optional: improve signature resolution
+  // ChainId is auto-detected from provider; you can override via chainId if needed.
+  // The adapter will try Sourcify → Etherscan/BaseScan automatically using NEXT_PUBLIC_ETHERSCAN_API_KEY.
+  // You may override with your own abiResolver as needed.
+  abiResolver: async ({ address, chainId }) => null,
+  selectorResolver: async (selector) => null,        // plug in 4byte or your mapping
+});
+
+// On‑chain timeline fallback
+const t = await sdk.adapters.governance.openzeppelin.getTimelineOnchain({
+  provider,
+  governor: '0xGovernor',
+  id: page.items[0].id,
+});
+
+// Signature list (best effort; uses Sourcify → Etherscan/BaseScan (with NEXT_PUBLIC_ETHERSCAN_API_KEY) → 4byte)
+const sigs = await sdk.adapters.governance.openzeppelin.getSignatureList({
+  provider,
+  targets: page.items[0].targets,
+  calldatas: page.items[0].calldatas,
+  // optional resolvers (provide only if you have your own fetchers)
+  abiResolver: async ({ address, chainId }) => null,
+  selectorResolver: async (selector) => null,
+});
+
+// Proposal events page (Created/Queued/Executed/Canceled) with pagination cursor
+const evPage = await sdk.adapters.governance.openzeppelin.getProposalEventsPage({
+  provider,
+  governor: '0xGovernor',
+  fromBlock: 0,
+  toBlock: 'latest',
+  pageSize: 20_000,
+});
+// evPage.items: [{ type:'created'|'queued'|'executed'|'canceled', blockNumber, timestamp, txHash, id }]
+// evPage.nextCursor: { fromBlock } | null
+```
+
+Proposal model returned by adapter:
+- id (bigint), proposer (address), createdAt (seconds), startBlock, endBlock, quorum (bigint|null), txHash, targets[], values[], calldatas[], signatures[]
+# Explorer API keys
+
+Set one or more of the following to improve ABI resolution in adapters:
+
+```
+NEXT_PUBLIC_ETHERSCAN_API_KEY=YourEtherscanOrBaseScanKey
+NEXT_PUBLIC_ALCHEMY_API_KEY=YourAlchemyKey   # optional (not used for ABI directly)
+NEXT_PUBLIC_TENDERLY_ACCESS_TOKEN=YourTenderlyToken  # optional (not used by default)
+```
+
+Notes:
+- For Base Sepolia (chainId 84532) we prefer BaseScan V2 (chainid=84532) automatically.
+- For Base mainnet (8453) we use BaseScan v1 endpoint by default.
+- For Ethereum mainnet (1) we use Etherscan v1.
+- If Sourcify/Etherscan fail, the adapter falls back to 4byte signatures; unknown selectors appear as their 4‑byte hex.