@bananapus/nana-sdk-core 3.5.2 → 5.0.0

package/dist/esm/review/relayrSend.d.ts

@@ -0,0 +1,106 @@
+import { type Address, type Hex, type PublicClient } from "viem";
+import { type ReviewContextRow } from "./model.js";
+import { type ReviewedPlan } from "./plan.js";
+import { type RelayrBundle, type RelayrEntry, type RelayrQuote } from "./relayr.js";
+import type { SafeRelayrOptions } from "./safeRelayr.js";
+import type { ReviewedSendDeps } from "./send.js";
+import { type WalletAdapter } from "./wallet.js";
+/**
+ * One destination call Relayr runs through the chain's forwarder, with the
+ * gas its request signs. `raw`: Relayr runs it from its own account, unsigned
+ * (a permissionless call), `gas` bounding only the fee. A raw call carries
+ * no ETH: Relayr's executor is unknown before it quotes, so one with `value`
+ * is refused.
+ */
+export type RelayrReviewedCall = {
+    chainId: number;
+    target: Address;
+    data: Hex;
+    value?: bigint;
+    gas: bigint;
+    raw?: boolean;
+};
+/**
+ * The margin over an estimated Relayr fee that the review shows as its cap,
+ * in basis points (11,000 = the estimate plus 10%). Identical requests quoted
+ * minutes apart on every Relayr chain differed by at most 1.4%, so a signed
+ * quote above the cap, which asks again, should be rare.
+ */
+export declare const RELAYR_FEE_MARGIN_BPS = 11000n;
+/**
+ * Relayr's fee over a request's gas limit at the chain's gas price, in basis
+ * points, for bounding a fee when no stand-in quote can be had: the highest
+ * ratio measured on a Relayr chain (7.95, Ethereum at 100,000 gas), rounded
+ * up. Most of a fee is fixed per chain, so the ratio falls as gas rises.
+ */
+export declare const RELAYR_FEE_MARKUP_BPS = 80000n;
+/**
+ * The fee cap the review shows: Relayr's quote for stand-ins of `calls`, plus
+ * {@link RELAYR_FEE_MARGIN_BPS}. A call that runs only for the real sender
+ * (an owner's action) can't be stood in, so a call with the same chain, gas
+ * and calldata length that anyone can run (JBProjects' `balanceOf`) is quoted
+ * instead, with the calls' values added. Without either quote in time, the
+ * fee is bounded locally: each call's gas estimate through the forwarder as
+ * `account`, at the chain's gas price, times {@link RELAYR_FEE_MARKUP_BPS}.
+ */
+export declare function relayrFeeCap(calls: readonly RelayrReviewedCall[], account: Address, paymentChainId: number, clientFor: (chainId: number) => PublicClient): Promise<bigint>;
+/**
+ * Signs `calls` as ERC-2771 forward requests after one review of the
+ * requests, decoded, and returns the Relayr bundle entries that run them.
+ * Each destination must trust the chain's canonical forwarder. Nothing is
+ * posted or paid.
+ */
+export declare function signReviewedForwardRequests(calls: readonly RelayrReviewedCall[], action: {
+    account: Address;
+    context?: readonly ReviewContextRow[];
+    title?: string;
+}, deps: {
+    adapter: WalletAdapter;
+    clientFor: (chainId: number) => PublicClient;
+}): Promise<RelayrEntry[]>;
+/**
+ * Pays a Relayr quote after one review of the payment: the option on
+ * `chainId`, authenticated against the quote, sent to Relayr's pinned
+ * contract and proven from the chain. For a payment resumed apart from its
+ * signatures. A Safe app pays by proposal: `safeTxHash` comes back, held
+ * until the Safe runs it. `onSending` runs after the hold reserves, right
+ * before the wallet opens (a throw sends nothing); `onSent` gets every hash
+ * the payment is known by. With `plan` and `relayrRound`, a quote of exactly
+ * that round's calls spends the round's reviewed fee bound once: at most
+ * the bound pays with no prompt, and a higher fee, a spent round or another
+ * chain is asked.
+ */
+export declare function payRelayrReviewed(quote: RelayrQuote, chainId: number, action: {
+    account: Address;
+    context?: readonly ReviewContextRow[];
+    onSending?: () => Promise<void>;
+    onSent?: (hash: Hex) => Promise<void>;
+    /** A plan already reviewed with exactly this payment (`reviewPlan`): nothing is asked. */
+    plan?: ReviewedPlan;
+    /** The plan's Relayr round this quote runs: the payment spends its fee bound instead. */
+    relayrRound?: string;
+}, deps: ReviewedSendDeps): Promise<{
+    hash: Hex;
+} | {
+    safeTxHash: Hex;
+}>;
+/**
+ * Relayr's bundle once every one of its `expectedCount` transactions reports
+ * success. Only `failed`, in any case, is final; every other state, and a
+ * read that fails, is polled again every 2.5 seconds, for up to 5 minutes.
+ * Relayr's word is not proof: verify the destinations from the chain.
+ */
+export declare function pollRelayrBundle(uuid: string, expectedCount: number, options?: {
+    signal?: AbortSignal;
+    fetch?: typeof fetch;
+}): Promise<RelayrBundle>;
+/**
+ * The wallet side of {@link createSafeRelayrController}: `review` shows the
+ * frozen Safe executions in core's review, and `sendPayment` reviews and
+ * sends the selected payment as {@link payRelayrReviewed} does, with the
+ * controller's checks and journal callbacks around the wallet. A quote paid
+ * before is paid again only when {@link requireRelayrRetry} clears every
+ * earlier payment.
+ */
+export declare function safeRelayrWalletDeps(deps: ReviewedSendDeps): Pick<SafeRelayrOptions, "review" | "sendPayment">;
+//# sourceMappingURL=relayrSend.d.ts.map

