@hyperlane-xyz/sdk 19.5.0 → 19.6.0

package/dist/fee/types.d.ts

@@ -0,0 +1,386 @@
+import { z } from 'zod';
+export declare enum OnchainTokenFeeType {
+    LinearFee = 1,
+    RegressiveFee = 2,
+    ProgressiveFee = 3,
+    RoutingFee = 4
+}
+export declare enum TokenFeeType {
+    LinearFee = "LinearFee",
+    ProgressiveFee = "ProgressiveFee",
+    RegressiveFee = "RegressiveFee",
+    RoutingFee = "RoutingFee"
+}
+export declare const ImmutableTokenFeeType: readonly [TokenFeeType.LinearFee, TokenFeeType.RegressiveFee, TokenFeeType.ProgressiveFee];
+export declare const onChainTypeToTokenFeeTypeMap: Record<OnchainTokenFeeType, TokenFeeType>;
+export declare const BaseFeeConfigSchema: z.ZodObject<{
+    token: z.ZodString;
+    owner: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    owner: string;
+    token: string;
+}, {
+    owner: string;
+    token: string;
+}>;
+export type BaseTokenFeeConfig = z.infer<typeof BaseFeeConfigSchema>;
+export declare const FeeParametersSchema: z.ZodObject<{
+    maxFee: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    halfAmount: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+}, "strip", z.ZodTypeAny, {
+    maxFee: bigint;
+    halfAmount: bigint;
+}, {
+    maxFee: string | number | bigint;
+    halfAmount: string | number | bigint;
+}>;
+export type FeeParameters = z.infer<typeof FeeParametersSchema>;
+export declare const LinearFeeConfigSchema: z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    halfAmount: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    type: z.ZodLiteral<TokenFeeType.LinearFee>;
+    bps: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee: bigint;
+    halfAmount: bigint;
+    bps: bigint;
+}, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee: string | number | bigint;
+    halfAmount: string | number | bigint;
+    bps: string | number | bigint;
+}>;
+export type LinearFeeConfig = z.infer<typeof LinearFeeConfigSchema>;
+export declare const LinearFeeInputConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+    halfAmount: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+    type: z.ZodLiteral<TokenFeeType.LinearFee>;
+    bps: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: bigint | undefined;
+    halfAmount?: bigint | undefined;
+    bps?: bigint | undefined;
+}, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: string | number | bigint | undefined;
+    halfAmount?: string | number | bigint | undefined;
+    bps?: string | number | bigint | undefined;
+}>, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: bigint | undefined;
+    halfAmount?: bigint | undefined;
+    bps?: bigint | undefined;
+}, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: string | number | bigint | undefined;
+    halfAmount?: string | number | bigint | undefined;
+    bps?: string | number | bigint | undefined;
+}>, {
+    bps: bigint;
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: bigint | undefined;
+    halfAmount?: bigint | undefined;
+}, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: string | number | bigint | undefined;
+    halfAmount?: string | number | bigint | undefined;
+    bps?: string | number | bigint | undefined;
+}>;
+export type LinearFeeInputConfig = z.infer<typeof LinearFeeInputConfigSchema>;
+export declare const ProgressiveFeeConfigSchema: z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    halfAmount: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    type: z.ZodLiteral<TokenFeeType.ProgressiveFee>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.ProgressiveFee;
+    owner: string;
+    token: string;
+    maxFee: bigint;
+    halfAmount: bigint;
+}, {
+    type: TokenFeeType.ProgressiveFee;
+    owner: string;
+    token: string;
+    maxFee: string | number | bigint;
+    halfAmount: string | number | bigint;
+}>;
+export type ProgressiveFeeConfig = z.infer<typeof ProgressiveFeeConfigSchema>;
+export declare const RegressiveFeeConfigSchema: z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    halfAmount: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    type: z.ZodLiteral<TokenFeeType.RegressiveFee>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.RegressiveFee;
+    owner: string;
+    token: string;
+    maxFee: bigint;
+    halfAmount: bigint;
+}, {
+    type: TokenFeeType.RegressiveFee;
+    owner: string;
+    token: string;
+    maxFee: string | number | bigint;
+    halfAmount: string | number | bigint;
+}>;
+export type RegressiveFeeConfig = z.infer<typeof RegressiveFeeConfigSchema>;
+export declare const RoutingFeeConfigSchema: z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    type: z.ZodLiteral<TokenFeeType.RoutingFee>;
+    feeContracts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodType<any, z.ZodTypeDef, any>>>>;
+    maxFee: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+    halfAmount: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.RoutingFee;
+    owner: string;
+    token: string;
+    feeContracts?: Record<string, any> | undefined;
+    maxFee?: bigint | undefined;
+    halfAmount?: bigint | undefined;
+}, {
+    type: TokenFeeType.RoutingFee;
+    owner: string;
+    token: string;
+    feeContracts?: Record<string, any> | undefined;
+    maxFee?: string | number | bigint | undefined;
+    halfAmount?: string | number | bigint | undefined;
+}>;
+export type RoutingFeeConfig = z.infer<typeof RoutingFeeConfigSchema>;
+export declare const RoutingFeeInputConfigSchema: z.ZodObject<{
+    type: z.ZodLiteral<TokenFeeType.RoutingFee>;
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+    halfAmount: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+    feeContracts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodType<any, z.ZodTypeDef, any>>>>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.RoutingFee;
+    owner: string;
+    token: string;
+    maxFee?: bigint | undefined;
+    halfAmount?: bigint | undefined;
+    feeContracts?: Record<string, any> | undefined;
+}, {
+    type: TokenFeeType.RoutingFee;
+    owner: string;
+    token: string;
+    maxFee?: string | number | bigint | undefined;
+    halfAmount?: string | number | bigint | undefined;
+    feeContracts?: Record<string, any> | undefined;
+}>;
+export type RoutingFeeInputConfig = z.infer<typeof RoutingFeeInputConfigSchema>;
+export declare const TokenFeeConfigSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    halfAmount: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    type: z.ZodLiteral<TokenFeeType.LinearFee>;
+    bps: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee: bigint;
+    halfAmount: bigint;
+    bps: bigint;
+}, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee: string | number | bigint;
+    halfAmount: string | number | bigint;
+    bps: string | number | bigint;
+}>, z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    halfAmount: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    type: z.ZodLiteral<TokenFeeType.ProgressiveFee>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.ProgressiveFee;
+    owner: string;
+    token: string;
+    maxFee: bigint;
+    halfAmount: bigint;
+}, {
+    type: TokenFeeType.ProgressiveFee;
+    owner: string;
+    token: string;
+    maxFee: string | number | bigint;
+    halfAmount: string | number | bigint;
+}>, z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    halfAmount: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    type: z.ZodLiteral<TokenFeeType.RegressiveFee>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.RegressiveFee;
+    owner: string;
+    token: string;
+    maxFee: bigint;
+    halfAmount: bigint;
+}, {
+    type: TokenFeeType.RegressiveFee;
+    owner: string;
+    token: string;
+    maxFee: string | number | bigint;
+    halfAmount: string | number | bigint;
+}>, z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    type: z.ZodLiteral<TokenFeeType.RoutingFee>;
+    feeContracts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodType<any, z.ZodTypeDef, any>>>>;
+    maxFee: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+    halfAmount: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.RoutingFee;
+    owner: string;
+    token: string;
+    feeContracts?: Record<string, any> | undefined;
+    maxFee?: bigint | undefined;
+    halfAmount?: bigint | undefined;
+}, {
+    type: TokenFeeType.RoutingFee;
+    owner: string;
+    token: string;
+    feeContracts?: Record<string, any> | undefined;
+    maxFee?: string | number | bigint | undefined;
+    halfAmount?: string | number | bigint | undefined;
+}>]>;
+export type TokenFeeConfig = z.infer<typeof TokenFeeConfigSchema>;
+export declare const TokenFeeConfigInputSchema: z.ZodUnion<[z.ZodEffects<z.ZodEffects<z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+    halfAmount: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+    type: z.ZodLiteral<TokenFeeType.LinearFee>;
+    bps: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: bigint | undefined;
+    halfAmount?: bigint | undefined;
+    bps?: bigint | undefined;
+}, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: string | number | bigint | undefined;
+    halfAmount?: string | number | bigint | undefined;
+    bps?: string | number | bigint | undefined;
+}>, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: bigint | undefined;
+    halfAmount?: bigint | undefined;
+    bps?: bigint | undefined;
+}, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: string | number | bigint | undefined;
+    halfAmount?: string | number | bigint | undefined;
+    bps?: string | number | bigint | undefined;
+}>, {
+    bps: bigint;
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: bigint | undefined;
+    halfAmount?: bigint | undefined;
+}, {
+    type: TokenFeeType.LinearFee;
+    owner: string;
+    token: string;
+    maxFee?: string | number | bigint | undefined;
+    halfAmount?: string | number | bigint | undefined;
+    bps?: string | number | bigint | undefined;
+}>, z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    halfAmount: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    type: z.ZodLiteral<TokenFeeType.ProgressiveFee>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.ProgressiveFee;
+    owner: string;
+    token: string;
+    maxFee: bigint;
+    halfAmount: bigint;
+}, {
+    type: TokenFeeType.ProgressiveFee;
+    owner: string;
+    token: string;
+    maxFee: string | number | bigint;
+    halfAmount: string | number | bigint;
+}>, z.ZodObject<{
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    halfAmount: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>;
+    type: z.ZodLiteral<TokenFeeType.RegressiveFee>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.RegressiveFee;
+    owner: string;
+    token: string;
+    maxFee: bigint;
+    halfAmount: bigint;
+}, {
+    type: TokenFeeType.RegressiveFee;
+    owner: string;
+    token: string;
+    maxFee: string | number | bigint;
+    halfAmount: string | number | bigint;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<TokenFeeType.RoutingFee>;
+    owner: z.ZodString;
+    token: z.ZodString;
+    maxFee: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+    halfAmount: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, bigint, string | number | bigint>>;
+    feeContracts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodType<any, z.ZodTypeDef, any>>>>;
+}, "strip", z.ZodTypeAny, {
+    type: TokenFeeType.RoutingFee;
+    owner: string;
+    token: string;
+    maxFee?: bigint | undefined;
+    halfAmount?: bigint | undefined;
+    feeContracts?: Record<string, any> | undefined;
+}, {
+    type: TokenFeeType.RoutingFee;
+    owner: string;
+    token: string;
+    maxFee?: string | number | bigint | undefined;
+    halfAmount?: string | number | bigint | undefined;
+    feeContracts?: Record<string, any> | undefined;
+}>]>;
+export type TokenFeeConfigInput = z.infer<typeof TokenFeeConfigInputSchema>;
+//# sourceMappingURL=types.d.ts.map

