@bananapus/nana-sdk-core 2.28.0 → 2.30.0

package/dist/cjs/v6/defifa.d.ts

@@ -0,0 +1,154 @@
+import { type Address, type Hex, type PublicClient, type TransactionReceipt, erc721Abi } from "viem";
+import type { JBChainId } from "../types.js";
+import { type V6CashOutTxRequest } from "./cashOut.js";
+import { type ProjectDefifaInventory } from "./nftInventory.js";
+import { type V6PayTxRequest } from "./pay.js";
+/** Adapter RPC/review budget, not a native protocol supply or metadata limit. */
+export declare const MAX_DEFIFA_ACTION_NFTS = 128;
+/** Phase-only display eligibility; preparation still authenticates current rules. */
+export declare function defifaPhaseAllowsPay(phase: number): boolean;
+/** NO_CONTEST additionally requires native activation, checked by preparation. */
+export declare function defifaPhaseAllowsCashOut(phase: number): boolean;
+/**
+ * Native Defifa pay payload: (address attestationDelegate, uint16[] tierIds).
+ * Resolve metadataIdTarget from an authenticated inventory's CODE_ORIGIN, never
+ * its clone address. This pure encoder validates inputs, not contract identity.
+ * Zero delegates through the game's configured default, or to the beneficiary.
+ * For a self-payment this updates delegation for ALL holdings in selected tiers.
+ * Generic build721PayMetadata is incompatible: its true boolean becomes address 1.
+ */
+export declare function buildDefifaPayMetadata({ metadataIdTarget, tierIdsToMint, attestationDelegate, }: {
+    metadataIdTarget: Address;
+    tierIdsToMint: readonly bigint[];
+    attestationDelegate?: Address;
+}): Hex;
+export interface DefifaActionArgs {
+    chainId: JBChainId;
+    projectId: bigint;
+    /** The actual sender, also the NFT holder for cash-outs/transfers. */
+    account: Address;
+    /** Bind preparation to the collection shown in the review. */
+    expectedHook?: Address;
+}
+export interface PreparedDefifaPay {
+    inventory: ProjectDefifaInventory;
+    transaction: V6PayTxRequest;
+    amount: bigint;
+    /** Selected-tier review evidence. Unit prices include the native discount. */
+    selectedTiers: {
+        tierId: bigint;
+        count: bigint;
+        unitPrice: bigint;
+    }[];
+    /** Encoded value; zero preserves the native fallback rule. */
+    attestationDelegate: Address;
+    /** Shared effective delegate, or null when a gift preserves different tier delegates. */
+    effectiveAttestationDelegate: Address | null;
+    /** Native effective delegation, including existing recipient preferences on gifts. */
+    effectiveDelegates: {
+        tierId: bigint;
+        delegate: Address;
+    }[];
+}
+/**
+ * Fresh native identity, MINT phase, selected supply and exact tier cost at one
+ * block. Re-run after review and compare the entire request before execution.
+ * ERC20 payments need allowance; after approval, simulate this EXACT request
+ * with account before sending. Preparation does not grant execution authority.
+ * Donations are separate addToBalanceOf calls: native Defifa rejects overpayment.
+ */
+export declare function prepareDefifaPay(client: PublicClient, args: DefifaActionArgs & {
+    tierIdsToMint: readonly bigint[];
+    beneficiary?: Address;
+    attestationDelegate?: Address;
+    memo?: string;
+}): Promise<PreparedDefifaPay>;
+export interface PreparedDefifaCashOut {
+    inventory: ProjectDefifaInventory;
+    transaction: V6CashOutTxRequest;
+    /** Actual terminal simulation return, after any protocol fee. */
+    reclaimAmount: bigint;
+    /** Raw protocol token units quoted at inventory.blockNumber. */
+    protocolRewards: {
+        defifaToken: Address;
+        defifaAmount: bigint;
+        defifaDecimals: number;
+        baseProtocolToken: Address;
+        baseProtocolAmount: bigint;
+        baseProtocolDecimals: number;
+    };
+}
+/** Fresh owner/phase checks and exact cashOutTokensOf simulation, with no ERC721 approval. */
+export declare function prepareDefifaCashOut(client: PublicClient, args: DefifaActionArgs & {
+    tokenIds: readonly bigint[];
+    beneficiary?: Address;
+    minimumReclaim?: bigint;
+}): Promise<PreparedDefifaCashOut>;
+export interface DefifaTransferTxRequest {
+    chainId: JBChainId;
+    address: Address;
+    abi: typeof erc721Abi;
+    functionName: "safeTransferFrom";
+    args: readonly [Address, Address, bigint];
+}
+/** Standard NFT transfer; native pause flags and receiver callbacks are simulated exactly. */
+export declare function prepareDefifaTransfer(client: PublicClient, args: DefifaActionArgs & {
+    tokenId: bigint;
+    recipient: Address;
+}): Promise<{
+    inventory: ProjectDefifaInventory;
+    transaction: DefifaTransferTxRequest;
+}>;
+export interface DefifaNftReceiptContext {
+    /** Retain these authenticated native identities alongside the reviewed request. */
+    hook: Address;
+    implementation: Address;
+    account: Address;
+    transaction: V6PayTxRequest | V6CashOutTxRequest | DefifaTransferTxRequest;
+    /** Wallet-returned Safe proposal identity; absent for direct wallet execution. */
+    safe?: {
+        proposalHash: Hex;
+    };
+}
+/**
+ * Reconstruct native verification context from an existing reviewed-write
+ * journal. Authenticate the project/terminal at the receipt's historical block;
+ * never prepare, simulate or send a new action. The wallet-returned identity is
+ * required: a hashless uncertain write cannot be matched to an old receipt.
+ * Call verifyDefifaNftTransaction afterward; restoration alone proves no outcome.
+ */
+export declare function restoreDefifaNftReceiptContext(client: PublicClient, args: {
+    chainId: JBChainId;
+    projectId: bigint;
+    record: unknown;
+    receipt: TransactionReceipt;
+    expectedHook?: Address;
+}): Promise<DefifaNftReceiptContext>;
+/**
+ * Verify native NFT effects of one exact reviewed call; throw if proof is missing.
+ * The execution engine MUST first authenticate the canonical receipt and actual
+ * chain/account/call/value (including the executed inner call for Safe routes).
+ * This pure check is also usable during recovery without preparing a new action.
+ * Receipt logs, not end-of-block ownership, prove transfers: a receiver may
+ * forward an NFT in its callback or a later transaction in the same block.
+ */
+export declare function verifyDefifaNftReceipt({ hook, implementation, account, transaction }: DefifaNftReceiptContext, receipt: TransactionReceipt): void;
+/**
+ * The exact reviewed action failed in a canonical finalized block. This closes
+ * only that attempt; retain its evidence and review any new intent separately.
+ * A reverted Safe outer executor alone does not establish this outcome.
+ */
+export declare class DefifaNftTransactionRevertedError extends Error {
+    readonly hash: Hex;
+    readonly chainId: number;
+    readonly name = "DefifaNftTransactionRevertedError";
+    constructor(hash: Hex, chainId: number);
+}
+/**
+ * Authenticate canonical execution using the SDK's existing transaction/Safe
+ * proof owners, then prove native NFT effects. Only
+ * DefifaNftTransactionRevertedError proves finalized failure. Retain context
+ * and receipt on other errors and retry this read-only function; do not resend.
+ */
+export declare function verifyDefifaNftTransaction(client: PublicClient, context: DefifaNftReceiptContext, receipt: TransactionReceipt): Promise<void>;
+//# sourceMappingURL=defifa.d.ts.map