package/dist/esm/review/relayrSend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relayrSend.d.ts","sourceRoot":"","sources":["../../../src/review/relayrSend.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,OAAO,EACZ,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,MAAM,CAAC;AAkBd,OAAO,EAAoB,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EAGL,KAAK,YAAY,EAElB,MAAM,WAAW,CAAC;AAEnB,OAAO,EA+BL,KAAK,YAAY,EACjB,KAAK,WAAW,EAEhB,KAAK,WAAW,EAGjB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AASlD,OAAO,EAGL,KAAK,aAAa,EACnB,MAAM,aAAa,CAAC;AAUrB;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,SAAU,CAAC;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,SAAU,CAAC;AA6T7C;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAChC,KAAK,EAAE,SAAS,kBAAkB,EAAE,EACpC,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,MAAM,EACtB,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,YAAY,GAC3C,OAAO,CAAC,MAAM,CAAC,CA2DjB;AAwUD;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAC/C,KAAK,EAAE,SAAS,kBAAkB,EAAE,EACpC,MAAM,EAAE;IACN,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,EACD,IAAI,EAAE;IACJ,OAAO,EAAE,aAAa,CAAC;IACvB,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,YAAY,CAAC;CAC9C,GACA,OAAO,CAAC,WAAW,EAAE,CAAC,CAsBxB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,iBAAiB,CACrC,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE;IACN,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,0FAA0F;IAC1F,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,yFAAyF;IACzF,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,EACD,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC;IAAE,IAAI,EAAE,GAAG,CAAA;CAAE,GAAG;IAAE,UAAU,EAAE,GAAG,CAAA;CAAE,CAAC,CAoD9C;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,WAAW,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CAAO,GAC3D,OAAO,CAAC,YAAY,CAAC,CA8CvB;AA2BD;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,gBAAgB,GACrB,IAAI,CAAC,iBAAiB,EAAE,QAAQ,GAAG,aAAa,CAAC,CA0DnD"}