package/dist/fee/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/fee/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAWxB,oBAAY,mBAAmB;IAC7B,SAAS,IAAI;IACb,aAAa,IAAI;IACjB,cAAc,IAAI;IAClB,UAAU,IAAI;CACf;AAED,oBAAY,YAAY;IACtB,SAAS,cAAc;IACvB,cAAc,mBAAmB;IACjC,aAAa,kBAAkB;IAC/B,UAAU,eAAe;CAC1B;AAED,eAAO,MAAM,qBAAqB,4FAIxB,CAAC;AAGX,eAAO,MAAM,4BAA4B,EAAE,MAAM,CAC/C,mBAAmB,EACnB,YAAY,CAMb,CAAC;AAIF,eAAO,MAAM,mBAAmB;;;;;;;;;EAG9B,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAErE,eAAO,MAAM,mBAAmB;;;;;;;;;EAG9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAOhE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;EAGhC,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAGpE,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2BlC,CAAC;AACN,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;EAErC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;EAEpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;EAUjC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;EAOtC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAIhF,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAK/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAKpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC"}

package/dist/fee/types.js

@@ -0,0 +1,107 @@
+import { z } from 'zod';
+import { ZBigNumberish, ZChainName, ZHash, } from '../metadata/customZodTypes.js';
+import { convertToBps } from './utils.js';
+// Matches the enum in BaseFee.sol
+export var OnchainTokenFeeType;
+(function (OnchainTokenFeeType) {
+    OnchainTokenFeeType[OnchainTokenFeeType["LinearFee"] = 1] = "LinearFee";
+    OnchainTokenFeeType[OnchainTokenFeeType["RegressiveFee"] = 2] = "RegressiveFee";
+    OnchainTokenFeeType[OnchainTokenFeeType["ProgressiveFee"] = 3] = "ProgressiveFee";
+    OnchainTokenFeeType[OnchainTokenFeeType["RoutingFee"] = 4] = "RoutingFee";
+})(OnchainTokenFeeType || (OnchainTokenFeeType = {}));
+export var TokenFeeType;
+(function (TokenFeeType) {
+    TokenFeeType["LinearFee"] = "LinearFee";
+    TokenFeeType["ProgressiveFee"] = "ProgressiveFee";
+    TokenFeeType["RegressiveFee"] = "RegressiveFee";
+    TokenFeeType["RoutingFee"] = "RoutingFee";
+})(TokenFeeType || (TokenFeeType = {}));
+export const ImmutableTokenFeeType = [
+    TokenFeeType.LinearFee,
+    TokenFeeType.RegressiveFee,
+    TokenFeeType.ProgressiveFee,
+];
+// Mapping between the on-chain token fee type (uint) and the token fee type (string)
+export const onChainTypeToTokenFeeTypeMap = {
+    [OnchainTokenFeeType.LinearFee]: TokenFeeType.LinearFee,
+    [OnchainTokenFeeType.RegressiveFee]: TokenFeeType.RegressiveFee,
+    [OnchainTokenFeeType.ProgressiveFee]: TokenFeeType.ProgressiveFee,
+    [OnchainTokenFeeType.RoutingFee]: TokenFeeType.RoutingFee,
+};
+// ====== SHARED SCHEMAS ======
+export const BaseFeeConfigSchema = z.object({
+    token: ZHash,
+    owner: ZHash,
+});
+export const FeeParametersSchema = z.object({
+    maxFee: ZBigNumberish,
+    halfAmount: ZBigNumberish,
+});
+const StandardFeeConfigBaseSchema = BaseFeeConfigSchema.merge(FeeParametersSchema);
+// ====== INDIVIDUAL FEE SCHEMAS ======
+export const LinearFeeConfigSchema = StandardFeeConfigBaseSchema.extend({
+    type: z.literal(TokenFeeType.LinearFee),
+    bps: ZBigNumberish,
+});
+// Linear Fee Input - only requires bps & type
+export const LinearFeeInputConfigSchema = BaseFeeConfigSchema.extend({
+    type: z.literal(TokenFeeType.LinearFee),
+    bps: ZBigNumberish.optional(),
+    ...FeeParametersSchema.partial().shape,
+})
+    .superRefine((v, ctx) => {
+    const hasBps = v.bps !== undefined;
+    const hasFeeParams = v.maxFee !== undefined && v.halfAmount !== undefined;
+    if (!hasBps && !hasFeeParams) {
+        ctx.addIssue({
+            code: 'custom',
+            path: ['bps'],
+            message: 'Provide bps or both maxFee and halfAmount',
+        });
+    }
+    if (v.halfAmount === 0n) {
+        // Prevents divide by 0
+        ctx.addIssue({
+            code: 'custom',
+            path: ['halfAmount'],
+            message: 'halfAmount must be > 0',
+        });
+    }
+})
+    .transform((v) => ({
+    ...v,
+    bps: v.bps ?? convertToBps(v.maxFee, v.halfAmount),
+}));
+export const ProgressiveFeeConfigSchema = StandardFeeConfigBaseSchema.extend({
+    type: z.literal(TokenFeeType.ProgressiveFee),
+});
+export const RegressiveFeeConfigSchema = StandardFeeConfigBaseSchema.extend({
+    type: z.literal(TokenFeeType.RegressiveFee),
+});
+export const RoutingFeeConfigSchema = BaseFeeConfigSchema.extend({
+    type: z.literal(TokenFeeType.RoutingFee),
+    feeContracts: z
+        .record(ZChainName, z.lazy(() => TokenFeeConfigSchema))
+        .optional(), // Destination -> Fee
+    maxFee: ZBigNumberish.optional(),
+    halfAmount: ZBigNumberish.optional(),
+});
+export const RoutingFeeInputConfigSchema = RoutingFeeConfigSchema.extend({
+    feeContracts: z
+        .record(ZChainName, z.lazy(() => TokenFeeConfigInputSchema))
+        .optional(), // Destination -> Fee
+});
+// ====== UNION SCHEMAS ======
+export const TokenFeeConfigSchema = z.discriminatedUnion('type', [
+    LinearFeeConfigSchema,
+    ProgressiveFeeConfigSchema,
+    RegressiveFeeConfigSchema,
+    RoutingFeeConfigSchema,
+]);
+export const TokenFeeConfigInputSchema = z.union([
+    LinearFeeInputConfigSchema,
+    ProgressiveFeeConfigSchema,
+    RegressiveFeeConfigSchema,
+    RoutingFeeInputConfigSchema,
+]);
+//# sourceMappingURL=types.js.map

package/dist/fee/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/fee/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,aAAa,EACb,UAAU,EACV,KAAK,GACN,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,kCAAkC;AAClC,MAAM,CAAN,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,uEAAa,CAAA;IACb,+EAAiB,CAAA;IACjB,iFAAkB,CAAA;IAClB,yEAAc,CAAA;AAChB,CAAC,EALW,mBAAmB,KAAnB,mBAAmB,QAK9B;AAED,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,+CAA+B,CAAA;IAC/B,yCAAyB,CAAA;AAC3B,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,YAAY,CAAC,SAAS;IACtB,YAAY,CAAC,aAAa;IAC1B,YAAY,CAAC,cAAc;CACnB,CAAC;AAEX,qFAAqF;AACrF,MAAM,CAAC,MAAM,4BAA4B,GAGrC;IACF,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS;IACvD,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,YAAY,CAAC,aAAa;IAC/D,CAAC,mBAAmB,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC,cAAc;IACjE,CAAC,mBAAmB,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,UAAU;CAC1D,CAAC;AAEF,+BAA+B;AAE/B,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,KAAK,EAAE,KAAK;IACZ,KAAK,EAAE,KAAK;CACb,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,MAAM,EAAE,aAAa;IACrB,UAAU,EAAE,aAAa;CAC1B,CAAC,CAAC;AAGH,MAAM,2BAA2B,GAC/B,mBAAmB,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjD,uCAAuC;AAEvC,MAAM,CAAC,MAAM,qBAAqB,GAAG,2BAA2B,CAAC,MAAM,CAAC;IACtE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC;IACvC,GAAG,EAAE,aAAa;CACnB,CAAC,CAAC;AAGH,8CAA8C;AAC9C,MAAM,CAAC,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,MAAM,CAAC;IACnE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC;IACvC,GAAG,EAAE,aAAa,CAAC,QAAQ,EAAE;IAC7B,GAAG,mBAAmB,CAAC,OAAO,EAAE,CAAC,KAAK;CACvC,CAAC;KACC,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;IACtB,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC;IACnC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,UAAU,KAAK,SAAS,CAAC;IAC1E,IAAI,CAAC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC7B,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,KAAK,CAAC;YACb,OAAO,EAAE,2CAA2C;SACrD,CAAC,CAAC;IACL,CAAC;IACD,IAAI,CAAC,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;QACxB,uBAAuB;QACvB,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,YAAY,CAAC;YACpB,OAAO,EAAE,wBAAwB;SAClC,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC;KACD,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACjB,GAAG,CAAC;IACJ,GAAG,EAAE,CAAC,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,MAAO,EAAE,CAAC,CAAC,UAAW,CAAC;CACrD,CAAC,CAAC,CAAC;AAGN,MAAM,CAAC,MAAM,0BAA0B,GAAG,2BAA2B,CAAC,MAAM,CAAC;IAC3E,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC;CAC7C,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,2BAA2B,CAAC,MAAM,CAAC;IAC1E,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC;CAC5C,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,sBAAsB,GAAG,mBAAmB,CAAC,MAAM,CAAC;IAC/D,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC;IACxC,YAAY,EAAE,CAAC;SACZ,MAAM,CACL,UAAU,EACV,CAAC,CAAC,IAAI,CAAC,GAAgB,EAAE,CAAC,oBAAoB,CAAC,CAChD;SACA,QAAQ,EAAE,EAAE,qBAAqB;IACpC,MAAM,EAAE,aAAa,CAAC,QAAQ,EAAE;IAChC,UAAU,EAAE,aAAa,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,2BAA2B,GAAG,sBAAsB,CAAC,MAAM,CAAC;IACvE,YAAY,EAAE,CAAC;SACZ,MAAM,CACL,UAAU,EACV,CAAC,CAAC,IAAI,CAAC,GAAgB,EAAE,CAAC,yBAAyB,CAAC,CACrD;SACA,QAAQ,EAAE,EAAE,qBAAqB;CACrC,CAAC,CAAC;AAGH,8BAA8B;AAE9B,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC/D,qBAAqB;IACrB,0BAA0B;IAC1B,yBAAyB;IACzB,sBAAsB;CACvB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC;IAC/C,0BAA0B;IAC1B,0BAA0B;IAC1B,yBAAyB;IACzB,2BAA2B;CAC5B,CAAC,CAAC"}

package/dist/fee/utils.d.ts

@@ -0,0 +1,10 @@
+export declare const MAX_BPS = 10000n;
+/**
+ * Converts fee parameters to basis points (BPS)
+ * @param maxFee - Maximum fee amount
+ * @param halfAmount - Half of the amount at which maxFee is applied
+ * @returns Fee in basis points
+ * @throws Error if halfAmount is zero to prevent division by zero
+ */
+export declare function convertToBps(maxFee: bigint, halfAmount: bigint): bigint;
+//# sourceMappingURL=utils.d.ts.map

package/dist/fee/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/fee/utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,SAAU,CAAC;AAE/B;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAOvE"}

package/dist/fee/utils.js

@@ -0,0 +1,16 @@
+export const MAX_BPS = 10000n; // 100% in bps
+/**
+ * Converts fee parameters to basis points (BPS)
+ * @param maxFee - Maximum fee amount
+ * @param halfAmount - Half of the amount at which maxFee is applied
+ * @returns Fee in basis points
+ * @throws Error if halfAmount is zero to prevent division by zero
+ */
+export function convertToBps(maxFee, halfAmount) {
+    if (halfAmount === 0n) {
+        throw new Error('halfAmount must be > 0 to prevent division by zero');
+    }
+    const bps = (maxFee * MAX_BPS) / (halfAmount * 2n);
+    return bps;
+}
+//# sourceMappingURL=utils.js.map

package/dist/fee/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/fee/utils.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,MAAO,CAAC,CAAC,cAAc;AAE9C;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,UAAkB;IAC7D,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;IACnD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/fork/types.d.ts

@@ -905,8 +905,8 @@ export declare const RawForkedChainTransactionConfigSchema: z.ZodDiscriminatedUn
         } | undefined;
     }>>>;
 }, "strip", z.ZodTypeAny, {
-    type: TransactionConfigType.FILE;
     path: string;
+    type: TransactionConfigType.FILE;
     defaultSender: string;
     overrides: Record<string, {
         annotation?: string | undefined;
@@ -939,8 +939,8 @@ export declare const RawForkedChainTransactionConfigSchema: z.ZodDiscriminatedUn
         } | undefined;
     }>;
 }, {
-    type: TransactionConfigType.FILE;
     path: string;
+    type: TransactionConfigType.FILE;
     defaultSender: string;
     overrides?: Record<string, {
         annotation?: string | undefined;
@@ -1303,8 +1303,8 @@ export declare const RawForkedChainConfigSchema: z.ZodObject<{
             } | undefined;
         }>>>;
     }, "strip", z.ZodTypeAny, {
-        type: TransactionConfigType.FILE;
         path: string;
+        type: TransactionConfigType.FILE;
         defaultSender: string;
         overrides: Record<string, {
             annotation?: string | undefined;
@@ -1337,8 +1337,8 @@ export declare const RawForkedChainConfigSchema: z.ZodObject<{
             } | undefined;
         }>;
     }, {
-        type: TransactionConfigType.FILE;
         path: string;
+        type: TransactionConfigType.FILE;
         defaultSender: string;
         overrides?: Record<string, {
             annotation?: string | undefined;
@@ -1405,8 +1405,8 @@ export declare const RawForkedChainConfigSchema: z.ZodObject<{
             } | undefined;
         }[];
     } | {
-        type: TransactionConfigType.FILE;
         path: string;
+        type: TransactionConfigType.FILE;
         defaultSender: string;
         overrides: Record<string, {
             annotation?: string | undefined;
@@ -1474,8 +1474,8 @@ export declare const RawForkedChainConfigSchema: z.ZodObject<{
             } | undefined;
         }[];
     } | {
-        type: TransactionConfigType.FILE;
         path: string;
+        type: TransactionConfigType.FILE;
         defaultSender: string;
         overrides?: Record<string, {
             annotation?: string | undefined;
@@ -1840,8 +1840,8 @@ export declare const RawForkedChainConfigByChainSchema: z.ZodRecord<z.ZodString,
             } | undefined;
         }>>>;
     }, "strip", z.ZodTypeAny, {
-        type: TransactionConfigType.FILE;
         path: string;
+        type: TransactionConfigType.FILE;
         defaultSender: string;
         overrides: Record<string, {
             annotation?: string | undefined;
@@ -1874,8 +1874,8 @@ export declare const RawForkedChainConfigByChainSchema: z.ZodRecord<z.ZodString,
             } | undefined;
         }>;
     }, {
-        type: TransactionConfigType.FILE;
         path: string;
+        type: TransactionConfigType.FILE;
         defaultSender: string;
         overrides?: Record<string, {
             annotation?: string | undefined;
@@ -1942,8 +1942,8 @@ export declare const RawForkedChainConfigByChainSchema: z.ZodRecord<z.ZodString,
             } | undefined;
         }[];
     } | {
-        type: TransactionConfigType.FILE;
         path: string;
+        type: TransactionConfigType.FILE;
         defaultSender: string;
         overrides: Record<string, {
             annotation?: string | undefined;
@@ -2011,8 +2011,8 @@ export declare const RawForkedChainConfigByChainSchema: z.ZodRecord<z.ZodString,
             } | undefined;
         }[];
     } | {
-        type: TransactionConfigType.FILE;
         path: string;
+        type: TransactionConfigType.FILE;
         defaultSender: string;
         overrides?: Record<string, {
             annotation?: string | undefined;
@@ -2052,32 +2052,32 @@ export declare const SafeTxFileSchema: z.ZodObject<{
     version: z.ZodString;
     chainId: z.ZodString;
     transactions: z.ZodArray<z.ZodObject<{
-        to: z.ZodOptional<z.ZodString>;
         value: z.ZodOptional<z.ZodString>;
+        to: z.ZodOptional<z.ZodString>;
         data: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        to?: string | undefined;
         value?: string | undefined;
+        to?: string | undefined;
         data?: string | undefined;
     }, {
-        to?: string | undefined;
         value?: string | undefined;
+        to?: string | undefined;
         data?: string | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     chainId: string;
     version: string;
     transactions: {
-        to?: string | undefined;
         value?: string | undefined;
+        to?: string | undefined;
         data?: string | undefined;
     }[];
 }, {
     chainId: string;
     version: string;
     transactions: {
-        to?: string | undefined;
         value?: string | undefined;
+        to?: string | undefined;
         data?: string | undefined;
     }[];
 }>;