package/dist/cjs/v6/defifa.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defifa.d.ts","sourceRoot":"","sources":["../../../src/v6/defifa.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,GAAG,EACR,KAAK,YAAY,EACjB,KAAK,kBAAkB,EAMvB,SAAS,EAKV,MAAM,MAAM,CAAC;AAKd,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAGL,KAAK,kBAAkB,EACxB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAEL,KAAK,sBAAsB,EAC5B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAc,KAAK,cAAc,EAAE,MAAM,UAAU,CAAC;AAuB3D,iFAAiF;AACjF,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAE1C,qFAAqF;AACrF,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAE3D;AAED,kFAAkF;AAClF,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAE/D;AAqBD;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,EACrC,gBAAgB,EAChB,aAAa,EACb,mBAAiC,GAClC,EAAE;IACD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,aAAa,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,GAAG,GAAG,CA0BN;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,sEAAsE;IACtE,OAAO,EAAE,OAAO,CAAC;IACjB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AA6DD,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,sBAAsB,CAAC;IAClC,WAAW,EAAE,cAAc,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,8EAA8E;IAC9E,aAAa,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACtE,8DAA8D;IAC9D,mBAAmB,EAAE,OAAO,CAAC;IAC7B,yFAAyF;IACzF,4BAA4B,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7C,sFAAsF;IACtF,kBAAkB,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;CAC7D;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,gBAAgB,GAAG;IACvB,aAAa,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GACA,OAAO,CAAC,iBAAiB,CAAC,CAsG5B;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,sBAAsB,CAAC;IAClC,WAAW,EAAE,kBAAkB,CAAC;IAChC,iEAAiE;IACjE,aAAa,EAAE,MAAM,CAAC;IACtB,gEAAgE;IAChE,eAAe,EAAE;QACf,WAAW,EAAE,OAAO,CAAC;QACrB,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,EAAE,MAAM,CAAC;QACvB,iBAAiB,EAAE,OAAO,CAAC;QAC3B,kBAAkB,EAAE,MAAM,CAAC;QAC3B,oBAAoB,EAAE,MAAM,CAAC;KAC9B,CAAC;CACH;AAkBD,8FAA8F;AAC9F,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,gBAAgB,GAAG;IACvB,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,GACA,OAAO,CAAC,qBAAqB,CAAC,CAmGhC;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,SAAS,CAAC;IACtB,YAAY,EAAE,kBAAkB,CAAC;IACjC,IAAI,EAAE,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;CAC3C;AAED,8FAA8F;AAC9F,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,gBAAgB,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,GAC/D,OAAO,CAAC;IACT,SAAS,EAAE,sBAAsB,CAAC;IAClC,WAAW,EAAE,uBAAuB,CAAC;CACtC,CAAC,CAmBD;AAOD,MAAM,WAAW,uBAAuB;IACtC,mFAAmF;IACnF,IAAI,EAAE,OAAO,CAAC;IACd,cAAc,EAAE,OAAO,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,cAAc,GAAG,kBAAkB,GAAG,uBAAuB,CAAC;IAC3E,kFAAkF;IAClF,IAAI,CAAC,EAAE;QAAE,YAAY,EAAE,GAAG,CAAA;KAAE,CAAC;CAC9B;AAyCD;;;;;;GAMG;AACH,wBAAsB,8BAA8B,CAClD,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE;IACJ,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,kBAAkB,CAAC;IAC5B,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACA,OAAO,CAAC,uBAAuB,CAAC,CAgHlC;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,uBAAuB,EACvE,OAAO,EAAE,kBAAkB,GAC1B,IAAI,CAqIN;AAED;;;;GAIG;AACH,qBAAa,iCAAkC,SAAQ,KAAK;IAIxD,QAAQ,CAAC,IAAI,EAAE,GAAG;IAClB,QAAQ,CAAC,OAAO,EAAE,MAAM;IAJ1B,QAAQ,CAAC,IAAI,uCAAuC;gBAGzC,IAAI,EAAE,GAAG,EACT,OAAO,EAAE,MAAM;CAI3B;AAED;;;;;GAKG;AACH,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,uBAAuB,EAChC,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,IAAI,CAAC,CA0Gf"}