@otim/utils 0.0.2-development.0

package/dist/instructions/activate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"activate.d.ts","sourceRoot":"","sources":["../../src/instructions/activate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAClE,OAAO,KAAK,EACV,OAAO,EACP,SAAS,EACT,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAY5C;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,eAAe,CAAC;IACxB,WAAW,EAAE,aAAa,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC;IAC7D,OAAO,EAAE;QACP,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QACvB,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,EAAE,MAAM,CAAC;QACtB,MAAM,EAAE,SAAS,CAAC;KACnB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,SAAS,CAAC;IAChB,aAAa,EAAE,SAAS,CAAC;IACzB,MAAM,EAAE,SAAS,CAAC;IAClB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,0BAA0B,GACjC,eAAe,CAQjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,SAAS,EACf,aAAa,EAAE,SAAS,EACxB,YAAY,EAAE,SAAS,EACvB,UAAU,EAAE,iBAAiB,GAC5B;IACD,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3C,CAqCA;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,IAAI,CAAC,0BAA0B,EAAE,WAAW,GAAG,UAAU,CAAC,EACnE,MAAM,EAAE,0BAA0B,GACjC,0BAA0B,CA4B5B;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,0BAA0B,GAClC,0BAA0B,CAc5B"}

package/dist/instructions/build.d.mts

@@ -0,0 +1,146 @@
+import type { InstructionBuildRequest } from "@otim/utils/api";
+import type { Address, InstructionAction } from "@otim/utils/schemas";
+export type { BaseInstructionBuildPayload, GasLimitConfigurablePayload, ScheduledInstructionBuildPayload, TokenInstructionPayload, } from "./types";
+/**
+ * Instruction build utilities
+ *
+ * Sections:
+ * - Types & constants
+ * - Schedule helpers
+ * - Gas/Fee helpers
+ * - Action-specific resolvers
+ * - Build payload creator
+ */
+/**
+ * Parameters required to assemble a build payload for an instruction action.
+ */
+export interface CreateBuildPayloadParams {
+    action: InstructionAction;
+    address: Address;
+    chainId: number;
+    maxExecutions: number;
+    salt?: number;
+    actionArguments: InstructionBuildRequest["actionArguments"][string];
+}
+/**
+ * Build payload creator
+ *
+ * Creates the request body to build an instruction on the backend.
+ */
+export declare function createBuildPayload({ action, address, chainId, maxExecutions, salt, actionArguments, }: CreateBuildPayloadParams): InstructionBuildRequest;
+/**
+ * Start specification for instruction scheduling.
+ * Determines when the instruction should begin execution.
+ */
+export type ScheduleStart = {
+    type: "datetime";
+    startDate: string;
+    startTime: string;
+} | {
+    type: "now";
+};
+/**
+ * Repeat policy for instruction scheduling.
+ * Controls how many times an instruction can execute.
+ */
+export type ScheduleRepeat = {
+    type: "max-executions";
+    maxExecutions: number;
+} | {
+    type: "until-deactivated";
+};
+/**
+ * Advanced tuning options affecting schedule and fee behavior.
+ * Provides fine-grained control over instruction execution parameters.
+ */
+export interface BuildAdvancedOptions {
+    /** Maximum latency allowed for scheduled execution intervals */
+    intervalLatencyLimit?: unknown;
+    /** Lookback period for mean price calculation in swap operations */
+    meanPriceLookBack?: unknown;
+    /** Maximum allowed price deviation in basis points for swaps */
+    maxPriceDeviationBps?: string | number;
+    /** Maximum base fee per gas in Gwei for EIP-1559 transactions */
+    maxBaseFeePerGas?: number | string;
+    /** Maximum priority fee per gas in Gwei for EIP-1559 transactions */
+    maxPriorityFeePerGas?: number | string;
+}
+/**
+ * Resolves schedule start values.
+ * - "datetime": schedules with explicit startAt timestamp (in seconds)
+ * - "now" or omitted: starts immediately
+ */
+export declare const createScheduleStart: (values?: ScheduleStart) => {
+    startAt: number;
+    startBy: number;
+};
+/**
+ * Converts a time unit value to seconds and returns the interval field.
+ */
+export declare const createScheduleInterval: (values?: unknown) => {
+    interval: number;
+};
+/**
+ * Converts a time unit value to seconds and returns the timeout field.
+ * Timeout represents the maximum latency allowed for scheduled execution (0 = no limit).
+ */
+export declare const createScheduleIntervalLatencyLimit: (values?: unknown) => {
+    timeout: number;
+};
+/**
+ * Resolves maxExecutions based on repeat policy.
+ * Returns 0 for unlimited executions when type is "until-deactivated".
+ */
+export declare const createScheduleRepeat: (values: ScheduleRepeat) => {
+    maxExecutions: number;
+};
+/**
+ * Assembles the schedule object when any schedule-related option is provided.
+ */
+export declare const resolveSchedule: (repeat: ScheduleRepeat, start?: ScheduleStart, interval?: unknown, advanced?: BuildAdvancedOptions) => {
+    maxExecutions: number;
+};
+/**
+ * Converts a Gwei value into Wei as a hex string. Returns 0x0 on invalid input.
+ */
+export declare const convertGweiToWei: (gweiValue: number | string) => `0x${string}`;
+/**
+ * Fee input required to resolve base fee configuration.
+ * Specifies the token and amount for instruction execution fees.
+ */
+export interface BuildFeeInput {
+    /** Address of the token used to pay execution fees */
+    token: Address;
+    /** Amount of fee to pay (optional, defaults to 0) */
+    executionFee?: number | string;
+}
+/**
+ * Builds the fee object including EIP-1559 caps and optional pricing controls.
+ */
+export declare const resolveFee: (fee: BuildFeeInput, advanced?: BuildAdvancedOptions) => Record<string, unknown>;
+/**
+ * Some actions allow an explicit gas limit. Returns { gasLimit: 0 } when
+ * needed, otherwise an empty object to keep payload minimal.
+ */
+export declare const resolveGasLimitIfNeeded: (action: InstructionAction) => {
+    gasLimit: number;
+} | {
+    gasLimit?: undefined;
+};
+/**
+ * Adds depositor field for sweep deposit actions when required.
+ */
+export declare const resolveDepositorForSweepDepositAccountIfNeeded: (action: InstructionAction, depositorAddress: Address) => {
+    depositor: `0x${string}`;
+} | {
+    depositor?: undefined;
+};
+/**
+ * Adds recipient field for Uniswap V3 exact input action when required.
+ */
+export declare const resolveRecipientForUniswapV3ExactInputIfNeeded: (action: InstructionAction, recipientAddress: Address) => {
+    recipient: `0x${string}`;
+} | {
+    recipient?: undefined;
+};
+//# sourceMappingURL=build.d.ts.map

