@gearbox-protocol/sdk 14.12.0-next.36 → 14.12.0-next.37

package/dist/types/sdk/OnchainSDK.d.ts

@@ -1,7 +1,7 @@
 import type { Address } from "viem";
 import { type PublicClient, type Transport } from "viem";
 import type { HttpRpcClientOptions } from "viem/utils";
-import { type ICreditAccountsService, type ILiquidationsService, type IWithdrawalCompressorContract } from "./accounts/index.js";
+import { type ICreditAccountsService, type ILiquidationsService, type IRedemptionLoggerContract, type IWithdrawalCompressorContract } from "./accounts/index.js";
 import type { BaseState, IBaseContract } from "./base/index.js";
 import { ChainContractsRegister } from "./base/index.js";
 import type { GearboxChain, NetworkType } from "./chain/chains.js";
@@ -295,4 +295,11 @@ export declare class OnchainSDK<const Plugins extends PluginsMap = {}> extends C
      * when no withdrawal compressor is supported on it.
      **/
     get withdrawalCompressor(): IWithdrawalCompressorContract | undefined;
+    /**
+     * `RedemptionLogger` contract for the current chain, or `undefined` when
+     * it is not deployed on it. Created lazily on first access: the contract
+     * is resolved from the address provider, which is only available after
+     * the SDK is attached or hydrated.
+     **/
+    get redemptionLogger(): IRedemptionLoggerContract | undefined;
 }

package/dist/types/sdk/accounts/withdrawal-compressor/RedemptionLoggerV310Contract.d.ts

