@relayprotocol/relay-sdk 2.4.0

package/_types/src/actions/claimAppFees.d.ts

@@ -0,0 +1,21 @@
+import type { AdaptedWallet, Execute } from '../types/index.js';
+import { type WalletClient } from 'viem';
+import type { paths } from '../types/index.js';
+export type ClaimAppFeesBody = NonNullable<paths['/app-fees/{wallet}/claim']['post']['requestBody']['content']['application/json']>;
+export type ClaimAppFeesResponse = NonNullable<paths['/app-fees/{wallet}/claim']['post']['responses']['200']['content']['application/json']['steps']>;
+export type ClaimAppFeesParameters = {
+    wallet: AdaptedWallet | WalletClient;
+    chainId: number;
+    currency: string;
+    recipient?: string;
+    onProgress?: (data: any) => any;
+};
+/**
+ * Claim app fees for a wallet and execute the returned steps
+ * @param parameters - {@link ClaimAppFeesParameters}
+ */
+export declare function claimAppFees(parameters: ClaimAppFeesParameters): Promise<{
+    data: Execute;
+    abortController: AbortController;
+}>;
+//# sourceMappingURL=claimAppFees.d.ts.map

package/_types/src/actions/claimAppFees.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"claimAppFees.d.ts","sourceRoot":"","sources":["../../../src/actions/claimAppFees.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAQ/D,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,MAAM,CAAA;AAExC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAG9C,MAAM,MAAM,gBAAgB,GAAG,WAAW,CACxC,KAAK,CAAC,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CACxF,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG,WAAW,CAC5C,KAAK,CAAC,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,CACtG,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,aAAa,GAAG,YAAY,CAAA;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,CAAA;CAChC,CAAA;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAChC,UAAU,EAAE,sBAAsB,GACjC,OAAO,CAAC;IACT,IAAI,EAAE,OAAO,CAAA;IACb,eAAe,EAAE,eAAe,CAAA;CACjC,CAAC,CAyDD"}

package/_types/src/actions/execute.d.ts

@@ -0,0 +1,23 @@
+import type { AdaptedWallet, ProgressData, Execute } from '../types/index.js';
+import { type WalletClient } from 'viem';
+export type ExecuteActionParameters = {
+    quote: Execute;
+    wallet: AdaptedWallet | WalletClient;
+    depositGasLimit?: string;
+    onProgress?: (data: ProgressData) => any;
+};
+/**
+ * Execute crosschain using Relay
+ * @param data.quote A Relay quote retrieved using {@link getQuote}
+ * @param data.depositGasLimit A gas limit to use in base units (wei, etc)
+ * @param data.wallet Wallet object that adheres to the AdaptedWakket interface or a viem WalletClient
+ * @param data.onProgress Callback to update UI state as execution progresses
+ * @param abortController Optional AbortController to cancel the execution
+ */
+export declare function execute(data: ExecuteActionParameters): Promise<{
+    data: Execute;
+    abortController: AbortController;
+}> & {
+    abortController: AbortController;
+};
+//# sourceMappingURL=execute.d.ts.map

package/_types/src/actions/execute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execute.d.ts","sourceRoot":"","sources":["../../../src/actions/execute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAQ7E,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,MAAM,CAAA;AAIxC,MAAM,MAAM,uBAAuB,GAAG;IACpC,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,aAAa,GAAG,YAAY,CAAA;IACpC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,GAAG,CAAA;CACzC,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC;IAC9D,IAAI,EAAE,OAAO,CAAA;IACb,eAAe,EAAE,eAAe,CAAA;CACjC,CAAC,GAAG;IACH,eAAe,EAAE,eAAe,CAAA;CACjC,CAiGA"}

package/_types/src/actions/getAppFees.d.ts