package/dist/instructions/build.d.ts

@@ -0,0 +1,146 @@
+import type { InstructionBuildRequest } from "@otim/utils/api";
+import type { Address, InstructionAction } from "@otim/utils/schemas";
+export type { BaseInstructionBuildPayload, GasLimitConfigurablePayload, ScheduledInstructionBuildPayload, TokenInstructionPayload, } from "./types";
+/**
+ * Instruction build utilities
+ *
+ * Sections:
+ * - Types & constants
+ * - Schedule helpers
+ * - Gas/Fee helpers
+ * - Action-specific resolvers
+ * - Build payload creator
+ */
+/**
+ * Parameters required to assemble a build payload for an instruction action.
+ */
+export interface CreateBuildPayloadParams {
+    action: InstructionAction;
+    address: Address;
+    chainId: number;
+    maxExecutions: number;
+    salt?: number;
+    actionArguments: InstructionBuildRequest["actionArguments"][string];
+}
+/**
+ * Build payload creator
+ *
+ * Creates the request body to build an instruction on the backend.
+ */
+export declare function createBuildPayload({ action, address, chainId, maxExecutions, salt, actionArguments, }: CreateBuildPayloadParams): InstructionBuildRequest;
+/**
+ * Start specification for instruction scheduling.
+ * Determines when the instruction should begin execution.
+ */
+export type ScheduleStart = {
+    type: "datetime";
+    startDate: string;
+    startTime: string;
+} | {
+    type: "now";
+};
+/**
+ * Repeat policy for instruction scheduling.
+ * Controls how many times an instruction can execute.
+ */
+export type ScheduleRepeat = {
+    type: "max-executions";
+    maxExecutions: number;
+} | {
+    type: "until-deactivated";
+};
+/**
+ * Advanced tuning options affecting schedule and fee behavior.
+ * Provides fine-grained control over instruction execution parameters.
+ */
+export interface BuildAdvancedOptions {
+    /** Maximum latency allowed for scheduled execution intervals */
+    intervalLatencyLimit?: unknown;
+    /** Lookback period for mean price calculation in swap operations */
+    meanPriceLookBack?: unknown;
+    /** Maximum allowed price deviation in basis points for swaps */
+    maxPriceDeviationBps?: string | number;
+    /** Maximum base fee per gas in Gwei for EIP-1559 transactions */
+    maxBaseFeePerGas?: number | string;
+    /** Maximum priority fee per gas in Gwei for EIP-1559 transactions */
+    maxPriorityFeePerGas?: number | string;
+}
+/**
+ * Resolves schedule start values.
+ * - "datetime": schedules with explicit startAt timestamp (in seconds)
+ * - "now" or omitted: starts immediately
+ */
+export declare const createScheduleStart: (values?: ScheduleStart) => {
+    startAt: number;
+    startBy: number;
+};
+/**
+ * Converts a time unit value to seconds and returns the interval field.
+ */
+export declare const createScheduleInterval: (values?: unknown) => {
+    interval: number;
+};
+/**
+ * Converts a time unit value to seconds and returns the timeout field.
+ * Timeout represents the maximum latency allowed for scheduled execution (0 = no limit).
+ */
+export declare const createScheduleIntervalLatencyLimit: (values?: unknown) => {
+    timeout: number;
+};
+/**
+ * Resolves maxExecutions based on repeat policy.
+ * Returns 0 for unlimited executions when type is "until-deactivated".
+ */
+export declare const createScheduleRepeat: (values: ScheduleRepeat) => {
+    maxExecutions: number;
+};
+/**
+ * Assembles the schedule object when any schedule-related option is provided.
+ */
+export declare const resolveSchedule: (repeat: ScheduleRepeat, start?: ScheduleStart, interval?: unknown, advanced?: BuildAdvancedOptions) => {
+    maxExecutions: number;
+};
+/**
+ * Converts a Gwei value into Wei as a hex string. Returns 0x0 on invalid input.
+ */
+export declare const convertGweiToWei: (gweiValue: number | string) => `0x${string}`;
+/**
+ * Fee input required to resolve base fee configuration.
+ * Specifies the token and amount for instruction execution fees.
+ */
+export interface BuildFeeInput {
+    /** Address of the token used to pay execution fees */
+    token: Address;
+    /** Amount of fee to pay (optional, defaults to 0) */
+    executionFee?: number | string;
+}
+/**
+ * Builds the fee object including EIP-1559 caps and optional pricing controls.
+ */
+export declare const resolveFee: (fee: BuildFeeInput, advanced?: BuildAdvancedOptions) => Record<string, unknown>;
+/**
+ * Some actions allow an explicit gas limit. Returns { gasLimit: 0 } when
+ * needed, otherwise an empty object to keep payload minimal.
+ */
+export declare const resolveGasLimitIfNeeded: (action: InstructionAction) => {
+    gasLimit: number;
+} | {
+    gasLimit?: undefined;
+};
+/**
+ * Adds depositor field for sweep deposit actions when required.
+ */
+export declare const resolveDepositorForSweepDepositAccountIfNeeded: (action: InstructionAction, depositorAddress: Address) => {
+    depositor: `0x${string}`;
+} | {
+    depositor?: undefined;
+};
+/**
+ * Adds recipient field for Uniswap V3 exact input action when required.
+ */
+export declare const resolveRecipientForUniswapV3ExactInputIfNeeded: (action: InstructionAction, recipientAddress: Address) => {
+    recipient: `0x${string}`;
+} | {
+    recipient?: undefined;
+};
+//# sourceMappingURL=build.d.ts.map

