@bananapus/nana-sdk-core 2.24.5 → 2.26.0

package/dist/esm/v6/sticky.d.ts

@@ -1,6 +1,6 @@
-import { Address } from "viem";
+import { Address, type Hex, type PublicClient } from "viem";
 import type { JBChainId } from "../types.js";
-import type { JBSplit } from "./splits.js";
+import { type JBSplit } from "./splits.js";
 /**
  * A split routes funds to Sticky holders when its `hook` is the chain's
  * `StickyDistributor`. The distributor reads the rest of the split this way:
@@ -67,4 +67,319 @@ export declare function decodeStickyGroupId(groupId: bigint): StickyGroup;
  * not, a tenure split funds the default group instead.
  */
 export declare function describeStickySplit(split: Pick<JBSplit, "projectId">): string;
+/** The collector's public delivery, accounting and immutable identity surface. */
+export declare const stickySourceCollectorAbi: readonly [{
+    readonly name: "DESTINATION_CHAIN_ID";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "DIRECTORY";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}, {
+    readonly name: "FEE_PAYER";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}, {
+    readonly name: "RECEIVER_FACTORY";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}, {
+    readonly name: "REGISTRY";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}, {
+    readonly name: "TOKENS";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}, {
+    readonly name: "pendingOf";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "sourceProjectId";
+    }, {
+        readonly type: "address";
+        readonly name: "stickyToken";
+    }, {
+        readonly type: "uint256";
+        readonly name: "groupId";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "totalPendingOf";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "sourceProjectId";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "send";
+    readonly type: "function";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "sourceProjectId";
+    }, {
+        readonly type: "address";
+        readonly name: "stickyToken";
+    }, {
+        readonly type: "uint256";
+        readonly name: "groupId";
+    }, {
+        readonly type: "uint256";
+        readonly name: "amount";
+    }, {
+        readonly type: "address";
+        readonly name: "sucker";
+    }, {
+        readonly type: "address";
+        readonly name: "backingToken";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "leafIndex";
+    }];
+}, {
+    readonly name: "settle";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "sourceProjectId";
+    }, {
+        readonly type: "address";
+        readonly name: "stickyToken";
+    }, {
+        readonly type: "uint256";
+        readonly name: "groupId";
+    }, {
+        readonly type: "uint256";
+        readonly name: "amount";
+    }];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "settled";
+    }];
+}, {
+    readonly name: "Queue";
+    readonly type: "event";
+    readonly inputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "sourceProjectId";
+        readonly indexed: true;
+    }, {
+        readonly type: "address";
+        readonly name: "stickyToken";
+        readonly indexed: true;
+    }, {
+        readonly type: "uint256";
+        readonly name: "groupId";
+        readonly indexed: true;
+    }, {
+        readonly type: "address";
+        readonly name: "receiver";
+    }, {
+        readonly type: "uint256";
+        readonly name: "amount";
+    }, {
+        readonly type: "address";
+        readonly name: "caller";
+    }];
+}, {
+    readonly name: "Send";
+    readonly type: "event";
+    readonly inputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "sourceProjectId";
+        readonly indexed: true;
+    }, {
+        readonly type: "address";
+        readonly name: "stickyToken";
+        readonly indexed: true;
+    }, {
+        readonly type: "uint256";
+        readonly name: "groupId";
+        readonly indexed: true;
+    }, {
+        readonly type: "address";
+        readonly name: "sucker";
+    }, {
+        readonly type: "address";
+        readonly name: "backingToken";
+    }, {
+        readonly type: "uint256";
+        readonly name: "index";
+    }, {
+        readonly type: "uint256";
+        readonly name: "projectTokenCount";
+    }, {
+        readonly type: "uint256";
+        readonly name: "minimumReclaimed";
+    }, {
+        readonly type: "uint256";
+        readonly name: "feeTokenCount";
+    }, {
+        readonly type: "uint256";
+        readonly name: "refundedFee";
+    }, {
+        readonly type: "uint256";
+        readonly name: "refundedTransportPayment";
+    }, {
+        readonly type: "address";
+        readonly name: "caller";
+    }];
+}, {
+    readonly name: "Settle";
+    readonly type: "event";
+    readonly inputs: readonly [{
+        readonly type: "uint256";
+        readonly name: "sourceProjectId";
+        readonly indexed: true;
+    }, {
+        readonly type: "address";
+        readonly name: "stickyToken";
+        readonly indexed: true;
+    }, {
+        readonly type: "uint256";
+        readonly name: "groupId";
+        readonly indexed: true;
+    }, {
+        readonly type: "uint256";
+        readonly name: "amount";
+    }, {
+        readonly type: "uint256";
+        readonly name: "settled";
+    }, {
+        readonly type: "address";
+        readonly name: "caller";
+    }];
+}];
+/**
+ * A reviewed, actually deployed collector and fee child on one source chain.
+ * Obtain hashes and bindings from verified deployment artifacts, never predictions
+ * or the target's own getters. A destination family has one address across sources.
+ */
+export interface StickySourceCollectorDeployment {
+    sourceChainId: JBChainId;
+    destinationChainId: JBChainId;
+    address: Address;
+    runtimeCodeHash: Hex;
+    feePayer: Address;
+    feePayerRuntimeCodeHash: Hex;
+    registry: Address;
+    tokens: Address;
+    directory: Address;
+    receiverFactory: Address;
+}
+/** No new collector family has been published as a verified live deployment yet. */
+export declare const STICKY_SOURCE_COLLECTOR_DEPLOYMENTS: readonly StickySourceCollectorDeployment[];
+/**
+ * Find a deployed source/home pair. Unknown or conflicting family records fail
+ * closed, including different addresses for the same destination on other sources.
+ */
+export declare function stickySourceCollectorDeployment(sourceChainId: number, destinationChainId: number, deployments?: readonly StickySourceCollectorDeployment[]): StickySourceCollectorDeployment | undefined;
+/** Recognize only an unambiguous deployed collector on this particular chain. */
+export declare function stickySourceCollectorAt(sourceChainId: number, address: Address, deployments?: readonly StickySourceCollectorDeployment[]): StickySourceCollectorDeployment | undefined;
+/** One source project's attributed queue for a pool on the deployment's home chain. */
+export interface StickyCollectorAllocation {
+    deployment: StickySourceCollectorDeployment;
+    sourceProjectId: bigint;
+    stickyToken: Address;
+    groupId: bigint;
+}
+/**
+ * Build one reserved-token split. Place it in RESERVED_TOKEN_SPLIT_GROUP_ID (1).
+ * The split projectId remains the existing reward group, not a chain encoding.
+ * Call verifyStickyCollectorRoute before configuring it; this pure builder cannot
+ * establish deployment, destination readiness or an actually usable transport lane.
+ */
+export declare function buildStickyReservedSplit(args: StickyCollectorAllocation & {
+    percent: number;
+    lockedUntil?: number;
+}): JBSplit;
+/** Read the queued amount, in source project-token atoms, without initiating delivery. */
+export declare function getStickyCollectorPending(client: PublicClient, args: StickyCollectorAllocation): Promise<bigint>;
+/**
+ * Prepare permissionless source submission, not final destination settlement.
+ * Reverify identity/route and pending custody before wallet simulation. Value pays
+ * the registry fee plus any native transport budget; this builder does not quote it.
+ */
+export declare function buildStickyCollectorSendTx(args: StickyCollectorAllocation & {
+    amount: bigint;
+    sucker: Address;
+    backingToken: Address;
+    value: bigint;
+}): {
+    chainId: JBChainId;
+    address: Address;
+    abi: typeof stickySourceCollectorAbi;
+    functionName: "send";
+    args: readonly [bigint, Address, bigint, bigint, Address, Address];
+    value: bigint;
+};
+/** Prepare permissionless local settlement; the source must be the bound home chain. */
+export declare function buildStickyCollectorSettleTx(args: StickyCollectorAllocation & {
+    amount: bigint;
+}): {
+    chainId: JBChainId;
+    address: Address;
+    abi: typeof stickySourceCollectorAbi;
+    functionName: "settle";
+    args: readonly [bigint, Address, bigint, bigint];
+};
+/**
+ * Verify reviewed runtime fingerprints and immutable bindings on the actual source
+ * chain. This is read-only evidence at the time of the call, not execution authority.
+ */
+export declare function verifyStickySourceCollector(client: PublicClient, deployment: StickySourceCollectorDeployment): Promise<void>;
+/** A qualified route snapshot. It does not prove finality or install an executor. */
+export interface StickyCollectorRoute {
+    receiver: Address;
+    sourceToken: Address;
+    rewardToken: Address;
+    destinationProjectId: bigint;
+}
+/**
+ * Freshly qualify one local or direct remote lane before configuring a split or
+ * sending. Source credits may queue before their ERC-20 exists; the home-chain
+ * reward ERC-20 and registered Sticky pool must already exist. The canonical
+ * registered peer determines the destination reward project, never address parity.
+ * Re-run through the reviewed-write reverify boundary before simulation/submission.
+ */
+export declare function verifyStickyCollectorRoute(sourceClient: PublicClient, destinationClient: PublicClient, args: StickyCollectorAllocation & {
+    sucker?: Address;
+    backingToken?: Address;
+}): Promise<StickyCollectorRoute>;
 //# sourceMappingURL=sticky.d.ts.map