@@ -0,0 +1,12 @@
+import type { paths } from '../types/index.js';
+export type GetAppFeeBody = NonNullable<paths['/app-fees/{wallet}/balances']['get']['parameters']['path']>;
+export type GetAppFeesResponse = NonNullable<paths['/app-fees/{wallet}/balances']['get']['responses']['200']['content']['application/json']['balances']>;
+export type GetAppFeesParameters = {
+    wallet: string;
+};
+/**
+ * Method to get app fee balances for a wallet
+ * @param parameters - {@link GetAppFeesParameters}
+ */
+export declare function getAppFees(parameters: GetAppFeesParameters): Promise<GetAppFeesResponse>;
+//# sourceMappingURL=getAppFees.d.ts.map

package/_types/src/actions/getAppFees.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAppFees.d.ts","sourceRoot":"","sources":["../../../src/actions/getAppFees.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAE9C,MAAM,MAAM,aAAa,GAAG,WAAW,CACrC,KAAK,CAAC,6BAA6B,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAClE,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAC1C,KAAK,CAAC,6BAA6B,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,CAC3G,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAC9B,UAAU,EAAE,oBAAoB,GAC/B,OAAO,CAAC,kBAAkB,CAAC,CAkB7B"}

package/_types/src/actions/getPrice.d.ts

@@ -0,0 +1,23 @@
+import { type Address } from 'viem';
+import { type SimulateContractRequest } from '../utils/index.js';
+import type { Execute, paths } from '../types/index.js';
+export type PriceBody = NonNullable<paths['/price']['post']['requestBody']['content']['application/json']>;
+export type PriceBodyOptions = Omit<PriceBody, 'destinationChainId' | 'originChainId' | 'originCurrency' | 'destinationCurrency' | 'amount' | 'recipient'>;
+export type GetPriceParameters = {
+    originChainId: number;
+    originCurrency: string;
+    destinationChainId: number;
+    destinationCurrency: string;
+    tradeType: PriceBodyOptions['tradeType'];
+    amount?: string;
+    user?: Address;
+    recipient?: Address;
+    options?: Omit<PriceBodyOptions, 'user' | 'source' | 'txs' | 'tradeType'>;
+    txs?: (NonNullable<PriceBody['txs']>[0] | SimulateContractRequest)[];
+};
+/**
+ * Method to get the price
+ * @param data - {@link GetPriceParameters}
+ */
+export declare function getPrice(parameters: GetPriceParameters): Promise<Execute>;
+//# sourceMappingURL=getPrice.d.ts.map

package/_types/src/actions/getPrice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPrice.d.ts","sourceRoot":"","sources":["../../../src/actions/getPrice.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,EAGL,KAAK,uBAAuB,EAC7B,MAAM,mBAAmB,CAAA;AAE1B,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAGvD,MAAM,MAAM,SAAS,GAAG,WAAW,CACjC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CACtE,CAAA;AACD,MAAM,MAAM,gBAAgB,GAAG,IAAI,CACjC,SAAS,EACP,oBAAoB,GACpB,eAAe,GACf,gBAAgB,GAChB,qBAAqB,GACrB,QAAQ,GACR,WAAW,CACd,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;IACtB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAA;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,WAAW,CAAC,CAAA;IACzE,GAAG,CAAC,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,uBAAuB,CAAC,EAAE,CAAA;CACrE,CAAA;AAED;;;GAGG;AACH,wBAAsB,QAAQ,CAC5B,UAAU,EAAE,kBAAkB,GAC7B,OAAO,CAAC,OAAO,CAAC,CA2DlB"}

package/_types/src/actions/getQuote.d.ts

