@overcast-xyz/evm-contracts 0.0.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/README.md

@@ -0,0 +1,162 @@
+# @overcast-xyz/evm-contracts
+
+TypeScript ABIs and types for the Overcast protocol contracts.
+
+The package has **no runtime dependencies**. The ABIs are `as const` arrays that
+viem and abitype infer from directly, and the struct types are fully expanded, so
+nothing is imported into a consumer's dependency tree.
+
+## Usage
+
+```ts
+import { createPublicClient, http } from "viem";
+import { coreAbi, OptionSide, type Offer } from "@overcast-xyz/evm-contracts";
+
+const client = createPublicClient({ transport: http() });
+
+// Return type is inferred from the ABI — no generics, no casts.
+const option = await client.readContract({
+  address: "0x…",
+  abi: coreAbi,
+  functionName: "getOption",
+  args: ["0x…"],
+});
+
+const offer: Offer = {
+  salt: "0x…",
+  creator: "0x…",
+  optionDetails: { /* … */ },
+  expiry: 0n,
+  side: OptionSide.Maker,
+  counterparty: "0x…",
+};
+```
+
+`coreAbi` is the composed `Core` contract, so it carries the full surface of
+every module under `src/core/` — functions, events, and all protocol errors, which
+means `decodeErrorResult` against it resolves any revert the protocol can produce.
+The extension points are exported too: `iSettlementLayerAbi`,
+`iOptionCreationHookAbi`, `physicalSettlementAbi`,
+`physicalSettlementFactoryAbi`, `chainlinkSettlementAbi`.
+
+Each struct also ships its ABI fragment — `offerParameter`,
+`optionDetailsParameter`, … — for use with `encodeAbiParameters`, which is handy
+when reproducing the content-addressed offer and option ids that
+`libraries/Serialization.sol` computes on-chain.
+
+## Addresses
+
+Deployed addresses come from the `deployments.toml` that `script/Deploy.s.sol`
+writes, fed to the wagmi foundry plugin's `deployments` option. Each chain with a
+committed table contributes an entry:
+
+```ts
+import { coreConfig, physicalSettlementFactoryAddress } from "@overcast-xyz/evm-contracts";
+
+// coreConfig = { address: { 11155111: "0x…" }, abi: coreAbi }
+const domain = await client.readContract({ ...coreConfig, functionName: "domain" });
+```
+
+`coreAddress` is the **proxy** — the address to call the protocol at. The
+implementation behind it is not exported, because calling it directly does
+nothing useful.
+
+Chains appear as they are deployed and their table is committed, so on a
+checkout with no deployments these exports simply do not exist yet.
+
+`ChainlinkSettlementFactory` is exported the same way, for the chains whose
+deployment table names one — a chain that has not been redeployed since it was
+added simply does not appear.
+
+Two things are deliberately not here:
+
+- **Settlement layers themselves.** A chain holds one `PhysicalSettlement` per
+  `ExerciseMode` and one `ChainlinkSettlement` per configuration, while the
+  plugin's model is a single address per contract. Derive them from their
+  factory's `predictAddress(...)` — the factories exist to be that source of
+  truth.
+
+  Note that this is a call rather than a local derivation, and deliberately so:
+  the `CREATE2` salt is pure ABI encoding and can be computed off-chain, but the
+  init-code hash covers the layer's creation code, which this package does not
+  export. Doing so would only look cheaper — a copy compiled from a different
+  commit than the deployed factory derives a confidently wrong address, so the
+  only bytes that answer the question correctly are the ones the deployed
+  factory holds.
+- **Local development.** An `anvil` deployment's addresses belong to a chain that
+  gets recreated on demand, so they cannot be published. Read the `[31337]` table
+  of `deployments.toml` directly, or pass the address in from config.
+
+## Regenerating
+
+Everything under `src/generated/` is derived from the Foundry artifacts and is
+committed, so consumers and downstream CI never need Foundry installed.
+
+```sh
+pnpm generate    # forge build → wagmi generate (ABIs) → generate-types.ts (structs, enums)
+pnpm typecheck
+pnpm build
+```
+
+`pnpm generate` must be re-run and its output committed whenever a change to the
+Solidity alters an external signature, struct, or enum. CI regenerates and fails
+on any difference, so a stale commit does not get far.
+
+## Building
+
+`pnpm build` emits the package twice — ESM to `dist/esm`, CommonJS to
+`dist/cjs` — and the `exports` map routes `import` and `require` to the matching
+half. Dual-publishing costs nothing here (the package is `as const` data and
+types, with no runtime imports) and it is what lets the two kinds of consumer
+coexist:
+
+- **ESM / bundlers** take `dist/esm`, so `sideEffects: false` can drop the ABI
+  arrays a build never references. These are large, so that matters.
+- **CommonJS** — every `@overcast-xyz/*` SDK package is `module: commonjs` —
+  takes `dist/cjs` through the `require` condition, and through the top-level
+  `main` / `types` for the older `node10` resolution those packages still use.
+  Without that half they cannot see this package at all.
+
+Two details are load-bearing. `scripts/emit-cjs-marker.mjs` writes a nested
+`dist/cjs/package.json` marking that directory `"type": "commonjs"`, since the
+root manifest is `"type": "module"` and would otherwise have Node read the
+CommonJS emit as ESM; tsc only picks the `.cjs` extension for `.cts` inputs, so
+the marker is the way to say it. And `tsconfig.build.cjs.json` pairs `module:
+CommonJS` with `moduleResolution: bundler` — TypeScript 7 removed `node10`, and
+`bundler` is the only mode left that pairs with a CommonJS emit. Nothing under
+`src/` imports a package, only its own `./generated/*.js` siblings, so the
+resolution mode has nothing to decide.
+
+## Layout
+
+| Path                      | Generated by                | Contents                                        |
+| ------------------------- | --------------------------- | ----------------------------------------------- |
+| `src/generated/abis.ts`   | `@wagmi/cli` foundry plugin | one `as const` ABI per exported contract, plus `*Address` / `*Config` for deployed chains |
+| `src/generated/structs.ts`| `scripts/generate-types.ts` | ABI tuple parameters + expanded struct types     |
+| `src/generated/enums.ts`  | `scripts/generate-types.ts` | const objects for each file-level Solidity enum  |
+| `test/generated.assert.ts`| `scripts/generate-types.ts` | compile-time check of the struct types           |
+
+`scripts/contracts.ts` is the single list of exported contracts, read by both
+generators. `scripts/deployments.ts` is the single reader of `deployments.toml`,
+used by `wagmi.config.ts` to supply addresses.
+
+The wagmi CLI is used for ABIs only — the `react` and `actions` plugins are
+deliberately not enabled, since the hooks they emit import from `wagmi/codegen`
+and would make wagmi a runtime dependency of this package.
+
+The plugin's `includeBroadcasts` option, which would lift addresses out of
+`broadcast/` and remove `scripts/deployments.ts`, is off for two reasons that were
+checked against this project's own broadcast logs. It attributes the *implementation*
+to `Core`, since `Core` reaches the chain twice and the address consumers need
+belongs to a transaction named `ERC1967Proxy`; and `run-latest.json` holds the
+latest run rather than accumulated state, so a re-run that only reconciles
+configuration overwrites it and every address disappears. A deployment record has
+neither problem — it names the proxy, and it describes a chain's current state
+rather than the last thing that happened to it.
+
+The struct types are expanded rather than derived from abitype so that the
+published `.d.ts` has no imports. That puts the Solidity-to-TypeScript width
+mapping (`uint48` and below are `number`, wider is `bigint`) in
+`scripts/generate-types.ts`, so `test/generated.assert.ts` checks it against what
+abitype — and therefore viem — infers from the same ABI fragment. abitype is a
+devDependency used only by that check.