package/dist/esm/v6/sticky.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sticky.d.ts","sourceRoot":"","sources":["../../../src/v6/sticky.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAkB,MAAM,MAAM,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAG3C;;;;;;;;;;;;;;;;GAgBG;AAEH,kFAAkF;AAClF,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAE1C,yEAAyE;AACzE,eAAO,MAAM,oBAAoB,QAAQ,CAAC;AAE1C,mEAAmE;AACnE,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3D,8EAA8E;AAC9E,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAEpE;AAED,yDAAyD;AACzD,wBAAgB,aAAa,CAC3B,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAC5B,OAAO,EAAE,SAAS,GACjB,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAoBpE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,GAAG,MAAM,CAoBT;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,CAShE;AAMD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,MAAM,CAgB7E"}
+{"version":3,"file":"sticky.d.ts","sourceRoot":"","sources":["../../../src/v6/sticky.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAMP,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,MAAM,CAAC;AAWd,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAc,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AAGvD;;;;;;;;;;;;;;;;GAgBG;AAEH,kFAAkF;AAClF,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAE1C,yEAAyE;AACzE,eAAO,MAAM,oBAAoB,QAAQ,CAAC;AAE1C,mEAAmE;AACnE,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3D,8EAA8E;AAC9E,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAEpE;AAED,yDAAyD;AACzD,wBAAgB,aAAa,CAC3B,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAC5B,OAAO,EAAE,SAAS,GACjB,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAoBpE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,GAAG,MAAM,CAoBT;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,CAShE;AAMD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,MAAM,CAgB7E;AAED,kFAAkF;AAClF,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwS3B,CAAC;AA2EX;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,aAAa,EAAE,SAAS,CAAC;IACzB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,GAAG,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,uBAAuB,EAAE,GAAG,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,oFAAoF;AACpF,eAAO,MAAM,mCAAmC,EAAE,SAAS,+BAA+B,EACtF,CAAC;AAEL;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,aAAa,EAAE,MAAM,EACrB,kBAAkB,EAAE,MAAM,EAC1B,WAAW,6CAAsC,GAChD,+BAA+B,GAAG,SAAS,CAiB7C;AAED,iFAAiF;AACjF,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,OAAO,EAChB,WAAW,6CAAsC,GAChD,+BAA+B,GAAG,SAAS,CAa7C;AAED,uFAAuF;AACvF,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,+BAA+B,CAAC;IAC5C,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAYD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,yBAAyB,GAAG;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACA,OAAO,CAeT;AAED,0FAA0F;AAC1F,wBAAsB,yBAAyB,CAC7C,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,yBAAyB,GAC9B,OAAO,CAAC,MAAM,CAAC,CASjB;AAUD;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,yBAAyB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACf,GACA;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,wBAAwB,CAAC;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACnE,KAAK,EAAE,MAAM,CAAC;CACf,CA2BA;AAED,wFAAwF;AACxF,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,yBAAyB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GACnD;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,wBAAwB,CAAC;IACrC,YAAY,EAAE,QAAQ,CAAC;IACvB,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CAClD,CAgBA;AAiED;;;GAGG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,+BAA+B,GAC1C,OAAO,CAAC,IAAI,CAAC,CA+Df;AAED,qFAAqF;AACrF,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;GAMG;AACH,wBAAsB,0BAA0B,CAC9C,YAAY,EAAE,YAAY,EAC1B,iBAAiB,EAAE,YAAY,EAC/B,IAAI,EAAE,yBAAyB,GAAG;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACA,OAAO,CAAC,oBAAoB,CAAC,CAqO/B"}