@@ -0,0 +1,24 @@
+import { type WalletClient } from 'viem';
+import { type SimulateContractRequest } from '../utils/index.js';
+import type { AdaptedWallet, Execute, paths } from '../types/index.js';
+export type QuoteBody = NonNullable<paths['/quote']['post']['requestBody']['content']['application/json']>;
+export type QuoteBodyOptions = Omit<QuoteBody, 'destinationChainId' | 'originChainId' | 'originCurrency' | 'destinationCurrency' | 'amount' | 'recipient'>;
+export type GetQuoteParameters = {
+    chainId: number;
+    currency: string;
+    toChainId: number;
+    toCurrency: string;
+    tradeType: QuoteBodyOptions['tradeType'];
+    user?: string;
+    wallet?: AdaptedWallet | WalletClient;
+    amount?: string;
+    recipient?: string;
+    options?: Omit<Partial<QuoteBodyOptions>, 'source' | 'txs' | 'tradeType'>;
+    txs?: (NonNullable<QuoteBody['txs']>[0] | SimulateContractRequest)[];
+};
+/**
+ * Method to get a quote
+ * @param data - {@link GetQuoteParameters}
+ */
+export declare function getQuote(parameters: GetQuoteParameters, includeDefaultParameters?: boolean): Promise<Execute>;
+//# sourceMappingURL=getQuote.d.ts.map

package/_types/src/actions/getQuote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getQuote.d.ts","sourceRoot":"","sources":["../../../src/actions/getQuote.ts"],"names":[],"mappings":"AAEA,OAAO,EAAe,KAAK,YAAY,EAAE,MAAM,MAAM,CAAA;AAErD,OAAO,EAIL,KAAK,uBAAuB,EAC7B,MAAM,mBAAmB,CAAA;AAG1B,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAGtE,MAAM,MAAM,SAAS,GAAG,WAAW,CACjC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CACtE,CAAA;AACD,MAAM,MAAM,gBAAgB,GAAG,IAAI,CACjC,SAAS,EACP,oBAAoB,GACpB,eAAe,GACf,gBAAgB,GAChB,qBAAqB,GACrB,QAAQ,GACR,WAAW,CACd,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAA;IACxC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,aAAa,GAAG,YAAY,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,WAAW,CAAC,CAAA;IACzE,GAAG,CAAC,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,uBAAuB,CAAC,EAAE,CAAA;CACrE,CAAA;AAgCD;;;GAGG;AACH,wBAAsB,QAAQ,CAC5B,UAAU,EAAE,kBAAkB,EAC9B,wBAAwB,CAAC,EAAE,OAAO,GACjC,OAAO,CAAC,OAAO,CAAC,CAyFlB"}

package/_types/src/actions/getSolverCapacity.d.ts

@@ -0,0 +1,8 @@
+import type { paths } from '../types/index.js';
+import type { AxiosInstance } from 'axios';
+export type GetConfigQueryParams = Required<Pick<NonNullable<paths['/config']['get']['parameters']['query']>, 'originChainId' | 'destinationChainId'>> & Omit<NonNullable<paths['/config/v2']['get']['parameters']['query']>, 'originChainId' | 'destinationChainId'> & {
+    referrer?: string;
+};
+export type GetConfigResponse = paths['/config/v2']['get']['responses']['200']['content']['application/json'];
+export declare function getSolverCapacity(data: GetConfigQueryParams, axiosInstance?: AxiosInstance): Promise<GetConfigResponse>;
+//# sourceMappingURL=getSolverCapacity.d.ts.map

package/_types/src/actions/getSolverCapacity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getSolverCapacity.d.ts","sourceRoot":"","sources":["../../../src/actions/getSolverCapacity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAI9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAE1C,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CACzC,IAAI,CACF,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,EAC3D,eAAe,GAAG,oBAAoB,CACvC,CACF,GACC,IAAI,CACF,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,EAC9D,eAAe,GAAG,oBAAoB,CACvC,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3B,MAAM,MAAM,iBAAiB,GAC3B,KAAK,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAA;AAE/E,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,oBAAoB,EAC1B,aAAa,GAAE,aAAqB,GACnC,OAAO,CAAC,iBAAiB,CAAC,CAoB5B"}

package/_types/src/actions/index.d.ts

@@ -0,0 +1,7 @@
+export * from './execute.js';
+export * from './getQuote.js';
+export * from './getPrice.js';
+export * from './getSolverCapacity.js';
+export * from './getAppFees.js';
+export * from './claimAppFees.js';
+//# sourceMappingURL=index.d.ts.map

package/_types/src/actions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/actions/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA"}