@@ -0,0 +1,149 @@
+import type { Address } from "viem";
+import { BaseContract } from "../../base/index.js";
+import type { OnchainSDK } from "../../OnchainSDK.js";
+import type { DelayedIntent, IRedemptionLoggerContract, RedemptionLog } from "./types.js";
+declare const abi: readonly [{
+    readonly type: "function";
+    readonly name: "allowedGateways";
+    readonly inputs: readonly [{
+        readonly name: "gateway";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "contractType";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "logRedemption";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "redeemer";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "extraData";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redemptionLogs";
+    readonly inputs: readonly [{
+        readonly name: "redeemer";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "tuple";
+        readonly internalType: "struct IRedemptionLogger.RedemptionLog";
+        readonly components: readonly [{
+            readonly name: "creditAccount";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "redeemer";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "extraData";
+            readonly type: "bytes";
+            readonly internalType: "bytes";
+        }];
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setGatewayAllowed";
+    readonly inputs: readonly [{
+        readonly name: "gateway";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "allowed";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "version";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "event";
+    readonly name: "RedemptionLogged";
+    readonly inputs: readonly [{
+        readonly name: "creditAccount";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "redeemer";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "extraData";
+        readonly type: "bytes";
+        readonly indexed: false;
+        readonly internalType: "bytes";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "GatewayNotAllowedException";
+    readonly inputs: readonly [];
+}];
+type abi = typeof abi;
+/**
+ * Wrapper around the v310 `RedemptionLogger` helper contract that stores
+ * redemption data logged by delayed-withdrawal gateways for off-chain
+ * indexing. Resolved from the address provider by the
+ * `LOCAL::REDEMPTION_LOGGER` key.
+ **/
+export declare class RedemptionLoggerV310Contract extends BaseContract<abi> implements IRedemptionLoggerContract {
+    constructor(sdk: OnchainSDK, address: Address, version: number);
+    /**
+     * Returns the redemption data logged for a redeemer; all-zero fields when
+     * nothing was logged for it.
+     **/
+    getRedemptionLog(redeemer: Address, blockNumber?: bigint): Promise<RedemptionLog>;
+    /**
+     * Reads the redemption log of a redeemer and decodes the recorded intent.
+     *
+     * @param redeemer - Redeemer contract the withdrawal is claimed from.
+     * @param blockNumber - Optional block number to read the log at.
+     * @returns The decoded intent, or `undefined` when the log carries none
+     * (including when nothing was logged for the redeemer).
+     * @throws InvalidDelayedIntentError when the logged `extraData` is
+     * non-empty but cannot be decoded as a `DelayedIntent`.
+     **/
+    getDelayedIntent(redeemer: Address, blockNumber?: bigint): Promise<DelayedIntent | undefined>;
+}
+export {};

package/dist/types/sdk/accounts/withdrawal-compressor/createRedemptionLogger.d.ts

@@ -0,0 +1,10 @@
+import type { OnchainSDK } from "../../OnchainSDK.js";
+import type { IRedemptionLoggerContract } from "./types.js";
+/**
+ * Creates a redemption logger contract for the current chain, resolving its
+ * address from the address provider, or returns `undefined` when it is not
+ * deployed on it. Consumers should access the instance via
+ * `sdk.redemptionLogger`.
+ * @param sdk
+ **/
+export declare function createRedemptionLogger(sdk: OnchainSDK): IRedemptionLoggerContract | undefined;

package/dist/types/sdk/accounts/withdrawal-compressor/errors.d.ts

@@ -0,0 +1,13 @@
+import type { Hex } from "viem";
+/**
+ * Thrown when a delayed-withdrawal request or redemption log carries
+ * non-empty `extraData` that cannot be decoded as a `DelayedIntent`.
+ * Requests produced by our stack always encode a valid intent, so garbage
+ * here means a malformed/foreign transaction that must not be previewed as
+ * if it were fine.
+ */
+export declare class InvalidDelayedIntentError extends Error {
+    /** Raw `extraData` that failed to decode. */
+    readonly extraData: Hex;
+    constructor(extraData: Hex, cause?: unknown);
+}

package/dist/types/sdk/accounts/withdrawal-compressor/index.d.ts

@@ -1,7 +1,10 @@
 export * from "./AbstractWithdrawalCompressorContract.js";
 export * from "./addresses.js";
+export * from "./createRedemptionLogger.js";
 export * from "./createWithdrawalCompressor.js";
+export * from "./errors.js";
 export * from "./intent-codec.js";
+export * from "./RedemptionLoggerV310Contract.js";
 export * from "./types.js";
 export * from "./WithdrawalCompressorV310Contract.js";
 export * from "./WithdrawalCompressorV311Contract.js";

package/dist/types/sdk/accounts/withdrawal-compressor/types.d.ts

@@ -1,4 +1,4 @@
-import type { Address } from "viem";
+import type { Address, Hex } from "viem";
 import type { IBaseContract } from "../../base/index.js";
 import type { MultiCall } from "../../types/index.js";
 /**
@@ -393,3 +393,45 @@ export interface IWithdrawalCompressorContract extends IBaseContract {
      **/
     readonly state: WithdrawalsState | undefined;
 }
+/**
+ * Redemption data logged by a delayed-withdrawal gateway (Securitize, Midas)
+ * when a redemption is requested, keyed by the redeemer contract address.
+ **/
+export interface RedemptionLog {
+    /**
+     * Credit account the redemption was requested for
+     */
+    creditAccount: Address;
+    /**
+     * Redeemer contract address
+     */
+    redeemer: Address;
+    /**
+     * Additional redemption data; carries the abi-encoded `DelayedIntent`
+     * when the request had one, `0x` otherwise
+     */
+    extraData: Hex;
+}
+/**
+ * Version-agnostic interface of the RedemptionLogger contract that stores
+ * redemption data logged by delayed-withdrawal gateways for off-chain
+ * indexing.
+ **/
+export interface IRedemptionLoggerContract extends IBaseContract {
+    /**
+     * Returns the redemption data logged for a redeemer; all-zero fields when
+     * nothing was logged for it.
+     **/
+    getRedemptionLog(redeemer: Address, blockNumber?: bigint): Promise<RedemptionLog>;
+    /**
+     * Reads the redemption log of a redeemer and decodes the recorded intent.
+     *
+     * @param redeemer - Redeemer contract the withdrawal is claimed from.
+     * @param blockNumber - Optional block number to read the log at.
+     * @returns The decoded intent, or `undefined` when the log carries none
+     * (including when nothing was logged for the redeemer).
+     * @throws InvalidDelayedIntentError when the logged `extraData` is
+     * non-empty but cannot be decoded as a `DelayedIntent`.
+     **/
+    getDelayedIntent(redeemer: Address, blockNumber?: bigint): Promise<DelayedIntent | undefined>;
+}

package/dist/types/sdk/constants/address-provider.d.ts

@@ -32,6 +32,7 @@ export declare const AP_WETH_TOKEN = "WETH_TOKEN";
 export declare const AP_ZAPPER_REGISTER = "ZAPPER_REGISTER";
 export declare const AP_ZERO_PRICE_FEED = "ZERO_PRICE_FEED";
 export declare const AP_RWA_COMPRESSOR = "GLOBAL::RWA_COMPRESSOR";
+export declare const AP_REDEMPTION_LOGGER = "LOCAL::REDEMPTION_LOGGER";
 /**
  * Default address provider address for v3.1.0
  * Is determenistic and does not depend on the network type

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.12.0-next.36",
+  "version": "14.12.0-next.37",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {