@eco-foundation/api-schemas 0.8.0 → 0.9.0

package/dist/v1/enums.js

@@ -1,19 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.STATUS_VOCABULARY = exports.GaslessSubState = exports.GASLESS_SUB_STATES = exports.GASLESS_JOB_STATUSES = exports.StatusType = exports.STATUS_TYPES = exports.STANDARDS_BY_TARGET = exports.SubmitStandard = exports.SUBMIT_STANDARDS = exports.StepKindTolerant = exports.StepKind = exports.STEP_KINDS = exports.RelatedIntentRoleTolerant = exports.RelatedIntentRole = exports.RELATED_INTENT_ROLES = exports.ChainStatus = exports.CHAIN_STATUSES = exports.ChainEncoding = exports.CHAIN_ENCODINGS = exports.ChainType = exports.CHAIN_TYPES = exports.Visibility = exports.VISIBILITIES = exports.FeeKindTolerant = exports.FeeKind = exports.FEE_KINDS = exports.GuaranteeTolerant = exports.Guarantee = exports.GUARANTEES = exports.SwapTypeTolerant = exports.SwapType = exports.SWAP_TYPES = void 0;
+exports.STATUS_VOCABULARY = exports.GaslessSubState = exports.GASLESS_SUB_STATES = exports.GASLESS_JOB_STATUSES = exports.StatusType = exports.STATUS_TYPES = exports.STANDARDS_BY_TARGET = exports.SubmitStandard = exports.SUBMIT_STANDARDS = exports.StepTypeTolerant = exports.StepType = exports.STEP_TYPES = exports.RelatedIntentRoleTolerant = exports.RelatedIntentRole = exports.RELATED_INTENT_ROLES = exports.ChainStatus = exports.CHAIN_STATUSES = exports.ChainEncoding = exports.CHAIN_ENCODINGS = exports.ChainType = exports.CHAIN_TYPES = exports.FeeTypeTolerant = exports.FeeType = exports.FEE_TYPES = exports.QuoteTypeTolerant = exports.QuoteType = exports.QUOTE_TYPES = void 0;
 const zod_1 = require("zod");
 const primitives_1 = require("./primitives");
-exports.SWAP_TYPES = ['exact-in', 'exact-out', 'custom'];
-exports.SwapType = zod_1.z.enum(exports.SWAP_TYPES);
-exports.SwapTypeTolerant = (0, primitives_1.tolerantEnum)(exports.SWAP_TYPES);
-exports.GUARANTEES = ['atomic-or-refund', 'calls-execute-or-refund'];
-exports.Guarantee = zod_1.z.enum(exports.GUARANTEES);
-exports.GuaranteeTolerant = (0, primitives_1.tolerantEnum)(exports.GUARANTEES);
-exports.FEE_KINDS = ['gas', 'proving', 'protocol', 'gateway'];
-exports.FeeKind = zod_1.z.enum(exports.FEE_KINDS);
-exports.FeeKindTolerant = (0, primitives_1.tolerantEnum)(exports.FEE_KINDS);
-exports.VISIBILITIES = ['public', 'private'];
-exports.Visibility = zod_1.z.enum(exports.VISIBILITIES);
+exports.QUOTE_TYPES = ['exact-in', 'exact-out', 'custom'];
+exports.QuoteType = zod_1.z.enum(exports.QUOTE_TYPES);
+exports.QuoteTypeTolerant = (0, primitives_1.tolerantEnum)(exports.QUOTE_TYPES);
+exports.FEE_TYPES = ['gas', 'proving', 'protocol', 'gateway'];
+exports.FeeType = zod_1.z.enum(exports.FEE_TYPES);
+exports.FeeTypeTolerant = (0, primitives_1.tolerantEnum)(exports.FEE_TYPES);
 exports.CHAIN_TYPES = ['evm', 'svm', 'tvm'];
 exports.ChainType = zod_1.z.enum(exports.CHAIN_TYPES);
 exports.CHAIN_ENCODINGS = ['abi', 'borsh'];
@@ -23,9 +18,9 @@ exports.ChainStatus = zod_1.z.enum(exports.CHAIN_STATUSES);
 exports.RELATED_INTENT_ROLES = ['local', 'bucket-candidate', 'stitched-destination'];
 exports.RelatedIntentRole = zod_1.z.enum(exports.RELATED_INTENT_ROLES);
 exports.RelatedIntentRoleTolerant = (0, primitives_1.tolerantEnum)(exports.RELATED_INTENT_ROLES);
-exports.STEP_KINDS = ['swap', 'bridge', 'deposit', 'transfer'];
-exports.StepKind = zod_1.z.enum(exports.STEP_KINDS);
-exports.StepKindTolerant = (0, primitives_1.tolerantEnum)(exports.STEP_KINDS);
+exports.STEP_TYPES = ['swap', 'bridge', 'deposit', 'transfer'];
+exports.StepType = zod_1.z.enum(exports.STEP_TYPES);
+exports.StepTypeTolerant = (0, primitives_1.tolerantEnum)(exports.STEP_TYPES);
 exports.SUBMIT_STANDARDS = ['permit3', 'permit2', 'erc-3009', 'erc-2612'];
 exports.SubmitStandard = zod_1.z.enum(exports.SUBMIT_STANDARDS);
 exports.STANDARDS_BY_TARGET = {

package/dist/v1/enums.js.map

@@ -1 +1 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/v1/enums.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,6CAA4C;AAE/B,QAAA,UAAU,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AAC1D,QAAA,QAAQ,GAAG,OAAC,CAAC,IAAI,CAAC,kBAAU,CAAC,CAAC;AAC9B,QAAA,gBAAgB,GAAG,IAAA,yBAAY,EAAC,kBAAU,CAAC,CAAC;AAI5C,QAAA,UAAU,GAAG,CAAC,kBAAkB,EAAE,yBAAyB,CAAU,CAAC;AACtE,QAAA,SAAS,GAAG,OAAC,CAAC,IAAI,CAAC,kBAAU,CAAC,CAAC;AAC/B,QAAA,iBAAiB,GAAG,IAAA,yBAAY,EAAC,kBAAU,CAAC,CAAC;AAI7C,QAAA,SAAS,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,CAAU,CAAC;AAC/D,QAAA,OAAO,GAAG,OAAC,CAAC,IAAI,CAAC,iBAAS,CAAC,CAAC;AAC5B,QAAA,eAAe,GAAG,IAAA,yBAAY,EAAC,iBAAS,CAAC,CAAC;AAI1C,QAAA,YAAY,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAU,CAAC;AAC9C,QAAA,UAAU,GAAG,OAAC,CAAC,IAAI,CAAC,oBAAY,CAAC,CAAC;AAGlC,QAAA,WAAW,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAU,CAAC;AAC7C,QAAA,SAAS,GAAG,OAAC,CAAC,IAAI,CAAC,mBAAW,CAAC,CAAC;AAGhC,QAAA,eAAe,GAAG,CAAC,KAAK,EAAE,OAAO,CAAU,CAAC;AAC5C,QAAA,aAAa,GAAG,OAAC,CAAC,IAAI,CAAC,uBAAe,CAAC,CAAC;AAIxC,QAAA,cAAc,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAU,CAAC;AAC7C,QAAA,WAAW,GAAG,OAAC,CAAC,IAAI,CAAC,sBAAc,CAAC,CAAC;AAQrC,QAAA,oBAAoB,GAAG,CAAC,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,CAAU,CAAC;AACtF,QAAA,iBAAiB,GAAG,OAAC,CAAC,IAAI,CAAC,4BAAoB,CAAC,CAAC;AACjD,QAAA,yBAAyB,GAAG,IAAA,yBAAY,EAAC,4BAAoB,CAAC,CAAC;AAG/D,QAAA,UAAU,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAU,CAAC;AAChE,QAAA,QAAQ,GAAG,OAAC,CAAC,IAAI,CAAC,kBAAU,CAAC,CAAC;AAC9B,QAAA,gBAAgB,GAAG,IAAA,yBAAY,EAAC,kBAAU,CAAC,CAAC;AAG5C,QAAA,gBAAgB,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,CAAU,CAAC;AAC3E,QAAA,cAAc,GAAG,OAAC,CAAC,IAAI,CAAC,wBAAgB,CAAC,CAAC;AAyB1C,QAAA,mBAAmB,GAAG;IACjC,KAAK,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC;IACzC,cAAc,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;CACoB,CAAC;AAKlD,QAAA,YAAY,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,iBAAiB,CAAU,CAAC;AAC1E,QAAA,UAAU,GAAG,OAAC,CAAC,IAAI,CAAC,oBAAY,CAAC,CAAC;AAGlC,QAAA,oBAAoB,GAAG;IAClC,SAAS;IACT,YAAY;IACZ,WAAW;IACX,SAAS;IACT,QAAQ;IACR,SAAS;CACD,CAAC;AACE,QAAA,kBAAkB,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AAC9E,QAAA,eAAe,GAAG,OAAC,CAAC,IAAI,CAAC,0BAAkB,CAAC,CAAC;AAQ7C,QAAA,iBAAiB,GAAG;IAE/B,MAAM,EAAE;QACN,SAAS;QACT,QAAQ;QACR,SAAS;QACT,UAAU;QACV,YAAY;QACZ,SAAS;QACT,QAAQ;QACR,SAAS;KACV;IAOD,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,CAAC;IACpD,OAAO,EAAE,4BAAoB;IAM7B,iBAAiB,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC;CACkC,CAAC"}
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/v1/enums.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,6CAA4C;AAE/B,QAAA,WAAW,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AAC3D,QAAA,SAAS,GAAG,OAAC,CAAC,IAAI,CAAC,mBAAW,CAAC,CAAC;AAChC,QAAA,iBAAiB,GAAG,IAAA,yBAAY,EAAC,mBAAW,CAAC,CAAC;AAI9C,QAAA,SAAS,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,CAAU,CAAC;AAC/D,QAAA,OAAO,GAAG,OAAC,CAAC,IAAI,CAAC,iBAAS,CAAC,CAAC;AAC5B,QAAA,eAAe,GAAG,IAAA,yBAAY,EAAC,iBAAS,CAAC,CAAC;AAG1C,QAAA,WAAW,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAU,CAAC;AAC7C,QAAA,SAAS,GAAG,OAAC,CAAC,IAAI,CAAC,mBAAW,CAAC,CAAC;AAGhC,QAAA,eAAe,GAAG,CAAC,KAAK,EAAE,OAAO,CAAU,CAAC;AAC5C,QAAA,aAAa,GAAG,OAAC,CAAC,IAAI,CAAC,uBAAe,CAAC,CAAC;AAIxC,QAAA,cAAc,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAU,CAAC;AAC7C,QAAA,WAAW,GAAG,OAAC,CAAC,IAAI,CAAC,sBAAc,CAAC,CAAC;AAQrC,QAAA,oBAAoB,GAAG,CAAC,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,CAAU,CAAC;AACtF,QAAA,iBAAiB,GAAG,OAAC,CAAC,IAAI,CAAC,4BAAoB,CAAC,CAAC;AACjD,QAAA,yBAAyB,GAAG,IAAA,yBAAY,EAAC,4BAAoB,CAAC,CAAC;AAG/D,QAAA,UAAU,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAU,CAAC;AAChE,QAAA,QAAQ,GAAG,OAAC,CAAC,IAAI,CAAC,kBAAU,CAAC,CAAC;AAC9B,QAAA,gBAAgB,GAAG,IAAA,yBAAY,EAAC,kBAAU,CAAC,CAAC;AAG5C,QAAA,gBAAgB,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,CAAU,CAAC;AAC3E,QAAA,cAAc,GAAG,OAAC,CAAC,IAAI,CAAC,wBAAgB,CAAC,CAAC;AAyB1C,QAAA,mBAAmB,GAAG;IACjC,KAAK,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC;IACzC,cAAc,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;CACoB,CAAC;AAKlD,QAAA,YAAY,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,iBAAiB,CAAU,CAAC;AAC1E,QAAA,UAAU,GAAG,OAAC,CAAC,IAAI,CAAC,oBAAY,CAAC,CAAC;AAGlC,QAAA,oBAAoB,GAAG;IAClC,SAAS;IACT,YAAY;IACZ,WAAW;IACX,SAAS;IACT,QAAQ;IACR,SAAS;CACD,CAAC;AACE,QAAA,kBAAkB,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC;AAC9E,QAAA,eAAe,GAAG,OAAC,CAAC,IAAI,CAAC,0BAAkB,CAAC,CAAC;AAQ7C,QAAA,iBAAiB,GAAG;IAE/B,MAAM,EAAE;QACN,SAAS;QACT,QAAQ;QACR,SAAS;QACT,UAAU;QACV,YAAY;QACZ,SAAS;QACT,QAAQ;QACR,SAAS;KACV;IAOD,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,CAAC;IACpD,OAAO,EAAE,4BAAoB;IAM7B,iBAAiB,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC;CACkC,CAAC"}

package/dist/v1/types.d.ts

@@ -1,11 +1,9 @@
 export type { LegacyCodeRef, V1ErrorCode, V1ErrorDefinition } from './errors/catalog';
-export type V1SwapType = 'exact-in' | 'exact-out' | 'custom';
-export type V1Guarantee = 'atomic-or-refund' | 'calls-execute-or-refund';
-export type V1FeeKind = 'gas' | 'proving' | 'protocol' | 'gateway';
-export type V1Visibility = 'public' | 'private';
+export type V1QuoteType = 'exact-in' | 'exact-out' | 'custom';
+export type V1FeeType = 'gas' | 'proving' | 'protocol' | 'gateway';
 export type V1ChainType = 'evm' | 'svm' | 'tvm';
 export type V1RelatedIntentRole = 'local' | 'bucket-candidate' | 'stitched-destination';
-export type V1StepKind = 'swap' | 'bridge' | 'deposit' | 'transfer';
+export type V1StepType = 'swap' | 'bridge' | 'deposit' | 'transfer';
 export type V1StatusType = 'intent' | 'quote' | 'gasless' | 'deposit-address';
 export type V1GaslessSubState = 'pending' | 'submitted' | 'published' | 'failed';
 export type V1GaslessJobStatus = 'pending' | 'processing' | 'published' | 'partial' | 'failed' | 'unknown';
@@ -17,11 +15,12 @@ export type V1DestinationCall = {
     gasLimit?: string;
 };
 export type V1QuoteRequest = {
-    swapType: V1SwapType;
+    type: V1QuoteType;
     source: {
         chainId: number;
         token: string;
         amount?: string;
+        funder: string;
     };
     destination: {
         chainId: number;
@@ -30,13 +29,11 @@ export type V1QuoteRequest = {
         recipient: string;
         calls?: V1DestinationCall[];
     };
-    funder: string;
     refundRecipient?: string;
     slippage?: number;
-    dappId?: string;
+    dappId: string;
     options?: {
         deadlineSec?: number;
-        visibility?: V1Visibility;
         allQuotes?: boolean;
     };
 };
@@ -48,7 +45,7 @@ export type V1FeeToken = {
     [extension: string]: unknown;
 };
 export type V1Fee = {
-    kind: V1FeeKind;
+    type: V1FeeType;
     amount: string;
     token: V1FeeToken;
     estimate: boolean;
@@ -60,23 +57,6 @@ export type V1StepLeg = {
     amount: string;
     [extension: string]: unknown;
 };
-export type V1Step = {
-    kind: V1StepKind;
-    tool: string;
-    aggregator?: string;
-    from: V1StepLeg;
-    to: V1StepLeg;
-    fees: V1Fee[];
-    estimatedDurationSec: number;
-    [extension: string]: unknown;
-};
-export type V1RelatedIntent = {
-    role: V1RelatedIntentRole;
-    intentHash: string;
-    routeHash?: string;
-    bucketIndex?: number;
-    [extension: string]: unknown;
-};
 export type V1SolverIdentity = {
     id: string;
     name?: string;
@@ -95,14 +75,14 @@ export type V1SvmInstruction = {
     [extension: string]: unknown;
 };
 export type V1FundingTransaction = {
-    kind: 'evm';
+    type: 'evm';
     chainId: number;
     to: string;
     data: string;
     value: string;
     [k: string]: unknown;
 } | {
-    kind: 'svm';
+    type: 'svm';
     chainId: number;
     feePayer: string;
     instructions: V1SvmInstruction[];
@@ -127,7 +107,7 @@ export type V1IntentRoute = {
     portal: string;
     nativeAmount: string;
     tokens: V1IntentTokenAmount[];
-    calls: V1IntentCall[] | null;
+    calls: V1IntentCall[];
     [extension: string]: unknown;
 };
 export type V1IntentReward = {
@@ -138,6 +118,29 @@ export type V1IntentReward = {
     tokens: V1IntentTokenAmount[];
     [extension: string]: unknown;
 };
+export type V1StepIntent = {
+    role: V1RelatedIntentRole;
+    intentHash: string;
+    routeHash?: string;
+    bucketIndex?: number;
+    intent: {
+        route: V1IntentRoute;
+        reward: V1IntentReward;
+        [extension: string]: unknown;
+    };
+    [extension: string]: unknown;
+};
+export type V1Step = {
+    type: V1StepType;
+    provider: string;
+    aggregator?: string;
+    from: V1StepLeg;
+    to: V1StepLeg;
+    fees: V1Fee[];
+    estimatedDurationSec: number;
+    intents: V1StepIntent[];
+    [extension: string]: unknown;
+};
 export type V1Execution = {
     transaction: V1FundingTransaction;
     intent: {
@@ -145,20 +148,17 @@ export type V1Execution = {
         reward: V1IntentReward;
         [extension: string]: unknown;
     };
-    encodedRoute: string | null;
-    encodedReward: string | null;
     vault?: string | null;
     [extension: string]: unknown;
 };
 export type V1QuoteCore = {
     id: string;
-    swapType: V1SwapType;
-    visibility: V1Visibility;
-    guarantee: V1Guarantee;
+    type: V1QuoteType;
     source: {
         chainId: number;
         token: string;
         amount: string;
+        funder: string;
         symbol: string | null;
         decimals: number | null;
         [extension: string]: unknown;
@@ -166,7 +166,7 @@ export type V1QuoteCore = {
     destination: {
         chainId: number;
         token: string;
-        amount: string;
+        amountOut: string;
         minAmountOut: string;
         recipient: string | null;
         symbol: string | null;
@@ -176,7 +176,6 @@ export type V1QuoteCore = {
     slippage: number;
     fees: V1Fee[];
     steps: V1Step[];
-    relatedIntents: V1RelatedIntent[];
     solver: V1SolverIdentity;
     intentHash: string | null;
     execution: V1Execution | null;
@@ -226,6 +225,7 @@ export type V1StatusTxDetail = {
 };
 export type V1StatusStep = {
     type: V1StatusStepType;
+    intentHash: string;
     status: string;
     from: V1StatusTokenAmount;
     to: V1StatusTokenAmount;
@@ -276,21 +276,21 @@ export type V1TokenEntry = {
     };
     [extension: string]: unknown;
 };
-export type V1DepositAddressKind = 'solana' | 'gateway' | 'gateway-erc20';
+export type V1DepositAddressType = 'solana' | 'gateway' | 'gateway-erc20';
 export type V1DepositAddressCreateRequest = {
     chainId: number;
     depositor: string;
-    kind: 'solana';
+    type: 'solana';
     destinationAddress: string;
 } | {
     chainId: number;
     depositor: string;
-    kind: 'gateway';
+    type: 'gateway';
     destinationAddress: string;
 } | {
     chainId: number;
     depositor: string;
-    kind: 'gateway-erc20';
+    type: 'gateway-erc20';
     destinationAddress: string;
     destinationChainId: number;
 };
@@ -299,7 +299,7 @@ export type V1DepositAddress = {
     depositAddress: string;
     chainId: number;
     depositor: string;
-    kind: V1DepositAddressKind;
+    type: V1DepositAddressType;
     destinationAddress: string;
     destinationChainId?: number;
     expiresAt: number | null;