@skate-org/amm-evm-v2 0.4.1

package/dist/periphery/submit.d.ts

@@ -0,0 +1,63 @@
+import type { Address, Hex, WalletClient } from "viem";
+import type { CHAIN, EnvModeWithConfig } from "@skate-org/amm-core-v2";
+/**
+ * Pre-built source-chain transaction payload accepted by
+ * {@link submitAction}.
+ *
+ * The SDK does **not** fabricate calldata in Group 6 — callers build the
+ * payload (e.g. from a quote's `serializedCall`) and this submitter only
+ * broadcasts it. This keeps the SDK decoupled from any off-chain
+ * routing/quote surface.
+ */
+export type SubmitActionParams = {
+    /** Source-chain id the wallet must be connected to. */
+    chain: CHAIN;
+    /** Destination address of the broadcast tx. */
+    to: Address;
+    /** Pre-encoded calldata. */
+    data: Hex;
+    /** Native-value payable amount; defaults to `0n`. */
+    value?: bigint;
+};
+/**
+ * Broadcast a pre-built periphery action tx from the caller's
+ * `WalletClient`.
+ *
+ * Guarantees:
+ * - Throws {@link EvmWriteError} immediately if
+ *   `wallet.chain?.id !== params.chain` — no RPC call is made.
+ * - Throws {@link EvmWriteError} if `wallet.account` is not set.
+ * - Forwards the payload to `wallet.sendTransaction` and returns the
+ *   resulting tx hash.
+ * - Wraps any thrown viem write-path error
+ *   (`TransactionExecutionError`, `UserRejectedRequestError`,
+ *   `ChainMismatchError`, …) into an {@link EvmWriteError} via
+ *   {@link wrapWriteError}.
+ *
+ * The `mode` parameter is currently unused at runtime; it is accepted for
+ * API symmetry with the readers and as a forward-compat hook for a future
+ * mode-specific submission policy (e.g. DEV-only simulation, staging
+ * retries). The `_` prefix marks it unused for the TypeScript checker.
+ *
+ * Non-goals (per plan guardrails):
+ * - Does NOT sign — the caller brings a `WalletClient` wired to their
+ *   signer.
+ * - Does NOT switch chains — callers are responsible for
+ *   `wallet.switchChain(...)`.
+ * - Does NOT retry or manage nonces — delegated to the caller's wallet.
+ */
+export declare function submitAction(wallet: WalletClient, params: SubmitActionParams, _mode: EnvModeWithConfig): Promise<Hex>;
+/**
+ * Broadcast a periphery *swap* action — thin wrapper around
+ * {@link submitAction} that re-labels any unknown error as `submitSwap` to
+ * aid log-line triage. Behaviourally identical to `submitAction`; shares
+ * its pre-flight guards.
+ */
+export declare function submitSwap(wallet: WalletClient, params: SubmitActionParams, mode: EnvModeWithConfig): Promise<Hex>;
+/**
+ * Broadcast a periphery *approval* action (ERC-20 approve to the source
+ * chain's periphery contract) — thin wrapper around {@link submitAction}.
+ * See {@link submitSwap} for labeling rationale.
+ */
+export declare function submitApproval(wallet: WalletClient, params: SubmitActionParams, mode: EnvModeWithConfig): Promise<Hex>;
+//# sourceMappingURL=submit.d.ts.map

package/dist/periphery/submit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"submit.d.ts","sourceRoot":"","sources":["../../src/periphery/submit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAGvE;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,uDAAuD;IACvD,KAAK,EAAE,KAAK,CAAC;IACb,+CAA+C;IAC/C,EAAE,EAAE,OAAO,CAAC;IACZ,4BAA4B;IAC5B,IAAI,EAAE,GAAG,CAAC;IACV,qDAAqD;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,kBAAkB,EAC1B,KAAK,EAAE,iBAAiB,GACvB,OAAO,CAAC,GAAG,CAAC,CA6Bd;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,kBAAkB,EAC1B,IAAI,EAAE,iBAAiB,GACtB,OAAO,CAAC,GAAG,CAAC,CAOd;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,kBAAkB,EAC1B,IAAI,EAAE,iBAAiB,GACtB,OAAO,CAAC,GAAG,CAAC,CAOd"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@skate-org/amm-evm-v2",
+  "version": "0.4.1",
+  "description": "Skate AMM v2 SDK — EVM clients, kernel/periphery readers, uniswap-v3 math, submitters",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "dependencies": {
+    "@skate-org/amm-bindings": "^1.0.0",
+    "viem": "^2.21.0",
+    "@skate-org/amm-core-v2": "0.4.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup && tsc -p tsconfig.build.json --emitDeclarationOnly && node -e \"require('fs').copyFileSync('dist/index.d.ts','dist/index.d.cts')\"",
+    "clean": "rm -rf dist",
+    "test": "vitest run --passWithNoTests",
+    "typecheck": "tsc --noEmit"
+  }
+}