@zodiac-os/sdk 1.1.1 → 1.3.0

package/README.md

@@ -1,18 +1,179 @@
 # Zodiac OS SDK
 
-Programmatically manage Safe + Zodiac account constellations with [Zodiac OS](https://pilot.gnosisguild.org)
+Programmatically manage [Zodiac](https://www.zodiac.eco) account constellations.
 
 ## Getting started
 
-### Generate a Zodiac OS API key
+### 1. Install
 
-Sign in to https://app.pilot.gnosisguild.org and create an API key at https://app.pilot.gnosisguild.org/admin/api-keys
+```bash
+npm install @zodiac-os/sdk
+```
 
-## API Client options
+### 2. Generate a Zodiac OS API key
 
-| Option      | Default                                    | Description                                                                                                                                                       |
-| ----------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `apiKey`    | `ZODIAC_OS_API_KEY`                        | Api key you created to access your Zodiac OS workspace. Can either be specified directly in code or through the `ZODIAC_OS_API_KEY` environment variable          |
-| `workspace` | `ZODIAC_OS_WORKSPACE`                      | The Zodiac OS workspace you want to access with the client. Can also be specified via the `ZODIAC_OS_WORKSPACE` environment variable.                             |
-| `baseUrl`   | `https://app.pilor.gnosisguild.org/api/v1` | The URL the API client will be pointed at. This can also be specified via the `ZODIAC_OS_API_URL` environment variable. You probably do not need to specify this. |
-| `fetch`     | `global.fetch`                             | The `fetch` client that is used by the API client. You probably do not need to specify this. However, this can be useful for testing.                             |
+Sign in to [app.zodiac.eco](https://app.zodiac.eco) and create an API key at [app.zodiac.eco/admin/api-keys](https://app.zodiac.eco/admin/api-keys).
+
+### 3. Create a config file
+
+Create a `zodiac.config.ts` in your project root:
+
+```ts
+import { defineConfig } from '@zodiac-os/sdk/cli/config'
+
+export default defineConfig({
+  apiKey: 'zodiac_...',
+  // Optional: contracts to fetch for permissions authoring
+  contracts: {
+    mainnet: {
+      dai: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
+    },
+  },
+})
+```
+
+### 4. Pull your org data
+
+```bash
+# Pull everything (org data + contract ABIs)
+zodiac-os pull
+```
+
+This generates typed data in `node_modules/.zodiac-os/` with your org's users and vaults.
+
+## Constellation API
+
+The `constellation()` function is the main SDK entry point. It returns an API for declaring account constellations — the set of Safes, Roles mods, and users that make up your on-chain setup.
+
+```ts
+import { constellation } from '@zodiac-os/sdk'
+```
+
+### Scoping to a workspace and chain
+
+Each constellation is scoped to a single workspace and chain. The `workspace` option must be a valid workspace name from your org.
+
+```ts
+const eth = constellation({
+  workspace: 'GG',
+  label: 'Production',
+  chain: 1,
+})
+```
+
+### Referencing existing vaults
+
+Bracket access gives you existing Safes and Roles mods from the selected workspace. Names auto-complete from the codegen output.
+
+```ts
+// Reference an existing Safe — no invocation needed
+const ggDao = eth.safe['GG DAO']
+
+// Reference the canonical Roles mod for that Safe
+const ggDaoRoles = eth.roles['GG DAO']
+
+// Optionally invoke with overrides
+const ggDaoOverridden = eth.safe['GG DAO']({ threshold: 5 })
+```
+
+### Creating new accounts
+
+Use bracket access with a new label to create new nodes. Required fields are enforced by the type system:
+
+```ts
+// New Safe — threshold, owners are required
+const newSafe = eth.safe['New Safe']({
+  nonce: 0n,
+  threshold: 2,
+  owners: [
+    eth.user['Alice Sample'],
+    '0xb8e48df6818d3cbc648b3e8ec248a4f547135f7a',
+  ],
+  modules: [ggDaoRoles],
+})
+
+// New Roles mod targeting an existing Safe
+const newRoles = eth.roles['New Roles']({
+  nonce: 0n,
+  target: ggDao,
+})
+```
+
+### Canonical Roles mods
+
+Every Safe has a canonical Roles mod hosting policies applied through the app. When you use the Safe label on the `roles` accessor, it resolves to that Safe's canonical Roles mod automatically.
+
+```ts
+// Enable roles on an existing Safe in your org
+const daoRoles = eth.roles['GG DAO']({
+  roles: [
+    /* ... */
+  ],
+})
+```
+
+### Circular references between new nodes
+
+New nodes can reference each other before either has been invoked — use the uninvoked factory as a forward reference:
+
+```ts
+const safe = eth.safe['New Safe']({
+  nonce: 0n,
+  threshold: 1,
+  owners: [eth.user['Alice Sample']],
+  // Forward reference to a Roles mod that doesn't exist yet
+  modules: [eth.roles['New Roles']],
+})
+
+const roles = eth.roles['New Roles']({
+  nonce: 0n,
+  target: safe,
+})
+```
+
+References are resolved by label at `apply()` time, so both sides of the cycle must be included in the call.
+
+### Referencing users
+
+`eth.user[handle]` resolves a user to their personal Safe address on the current chain:
+
+```ts
+const aliceAddress = eth.user['Alice Sample']
+```
+
+### Applying the constellation
+
+The `apply()` function takes all nodes and sends them to the Zodiac OS API. Pass either a named object (keys become refs) or an array:
+
+```ts
+import { apply } from '@zodiac-os/sdk'
+
+await apply({ ggDao, ggDaoRoles, newSafe, newRoles })
+```
+
+All referenced nodes must be included in the `apply()` call.
+
+By default, `apply()` creates an API client from the `ZODIAC_OS_API_KEY` environment variable. You can pass a custom client:
+
+```ts
+await apply({ ggDao, newRoles }, { api: new ApiClient({ apiKey: '...' }) })
+```
+
+## CLI reference
+
+```
+Usage: zodiac-os [options] [command]
+
+Zodiac OS SDK CLI – pull org data and contract ABIs
+
+Options:
+  -V, --version        output the version number
+  -c, --config <path>  path to the config file (default: "zodiac.config.ts")
+  -h, --help           display help for command
+
+Commands:
+  pull-org             Fetch Zodiac users and vaults, generate TypeScript types
+  pull-contracts       Fetch contract ABIs, generate typed permissions kit
+  pull                 Fetch Zodiac org and contracts ABI, generate SDK functions
+  help [command]       display help for command
+```

package/dist/allow/index.d.mts

@@ -0,0 +1,2 @@
+import { a as EVERYTHING, c as Scoping, i as ConditionFunction, l as TargetPermission, n as ChainPrefix, o as FunctionPermission, r as chainIdFor, s as Options, t as CHAIN_IDS, u as buildAllowKit } from "../index-DTBaxN7b.mjs";
+export { CHAIN_IDS, ChainPrefix, ConditionFunction, EVERYTHING, FunctionPermission, Options, Scoping, TargetPermission, buildAllowKit, chainIdFor };

package/dist/allow/index.mjs

@@ -0,0 +1,3 @@
+import { n as chainIdFor, t as CHAIN_IDS } from "../networks-BTW1qAAa.mjs";
+import { n as EVERYTHING, t as buildAllowKit } from "../allow-Dzh6t_l8.mjs";
+export { CHAIN_IDS, EVERYTHING, buildAllowKit, chainIdFor };

package/dist/allow-Dzh6t_l8.mjs

@@ -0,0 +1,122 @@
+import { a as walkContracts, i as readAbi } from "./networks-BTW1qAAa.mjs";
+import { c, coercePermission } from "zodiac-roles-sdk";
+import { Interface, isError } from "ethers";
+import { Operator, ParameterType } from "zodiac-roles-deployments";
+//#region src/allow/types.ts
+const EVERYTHING = Symbol.for("@zodiac-os/allow-kit/EVERYTHING");
+//#endregion
+//#region src/allow/runtime.ts
+function buildAllowKit(abisDir, contractsConfig) {
+	const kit = {};
+	for (const node of walkContracts(contractsConfig)) {
+		const abi = readAbi(abisDir, node);
+		if (!abi) {
+			attachAt(kit, [node.chain, ...node.segments], missingAbiProxy(node));
+			continue;
+		}
+		attachAt(kit, [node.chain, ...node.segments], makeAllowContract(node.address, abi));
+	}
+	return kit;
+}
+function attachAt(root, segments, value) {
+	let cursor = root;
+	for (let i = 0; i < segments.length - 1; i++) {
+		const seg = segments[i];
+		if (!(seg in cursor)) cursor[seg] = {};
+		cursor = cursor[seg];
+	}
+	cursor[segments[segments.length - 1]] = value;
+}
+function missingAbiProxy(node) {
+	const explain = () => {
+		throw new Error(`ABI missing for ${node.chain}.${node.segments.join(".")} (${node.address}). Run \`zodiac-os pull-contracts\` to fetch it, or paste the ABI JSON manually at <abisDir>/${node.chain}/${node.segments.join("/")}.json`);
+	};
+	return new Proxy({}, {
+		get: explain,
+		has: explain
+	});
+}
+function makeAllowContract(address, abi) {
+	const iface = Interface.from(abi);
+	const lowerAddr = address.toLowerCase();
+	const allowEverything = (options) => ({
+		targetAddress: lowerAddr,
+		send: options?.send,
+		delegatecall: options?.delegatecall
+	});
+	const has = (name) => {
+		try {
+			const fn = iface.getFunction(name);
+			if (!fn) return false;
+			return fn.stateMutability !== "view" && fn.stateMutability !== "pure";
+		} catch (error) {
+			if (!isError(error, "INVALID_ARGUMENT")) throw error;
+			return false;
+		}
+	};
+	return new Proxy({}, {
+		get: (_target, prop) => {
+			if (prop === EVERYTHING) return allowEverything;
+			if (typeof prop !== "string") return void 0;
+			if (!has(prop)) return void 0;
+			return makeAllowFunction(iface.getFunction(prop), lowerAddr);
+		},
+		has: (_target, prop) => {
+			if (prop === EVERYTHING) return true;
+			return typeof prop === "string" && has(prop);
+		}
+	});
+}
+function makeAllowFunction(fn, targetAddress) {
+	const inputs = fn.inputs;
+	return (...args) => {
+		const scopings = args.slice(0, inputs.length);
+		const hasScopings = scopings.some((s) => s !== void 0 && s !== null);
+		const options = args[inputs.length] ?? {};
+		const condition = hasScopings ? c.calldataMatches(scopings, inputs)() : void 0;
+		return applyOptions(coercePermission({
+			targetAddress,
+			signature: fn.format("sighash"),
+			condition
+		}), options);
+	};
+}
+const emptyCalldataMatches = {
+	paramType: ParameterType.Calldata,
+	operator: Operator.Matches,
+	children: []
+};
+const applyGlobalAllowance = (condition, allowanceCondition) => {
+	const base = condition ?? emptyCalldataMatches;
+	if (base.paramType !== ParameterType.Calldata || base.operator !== Operator.Matches) throw new Error("Global allowance can only be applied to calldata matches nodes");
+	return {
+		...base,
+		children: [...base.children ?? [], allowanceCondition]
+	};
+};
+const applyOptions = (permission, options) => {
+	let condition = permission.condition;
+	if (options.etherWithinAllowance) {
+		if (!options.send) throw new Error("`etherWithinAllowance` can only be used if `send` is allowed");
+		condition = applyGlobalAllowance(condition, {
+			paramType: ParameterType.None,
+			operator: Operator.EtherWithinAllowance,
+			compValue: options.etherWithinAllowance
+		});
+	}
+	if (options.callWithinAllowance) condition = applyGlobalAllowance(condition, {
+		paramType: ParameterType.None,
+		operator: Operator.CallWithinAllowance,
+		compValue: options.callWithinAllowance
+	});
+	return {
+		...permission,
+		send: options.send,
+		delegatecall: options.delegatecall,
+		condition
+	};
+};
+//#endregion
+export { EVERYTHING as n, buildAllowKit as t };
+
+//# sourceMappingURL=allow-Dzh6t_l8.mjs.map

package/dist/allow-Dzh6t_l8.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"allow-Dzh6t_l8.mjs","names":[],"sources":["../src/allow/types.ts","../src/allow/runtime.ts"],"sourcesContent":["import type { BigNumberish, BytesLike, ParamType } from 'ethers'\nimport type {\n  Condition,\n  FunctionPermission,\n  TargetPermission,\n} from 'zodiac-roles-sdk'\n\nexport type Options = {\n  send?: boolean\n  delegatecall?: boolean\n  etherWithinAllowance?: `0x${string}`\n  callWithinAllowance?: `0x${string}`\n}\n\nexport type PrimitiveValue = BigNumberish | BytesLike | string | boolean\n\n// Signature matches `zodiac-roles-sdk` so values from `c.*` are assignable.\nexport type ConditionFunction<T = unknown> = (\n  abiType: ParamType,\n  _?: T\n) => Condition\n\ntype RequireAtLeastOne<T> = {\n  [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>\n}[keyof T]\n\ntype ArrayElement<T extends readonly unknown[]> = T extends readonly (infer U)[]\n  ? U\n  : never\n\nexport type PrimitiveScoping<T extends PrimitiveValue> =\n  | T\n  | ConditionFunction<T>\n\nexport type ArrayScoping<T extends readonly any[]> =\n  | readonly Scoping<ArrayElement<T>>[]\n  | ConditionFunction<T>\n\nexport type StructScoping<T extends { [key: string]: any }> =\n  | RequireAtLeastOne<{ [K in keyof T]?: Scoping<T[K]> }>\n  | ConditionFunction<T>\n\nexport type Scoping<T> = T extends PrimitiveValue\n  ? PrimitiveScoping<T>\n  : T extends readonly any[]\n    ? ArrayScoping<T>\n    : T extends { [key: string]: any }\n      ? StructScoping<T>\n      : unknown\n\nexport type { FunctionPermission, TargetPermission }\n\nexport const EVERYTHING = Symbol.for('@zodiac-os/allow-kit/EVERYTHING')\nexport type EVERYTHING = typeof EVERYTHING\n","import { Interface, FunctionFragment, isError, type InterfaceAbi } from 'ethers'\nimport { c, coercePermission } from 'zodiac-roles-sdk'\nimport type {\n  Condition,\n  FunctionPermission,\n  TargetPermission,\n} from 'zodiac-roles-sdk'\nimport { ParameterType, Operator } from 'zodiac-roles-deployments'\nimport { readAbi, walkContracts, type ContractNode } from './abi'\nimport { EVERYTHING, type Options } from './types'\n\nexport function buildAllowKit(\n  abisDir: string,\n  contractsConfig: Record<string, any>\n): Record<string, any> {\n  const kit: Record<string, any> = {}\n  for (const node of walkContracts(contractsConfig)) {\n    const abi = readAbi(abisDir, node)\n    if (!abi) {\n      // Defer the error until the user touches this contract — otherwise an\n      // ABI missing for one chain crashes all unrelated role definitions.\n      attachAt(kit, [node.chain, ...node.segments], missingAbiProxy(node))\n      continue\n    }\n    attachAt(\n      kit,\n      [node.chain, ...node.segments],\n      makeAllowContract(node.address, abi as InterfaceAbi)\n    )\n  }\n  return kit\n}\n\nfunction attachAt(root: Record<string, any>, segments: string[], value: any) {\n  let cursor = root\n  for (let i = 0; i < segments.length - 1; i++) {\n    const seg = segments[i]!\n    if (!(seg in cursor)) cursor[seg] = {}\n    cursor = cursor[seg]\n  }\n  cursor[segments[segments.length - 1]!] = value\n}\n\nfunction missingAbiProxy(node: ContractNode) {\n  const explain = () => {\n    throw new Error(\n      `ABI missing for ${node.chain}.${node.segments.join('.')} ` +\n        `(${node.address}). Run \\`zodiac-os pull-contracts\\` to fetch it, or ` +\n        `paste the ABI JSON manually at <abisDir>/${node.chain}/${node.segments.join('/')}.json`\n    )\n  }\n  return new Proxy(\n    {},\n    {\n      get: explain,\n      has: explain,\n    }\n  )\n}\n\nfunction makeAllowContract(\n  address: `0x${string}`,\n  abi: InterfaceAbi\n): Record<string | symbol, any> {\n  const iface = Interface.from(abi)\n  const lowerAddr = address.toLowerCase() as `0x${string}`\n\n  const allowEverything = (options?: Options): TargetPermission => ({\n    targetAddress: lowerAddr,\n    send: options?.send,\n    delegatecall: options?.delegatecall,\n  })\n\n  const has = (name: string) => {\n    try {\n      const fn = iface.getFunction(name)\n      if (!fn) return false\n      return fn.stateMutability !== 'view' && fn.stateMutability !== 'pure'\n    } catch (error) {\n      if (!isError(error as any, 'INVALID_ARGUMENT')) throw error\n      return false\n    }\n  }\n\n  return new Proxy(\n    {},\n    {\n      get: (_target, prop) => {\n        if (prop === EVERYTHING) return allowEverything\n        if (typeof prop !== 'string') return undefined\n        if (!has(prop)) return undefined\n        const fn = iface.getFunction(prop)!\n        return makeAllowFunction(fn, lowerAddr)\n      },\n      has: (_target, prop) => {\n        if (prop === EVERYTHING) return true\n        return typeof prop === 'string' && has(prop)\n      },\n    }\n  )\n}\n\nfunction makeAllowFunction(\n  fn: FunctionFragment,\n  targetAddress: `0x${string}`\n): (...args: any[]) => FunctionPermission {\n  const inputs = fn.inputs\n  return (...args: any[]) => {\n    const scopings = args.slice(0, inputs.length)\n    const hasScopings = scopings.some((s) => s !== undefined && s !== null)\n    const options: Options = args[inputs.length] ?? {}\n    const condition = hasScopings\n      ? c.calldataMatches(scopings, inputs)()\n      : undefined\n    const preset = {\n      targetAddress,\n      signature: fn.format('sighash'),\n      condition,\n    }\n    return applyOptions(coercePermission(preset as any) as any, options)\n  }\n}\n\nconst emptyCalldataMatches: Condition = {\n  paramType: ParameterType.Calldata,\n  operator: Operator.Matches,\n  children: [],\n}\n\nconst applyGlobalAllowance = (\n  condition: Condition | undefined,\n  allowanceCondition: Condition\n): Condition => {\n  const base = condition ?? emptyCalldataMatches\n  if (\n    base.paramType !== ParameterType.Calldata ||\n    base.operator !== Operator.Matches\n  ) {\n    throw new Error(\n      'Global allowance can only be applied to calldata matches nodes'\n    )\n  }\n  return {\n    ...base,\n    children: [...(base.children ?? []), allowanceCondition],\n  }\n}\n\nconst applyOptions = (\n  permission: FunctionPermission & { condition?: Condition },\n  options: Options\n): FunctionPermission => {\n  let condition = permission.condition\n  if (options.etherWithinAllowance) {\n    if (!options.send) {\n      throw new Error(\n        '`etherWithinAllowance` can only be used if `send` is allowed'\n      )\n    }\n    condition = applyGlobalAllowance(condition, {\n      paramType: ParameterType.None,\n      operator: Operator.EtherWithinAllowance,\n      compValue: options.etherWithinAllowance,\n    })\n  }\n  if (options.callWithinAllowance) {\n    condition = applyGlobalAllowance(condition, {\n      paramType: ParameterType.None,\n      operator: Operator.CallWithinAllowance,\n      compValue: options.callWithinAllowance,\n    })\n  }\n  return {\n    ...permission,\n    send: options.send,\n    delegatecall: options.delegatecall,\n    condition,\n  }\n}\n"],"mappings":";;;;;AAoDA,MAAa,aAAa,OAAO,IAAI,kCAAkC;;;ACzCvE,SAAgB,cACd,SACA,iBACqB;CACrB,MAAM,MAA2B,EAAE;AACnC,MAAK,MAAM,QAAQ,cAAc,gBAAgB,EAAE;EACjD,MAAM,MAAM,QAAQ,SAAS,KAAK;AAClC,MAAI,CAAC,KAAK;AAGR,YAAS,KAAK,CAAC,KAAK,OAAO,GAAG,KAAK,SAAS,EAAE,gBAAgB,KAAK,CAAC;AACpE;;AAEF,WACE,KACA,CAAC,KAAK,OAAO,GAAG,KAAK,SAAS,EAC9B,kBAAkB,KAAK,SAAS,IAAoB,CACrD;;AAEH,QAAO;;AAGT,SAAS,SAAS,MAA2B,UAAoB,OAAY;CAC3E,IAAI,SAAS;AACb,MAAK,IAAI,IAAI,GAAG,IAAI,SAAS,SAAS,GAAG,KAAK;EAC5C,MAAM,MAAM,SAAS;AACrB,MAAI,EAAE,OAAO,QAAS,QAAO,OAAO,EAAE;AACtC,WAAS,OAAO;;AAElB,QAAO,SAAS,SAAS,SAAS,MAAO;;AAG3C,SAAS,gBAAgB,MAAoB;CAC3C,MAAM,gBAAgB;AACpB,QAAM,IAAI,MACR,mBAAmB,KAAK,MAAM,GAAG,KAAK,SAAS,KAAK,IAAI,CAAC,IACnD,KAAK,QAAQ,+FAC2B,KAAK,MAAM,GAAG,KAAK,SAAS,KAAK,IAAI,CAAC,OACrF;;AAEH,QAAO,IAAI,MACT,EAAE,EACF;EACE,KAAK;EACL,KAAK;EACN,CACF;;AAGH,SAAS,kBACP,SACA,KAC8B;CAC9B,MAAM,QAAQ,UAAU,KAAK,IAAI;CACjC,MAAM,YAAY,QAAQ,aAAa;CAEvC,MAAM,mBAAmB,aAAyC;EAChE,eAAe;EACf,MAAM,SAAS;EACf,cAAc,SAAS;EACxB;CAED,MAAM,OAAO,SAAiB;AAC5B,MAAI;GACF,MAAM,KAAK,MAAM,YAAY,KAAK;AAClC,OAAI,CAAC,GAAI,QAAO;AAChB,UAAO,GAAG,oBAAoB,UAAU,GAAG,oBAAoB;WACxD,OAAO;AACd,OAAI,CAAC,QAAQ,OAAc,mBAAmB,CAAE,OAAM;AACtD,UAAO;;;AAIX,QAAO,IAAI,MACT,EAAE,EACF;EACE,MAAM,SAAS,SAAS;AACtB,OAAI,SAAS,WAAY,QAAO;AAChC,OAAI,OAAO,SAAS,SAAU,QAAO,KAAA;AACrC,OAAI,CAAC,IAAI,KAAK,CAAE,QAAO,KAAA;AAEvB,UAAO,kBADI,MAAM,YAAY,KAAK,EACL,UAAU;;EAEzC,MAAM,SAAS,SAAS;AACtB,OAAI,SAAS,WAAY,QAAO;AAChC,UAAO,OAAO,SAAS,YAAY,IAAI,KAAK;;EAE/C,CACF;;AAGH,SAAS,kBACP,IACA,eACwC;CACxC,MAAM,SAAS,GAAG;AAClB,SAAQ,GAAG,SAAgB;EACzB,MAAM,WAAW,KAAK,MAAM,GAAG,OAAO,OAAO;EAC7C,MAAM,cAAc,SAAS,MAAM,MAAM,MAAM,KAAA,KAAa,MAAM,KAAK;EACvE,MAAM,UAAmB,KAAK,OAAO,WAAW,EAAE;EAClD,MAAM,YAAY,cACd,EAAE,gBAAgB,UAAU,OAAO,EAAE,GACrC,KAAA;AAMJ,SAAO,aAAa,iBALL;GACb;GACA,WAAW,GAAG,OAAO,UAAU;GAC/B;GACD,CACkD,EAAS,QAAQ;;;AAIxE,MAAM,uBAAkC;CACtC,WAAW,cAAc;CACzB,UAAU,SAAS;CACnB,UAAU,EAAE;CACb;AAED,MAAM,wBACJ,WACA,uBACc;CACd,MAAM,OAAO,aAAa;AAC1B,KACE,KAAK,cAAc,cAAc,YACjC,KAAK,aAAa,SAAS,QAE3B,OAAM,IAAI,MACR,iEACD;AAEH,QAAO;EACL,GAAG;EACH,UAAU,CAAC,GAAI,KAAK,YAAY,EAAE,EAAG,mBAAmB;EACzD;;AAGH,MAAM,gBACJ,YACA,YACuB;CACvB,IAAI,YAAY,WAAW;AAC3B,KAAI,QAAQ,sBAAsB;AAChC,MAAI,CAAC,QAAQ,KACX,OAAM,IAAI,MACR,+DACD;AAEH,cAAY,qBAAqB,WAAW;GAC1C,WAAW,cAAc;GACzB,UAAU,SAAS;GACnB,WAAW,QAAQ;GACpB,CAAC;;AAEJ,KAAI,QAAQ,oBACV,aAAY,qBAAqB,WAAW;EAC1C,WAAW,cAAc;EACzB,UAAU,SAAS;EACnB,WAAW,QAAQ;EACpB,CAAC;AAEJ,QAAO;EACL,GAAG;EACH,MAAM,QAAQ;EACd,cAAc,QAAQ;EACtB;EACD"}

package/dist/api-D6ee2Q2b.mjs

@@ -0,0 +1,113 @@
+import assert from "assert";
+//#region src/api.ts
+const { ZODIAC_OS_API_KEY, ZODIAC_OS_API_URL = "https://app.zodiac.eco/api/v1" } = process.env;
+var ApiClient = class {
+	apiKey;
+	baseUrl;
+	_fetch;
+	headers;
+	constructor({ baseUrl = ZODIAC_OS_API_URL, fetch: customFetch = fetch, headers = {}, apiKey = ZODIAC_OS_API_KEY } = {}) {
+		this.baseUrl = baseUrl.replace(/\/$/, "");
+		this._fetch = customFetch;
+		this.headers = headers;
+		assert(apiKey, "No API key provided to the API client. Either pass it as the \"apiKey\" option or set the ZODIAC_OS_API_KEY environment variable.");
+		this.apiKey = apiKey;
+	}
+	async postJson(endpoint, payload) {
+		const res = await this._fetch(`${this.baseUrl}/${endpoint}`, {
+			method: "POST",
+			headers: {
+				...this.headers,
+				"content-type": "application/json",
+				authorization: `Bearer ${this.apiKey}`
+			},
+			body: jsonStringify(payload)
+		});
+		if (!res.ok) await handleApiError(res);
+		return res.json();
+	}
+	async get(endpoint) {
+		const res = await this._fetch(`${this.baseUrl}/${endpoint}`, { headers: {
+			...this.headers,
+			authorization: `Bearer ${this.apiKey}`
+		} });
+		if (!res.ok) await handleApiError(res);
+		return res.json();
+	}
+	listVaults() {
+		return this.get("vaults");
+	}
+	listUsers() {
+		return this.get("users");
+	}
+	/**
+	* Applies an accounts specification to Zodiac OS.
+	*/
+	applyConstellation(workspaceId, payload) {
+		return this.postJson(`workspace/${workspaceId}/constellation/apply`, payload);
+	}
+	/**
+	* Resolves an accounts specification to Zodiac OS.
+	*/
+	resolveConstellation(workspaceId, payload) {
+		return this.postJson(`workspace/${workspaceId}/constellation/resolve`, payload);
+	}
+};
+var ApiRequestError = class ApiRequestError extends Error {
+	status;
+	statusText;
+	details;
+	constructor(message, opts) {
+		super(ApiRequestError.composeMessage(message, opts.details));
+		this.name = "ApiRequestError";
+		this.status = opts.status;
+		this.statusText = opts.statusText;
+		this.details = opts.details;
+		if (opts.cause !== void 0) this.cause = opts.cause;
+	}
+	static composeMessage(message, details) {
+		if (details == null) return message;
+		let detailsString;
+		try {
+			detailsString = typeof details === "string" ? details : jsonStringify(details, 2);
+		} catch (_err) {
+			detailsString = String(details);
+		}
+		return `${message}\nDetails: ${detailsString}`;
+	}
+	toString() {
+		return `${this.name}: ${this.message}`;
+	}
+};
+async function handleApiError(response) {
+	if (response.headers.get("content-type")?.includes("application/json")) {
+		const errorData = await response.json();
+		let error;
+		try {
+			error = new ApiRequestError(errorData.error.message, {
+				status: response.status,
+				statusText: response.statusText,
+				details: errorData.error.details
+			});
+		} catch (jsonShapeError) {
+			error = new ApiRequestError(`Failed parsing error response: ${jsonShapeError}`, {
+				status: response.status,
+				statusText: response.statusText,
+				details: errorData
+			});
+		}
+		throw error;
+	} else throw new ApiRequestError(await response.text() || "Unexpected error", {
+		status: response.status,
+		statusText: response.statusText
+	});
+}
+/** JSON.stringify with bigint support */
+const jsonStringify = (value, indent) => JSON.stringify(value, (_, value) => {
+	if (typeof value === "bigint") return value.toString();
+	return value;
+}, indent);
+//#endregion
+export { ApiClient as t };
+
+//# sourceMappingURL=api-D6ee2Q2b.mjs.map

package/dist/api-D6ee2Q2b.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-D6ee2Q2b.mjs","names":[],"sources":["../src/api.ts"],"sourcesContent":["import type {\n  ApplyConstellationPayload,\n  ApplyConstellationResult,\n  ResolveConstellationPayload,\n  ResolveConstellationResult,\n  ApiError as ApiErrorResponse,\n  ListVaultsResult,\n  ListUsersResult,\n} from '@zodiac-os/api-types'\nimport assert from 'assert'\nimport { UUID } from 'crypto'\n\nexport type Options = {\n  workspace?: string\n  apiKey?: string\n  baseUrl?: string\n  fetch?: typeof globalThis.fetch\n  headers?: Record<string, string>\n}\n\nconst {\n  ZODIAC_OS_API_KEY,\n  ZODIAC_OS_API_URL = 'https://app.zodiac.eco/api/v1',\n} = process.env\n\nexport class ApiClient {\n  private apiKey: string\n  private baseUrl: string\n  private _fetch: typeof fetch\n  private headers: Record<string, string>\n\n  constructor({\n    baseUrl = ZODIAC_OS_API_URL,\n    fetch: customFetch = fetch,\n    headers = {},\n    apiKey = ZODIAC_OS_API_KEY,\n  }: Options = {}) {\n    this.baseUrl = baseUrl.replace(/\\/$/, '')\n    this._fetch = customFetch\n    this.headers = headers\n\n    assert(\n      apiKey,\n      'No API key provided to the API client. Either pass it as the \"apiKey\" option or set the ZODIAC_OS_API_KEY environment variable.'\n    )\n\n    this.apiKey = apiKey\n  }\n\n  protected async postJson(endpoint: string, payload: unknown) {\n    const res = await this._fetch(`${this.baseUrl}/${endpoint}`, {\n      method: 'POST',\n      headers: {\n        ...this.headers,\n        'content-type': 'application/json',\n        authorization: `Bearer ${this.apiKey}`,\n      },\n      body: jsonStringify(payload),\n    })\n    if (!res.ok) {\n      await handleApiError(res)\n    }\n\n    return res.json()\n  }\n\n  protected async get(endpoint: string) {\n    const res = await this._fetch(`${this.baseUrl}/${endpoint}`, {\n      headers: { ...this.headers, authorization: `Bearer ${this.apiKey}` },\n    })\n\n    if (!res.ok) {\n      await handleApiError(res)\n    }\n\n    return res.json()\n  }\n\n  listVaults(): Promise<ListVaultsResult> {\n    return this.get('vaults')\n  }\n\n  listUsers(): Promise<ListUsersResult> {\n    return this.get('users')\n  }\n\n  /**\n   * Applies an accounts specification to Zodiac OS.\n   */\n  applyConstellation(\n    workspaceId: UUID,\n    payload: ApplyConstellationPayload\n  ): Promise<ApplyConstellationResult> {\n    return this.postJson(\n      `workspace/${workspaceId}/constellation/apply`,\n      payload\n    )\n  }\n\n  /**\n   * Resolves an accounts specification to Zodiac OS.\n   */\n  resolveConstellation(\n    workspaceId: UUID,\n    payload: ResolveConstellationPayload\n  ): Promise<ResolveConstellationResult> {\n    return this.postJson(\n      `workspace/${workspaceId}/constellation/resolve`,\n      payload\n    )\n  }\n}\n\nexport class ApiRequestError extends Error {\n  public readonly status: number\n  public readonly statusText: string\n  public readonly details?: unknown\n\n  constructor(\n    message: string,\n    opts: {\n      status: number\n      statusText: string\n      details?: unknown\n      cause?: unknown\n    }\n  ) {\n    super(ApiRequestError.composeMessage(message, opts.details))\n    this.name = 'ApiRequestError'\n    this.status = opts.status\n    this.statusText = opts.statusText\n    this.details = opts.details\n    if (opts.cause !== undefined) {\n      ;(this as any).cause = opts.cause\n    }\n  }\n\n  private static composeMessage(message: string, details?: unknown) {\n    if (details == null) return message\n    let detailsString: string\n    try {\n      detailsString =\n        typeof details === 'string' ? details : jsonStringify(details, 2)\n    } catch (_err) {\n      detailsString = String(details)\n    }\n    return `${message}\\nDetails: ${detailsString}`\n  }\n\n  toString() {\n    return `${this.name}: ${this.message}`\n  }\n}\n\nasync function handleApiError(response: Response): Promise<never> {\n  const contentType = response.headers.get('content-type')\n  if (contentType?.includes('application/json')) {\n    const errorData = (await response.json()) as ApiErrorResponse\n    let error: ApiRequestError\n    try {\n      error = new ApiRequestError(errorData.error.message, {\n        status: response.status,\n        statusText: response.statusText,\n        details: errorData.error.details,\n      })\n    } catch (jsonShapeError) {\n      error = new ApiRequestError(\n        `Failed parsing error response: ${jsonShapeError}`,\n        {\n          status: response.status,\n          statusText: response.statusText,\n          details: errorData,\n        }\n      )\n    }\n    throw error\n  } else {\n    // Not JSON, read as text directly\n    const text = await response.text()\n    throw new ApiRequestError(text || 'Unexpected error', {\n      status: response.status,\n      statusText: response.statusText,\n    })\n  }\n}\n\n/** JSON.stringify with bigint support */\nconst jsonStringify = (value: unknown, indent?: number) =>\n  JSON.stringify(\n    value,\n    (_, value) => {\n      if (typeof value === 'bigint') {\n        return value.toString()\n      }\n\n      return value\n    },\n    indent\n  )\n"],"mappings":";;AAoBA,MAAM,EACJ,mBACA,oBAAoB,oCAClB,QAAQ;AAEZ,IAAa,YAAb,MAAuB;CACrB;CACA;CACA;CACA;CAEA,YAAY,EACV,UAAU,mBACV,OAAO,cAAc,OACrB,UAAU,EAAE,EACZ,SAAS,sBACE,EAAE,EAAE;AACf,OAAK,UAAU,QAAQ,QAAQ,OAAO,GAAG;AACzC,OAAK,SAAS;AACd,OAAK,UAAU;AAEf,SACE,QACA,oIACD;AAED,OAAK,SAAS;;CAGhB,MAAgB,SAAS,UAAkB,SAAkB;EAC3D,MAAM,MAAM,MAAM,KAAK,OAAO,GAAG,KAAK,QAAQ,GAAG,YAAY;GAC3D,QAAQ;GACR,SAAS;IACP,GAAG,KAAK;IACR,gBAAgB;IAChB,eAAe,UAAU,KAAK;IAC/B;GACD,MAAM,cAAc,QAAQ;GAC7B,CAAC;AACF,MAAI,CAAC,IAAI,GACP,OAAM,eAAe,IAAI;AAG3B,SAAO,IAAI,MAAM;;CAGnB,MAAgB,IAAI,UAAkB;EACpC,MAAM,MAAM,MAAM,KAAK,OAAO,GAAG,KAAK,QAAQ,GAAG,YAAY,EAC3D,SAAS;GAAE,GAAG,KAAK;GAAS,eAAe,UAAU,KAAK;GAAU,EACrE,CAAC;AAEF,MAAI,CAAC,IAAI,GACP,OAAM,eAAe,IAAI;AAG3B,SAAO,IAAI,MAAM;;CAGnB,aAAwC;AACtC,SAAO,KAAK,IAAI,SAAS;;CAG3B,YAAsC;AACpC,SAAO,KAAK,IAAI,QAAQ;;;;;CAM1B,mBACE,aACA,SACmC;AACnC,SAAO,KAAK,SACV,aAAa,YAAY,uBACzB,QACD;;;;;CAMH,qBACE,aACA,SACqC;AACrC,SAAO,KAAK,SACV,aAAa,YAAY,yBACzB,QACD;;;AAIL,IAAa,kBAAb,MAAa,wBAAwB,MAAM;CACzC;CACA;CACA;CAEA,YACE,SACA,MAMA;AACA,QAAM,gBAAgB,eAAe,SAAS,KAAK,QAAQ,CAAC;AAC5D,OAAK,OAAO;AACZ,OAAK,SAAS,KAAK;AACnB,OAAK,aAAa,KAAK;AACvB,OAAK,UAAU,KAAK;AACpB,MAAI,KAAK,UAAU,KAAA,EACf,MAAa,QAAQ,KAAK;;CAIhC,OAAe,eAAe,SAAiB,SAAmB;AAChE,MAAI,WAAW,KAAM,QAAO;EAC5B,IAAI;AACJ,MAAI;AACF,mBACE,OAAO,YAAY,WAAW,UAAU,cAAc,SAAS,EAAE;WAC5D,MAAM;AACb,mBAAgB,OAAO,QAAQ;;AAEjC,SAAO,GAAG,QAAQ,aAAa;;CAGjC,WAAW;AACT,SAAO,GAAG,KAAK,KAAK,IAAI,KAAK;;;AAIjC,eAAe,eAAe,UAAoC;AAEhE,KADoB,SAAS,QAAQ,IAAI,eAAe,EACvC,SAAS,mBAAmB,EAAE;EAC7C,MAAM,YAAa,MAAM,SAAS,MAAM;EACxC,IAAI;AACJ,MAAI;AACF,WAAQ,IAAI,gBAAgB,UAAU,MAAM,SAAS;IACnD,QAAQ,SAAS;IACjB,YAAY,SAAS;IACrB,SAAS,UAAU,MAAM;IAC1B,CAAC;WACK,gBAAgB;AACvB,WAAQ,IAAI,gBACV,kCAAkC,kBAClC;IACE,QAAQ,SAAS;IACjB,YAAY,SAAS;IACrB,SAAS;IACV,CACF;;AAEH,QAAM;OAIN,OAAM,IAAI,gBADG,MAAM,SAAS,MAAM,IACA,oBAAoB;EACpD,QAAQ,SAAS;EACjB,YAAY,SAAS;EACtB,CAAC;;;AAKN,MAAM,iBAAiB,OAAgB,WACrC,KAAK,UACH,QACC,GAAG,UAAU;AACZ,KAAI,OAAO,UAAU,SACnB,QAAO,MAAM,UAAU;AAGzB,QAAO;GAET,OACD"}

package/dist/cli/config.d.mts

@@ -0,0 +1,35 @@
+//#region src/cli/config.d.ts
+type Contracts = {
+  [chain: string]: ContractsNode;
+};
+type ContractsNode = `0x${string}` | {
+  [name: string]: ContractsNode;
+};
+interface ZodiacConfig {
+  apiKey: `zodiac_${string}`;
+  /**
+   * Contracts the `allow` kit should know about, keyed by chain prefix.
+   * Nested objects are allowed for grouping related addresses.
+   */
+  contracts?: Contracts;
+  /**
+   * Directory where fetched ABIs are stored and read from.
+   * Resolved relative to the project root (cwd). Defaults to `./abis`.
+   */
+  abisDir?: string;
+  /**
+   * Directory where generated type declarations (e.g. `allow.d.ts`) are
+   * written. Resolved relative to the project root (cwd).
+   * Defaults to `./.zodiac-os`.
+   */
+  typesDir?: string;
+}
+declare const defineConfig: (config: ZodiacConfig) => ZodiacConfig;
+declare function loadConfig(configPath?: string): Promise<ZodiacConfig>;
+declare const DEFAULT_ABIS_DIR = "abis";
+declare const DEFAULT_TYPES_DIR = ".zodiac-os";
+declare function resolveAbisDir(config: ZodiacConfig): string;
+declare function resolveTypesDir(config: ZodiacConfig): string;
+//#endregion
+export { Contracts, ContractsNode, DEFAULT_ABIS_DIR, DEFAULT_TYPES_DIR, ZodiacConfig, defineConfig, loadConfig, resolveAbisDir, resolveTypesDir };
+//# sourceMappingURL=config.d.mts.map

package/dist/cli/config.mjs

@@ -0,0 +1,31 @@
+import { pathToFileURL } from "url";
+import { resolve } from "path";
+//#region src/cli/config.ts
+const defineConfig = (config) => config;
+const DEFAULT_CONFIG_PATH = "zodiac.config.ts";
+async function loadConfig(configPath = DEFAULT_CONFIG_PATH) {
+	const absolutePath = resolve(process.cwd(), configPath);
+	let mod;
+	try {
+		mod = await import(pathToFileURL(absolutePath).href);
+	} catch (error) {
+		if (error?.code === "ERR_MODULE_NOT_FOUND" || error?.code === "ENOENT") throw new Error(`Config file not found: ${absolutePath}`);
+		throw error;
+	}
+	const config = mod.default ?? mod.config;
+	if (!config) throw new Error(`Config file must export a default value or a named "config" export: ${absolutePath}`);
+	if (!config.apiKey) throw new Error(`Config is missing required field "apiKey"`);
+	return config;
+}
+const DEFAULT_ABIS_DIR = "abis";
+const DEFAULT_TYPES_DIR = ".zodiac-os";
+function resolveAbisDir(config) {
+	return resolve(process.cwd(), config.abisDir ?? "abis");
+}
+function resolveTypesDir(config) {
+	return resolve(process.cwd(), config.typesDir ?? ".zodiac-os");
+}
+//#endregion
+export { DEFAULT_ABIS_DIR, DEFAULT_TYPES_DIR, defineConfig, loadConfig, resolveAbisDir, resolveTypesDir };
+
+//# sourceMappingURL=config.mjs.map

package/dist/cli/config.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.mjs","names":[],"sources":["../../src/cli/config.ts"],"sourcesContent":["import { pathToFileURL } from 'url'\nimport { resolve } from 'path'\n\nexport type Contracts = {\n  [chain: string]: ContractsNode\n}\nexport type ContractsNode = `0x${string}` | { [name: string]: ContractsNode }\n\nexport interface ZodiacConfig {\n  apiKey: `zodiac_${string}`\n  /**\n   * Contracts the `allow` kit should know about, keyed by chain prefix.\n   * Nested objects are allowed for grouping related addresses.\n   */\n  contracts?: Contracts\n  /**\n   * Directory where fetched ABIs are stored and read from.\n   * Resolved relative to the project root (cwd). Defaults to `./abis`.\n   */\n  abisDir?: string\n  /**\n   * Directory where generated type declarations (e.g. `allow.d.ts`) are\n   * written. Resolved relative to the project root (cwd).\n   * Defaults to `./.zodiac-os`.\n   */\n  typesDir?: string\n}\n\nexport const defineConfig = (config: ZodiacConfig): ZodiacConfig => config\n\nconst DEFAULT_CONFIG_PATH = 'zodiac.config.ts'\n\nexport async function loadConfig(\n  configPath: string = DEFAULT_CONFIG_PATH\n): Promise<ZodiacConfig> {\n  const absolutePath = resolve(process.cwd(), configPath)\n\n  let mod: Record<string, unknown>\n  try {\n    mod = await import(pathToFileURL(absolutePath).href)\n  } catch (error: any) {\n    if (error?.code === 'ERR_MODULE_NOT_FOUND' || error?.code === 'ENOENT') {\n      throw new Error(`Config file not found: ${absolutePath}`)\n    }\n    throw error\n  }\n\n  const config = (mod.default ?? mod.config) as ZodiacConfig | undefined\n  if (!config) {\n    throw new Error(\n      `Config file must export a default value or a named \"config\" export: ${absolutePath}`\n    )\n  }\n\n  if (!config.apiKey) {\n    throw new Error(`Config is missing required field \"apiKey\"`)\n  }\n\n  return config\n}\n\nexport const DEFAULT_ABIS_DIR = 'abis'\nexport const DEFAULT_TYPES_DIR = '.zodiac-os'\n\nexport function resolveAbisDir(config: ZodiacConfig): string {\n  return resolve(process.cwd(), config.abisDir ?? DEFAULT_ABIS_DIR)\n}\n\nexport function resolveTypesDir(config: ZodiacConfig): string {\n  return resolve(process.cwd(), config.typesDir ?? DEFAULT_TYPES_DIR)\n}\n"],"mappings":";;;AA4BA,MAAa,gBAAgB,WAAuC;AAEpE,MAAM,sBAAsB;AAE5B,eAAsB,WACpB,aAAqB,qBACE;CACvB,MAAM,eAAe,QAAQ,QAAQ,KAAK,EAAE,WAAW;CAEvD,IAAI;AACJ,KAAI;AACF,QAAM,MAAM,OAAO,cAAc,aAAa,CAAC;UACxC,OAAY;AACnB,MAAI,OAAO,SAAS,0BAA0B,OAAO,SAAS,SAC5D,OAAM,IAAI,MAAM,0BAA0B,eAAe;AAE3D,QAAM;;CAGR,MAAM,SAAU,IAAI,WAAW,IAAI;AACnC,KAAI,CAAC,OACH,OAAM,IAAI,MACR,uEAAuE,eACxE;AAGH,KAAI,CAAC,OAAO,OACV,OAAM,IAAI,MAAM,4CAA4C;AAG9D,QAAO;;AAGT,MAAa,mBAAmB;AAChC,MAAa,oBAAoB;AAEjC,SAAgB,eAAe,QAA8B;AAC3D,QAAO,QAAQ,QAAQ,KAAK,EAAE,OAAO,WAAA,OAA4B;;AAGnE,SAAgB,gBAAgB,QAA8B;AAC5D,QAAO,QAAQ,QAAQ,KAAK,EAAE,OAAO,YAAA,aAA8B"}

package/dist/cli.d.mts

@@ -0,0 +1 @@
+export { };