package/dist/instructions/build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/instructions/build.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAYtE,YAAY,EACV,2BAA2B,EAC3B,2BAA2B,EAC3B,gCAAgC,EAChC,uBAAuB,GACxB,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;GASG;AAGH;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,uBAAuB,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;CACrE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,MAAM,EACN,OAAO,EACP,OAAO,EACP,aAAa,EACb,IAAI,EACJ,eAAe,GAChB,EAAE,wBAAwB,GAAG,uBAAuB,CAUpD;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,CAAC;AAEpB;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,GACjD;IAAE,IAAI,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAElC;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,gEAAgE;IAChE,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,oEAAoE;IACpE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gEAAgE;IAChE,oBAAoB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,iEAAiE;IACjE,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,qEAAqE;IACrE,oBAAoB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxC;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,SAAS,aAAa;;;CAOzD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,GAAI,SAAS,OAAO;;CAItD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kCAAkC,GAAI,SAAS,OAAO;;CAIlE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,GAAI,QAAQ,cAAc;;CAK1D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,GAC1B,QAAQ,cAAc,EACtB,QAAQ,aAAa,EACrB,WAAW,OAAO,EAClB,WAAW,oBAAoB;mBAKR,MAAM;CAc9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAI,WAAW,MAAM,GAAG,MAAM,KAAG,KAAK,MAAM,EAUxE,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,KAAK,EAAE,OAAO,CAAC;IACf,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,eAAO,MAAM,UAAU,GACrB,KAAK,aAAa,EAClB,WAAW,oBAAoB,KA0Be,MAAM,CAAC,MAAM,EAAE,OAAO,CACrE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAI,QAAQ,iBAAiB;;;;CAMhE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8CAA8C,GACzD,QAAQ,iBAAiB,EACzB,kBAAkB,OAAO;;;;CAO1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8CAA8C,GACzD,QAAQ,iBAAiB,EACzB,kBAAkB,OAAO;;;;CAK1B,CAAC"}

package/dist/instructions/constants.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Default interval used when none is provided (in seconds).
+ */
+export declare const DEFAULT_INTERVAL_SECONDS = 12;
+/**
+ * Default API timeout for instruction operations (in milliseconds).
+ */
+export declare const INSTRUCTION_DEFAULT_TIMEOUT = 30000;
+//# sourceMappingURL=constants.d.ts.map

package/dist/instructions/constants.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Default interval used when none is provided (in seconds).
+ */
+export declare const DEFAULT_INTERVAL_SECONDS = 12;
+/**
+ * Default API timeout for instruction operations (in milliseconds).
+ */
+export declare const INSTRUCTION_DEFAULT_TIMEOUT = 30000;
+//# sourceMappingURL=constants.d.ts.map

package/dist/instructions/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/instructions/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,2BAA2B,QAAQ,CAAC"}