@relayprotocol/relay-sdk 5.2.4 → 5.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/_cjs/src/version.js +1 -1
- package/_cjs/tsconfig.build.tsbuildinfo +1 -1
- package/_esm/src/version.js +1 -1
- package/_esm/tsconfig.build.tsbuildinfo +1 -1
- package/_types/src/client.d.ts +2 -2
- package/_types/src/types/api.d.ts +144 -14
- package/_types/src/types/api.d.ts.map +1 -1
- package/_types/src/version.d.ts +1 -1
- package/_types/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +1 -1
package/_types/src/client.d.ts
CHANGED
|
@@ -88,8 +88,8 @@ export declare class RelayClient {
|
|
|
88
88
|
deployContract: <const abi extends import("viem").Abi | readonly unknown[], chainOverride extends import("viem/chains").Chain | undefined>(args: import("viem").DeployContractParameters<abi, import("viem/chains").Chain | undefined, import("viem").Account | undefined, chainOverride>) => Promise<`0x${string}`>;
|
|
89
89
|
getAddresses: () => Promise<import("viem").GetAddressesReturnType>;
|
|
90
90
|
getCallsStatus: (parameters: import("viem").GetCallsStatusParameters) => Promise<{
|
|
91
|
-
id: string;
|
|
92
91
|
version: string;
|
|
92
|
+
id: string;
|
|
93
93
|
chainId: number;
|
|
94
94
|
atomic: boolean;
|
|
95
95
|
capabilities?: {
|
|
@@ -7776,8 +7776,8 @@ export declare class RelayClient {
|
|
|
7776
7776
|
}, primaryType extends string>(args: import("viem").SignTypedDataParameters<typedData, primaryType, import("viem").Account | undefined>) => Promise<`0x${string}`>;
|
|
7777
7777
|
switchChain: (args: import("viem").SwitchChainParameters) => Promise<void>;
|
|
7778
7778
|
waitForCallsStatus: (parameters: import("viem").WaitForCallsStatusParameters) => Promise<{
|
|
7779
|
-
id: string;
|
|
7780
7779
|
version: string;
|
|
7780
|
+
id: string;
|
|
7781
7781
|
chainId: number;
|
|
7782
7782
|
atomic: boolean;
|
|
7783
7783
|
capabilities?: {
|
|
@@ -439,7 +439,7 @@ export interface paths {
|
|
|
439
439
|
/** @description User address, when supplied returns user balance and max bridge amount */
|
|
440
440
|
user?: string;
|
|
441
441
|
/** @description Restricts the user balance and capacity to a particular currency when supplied with a currency id. Defaults to the native currency of the destination chain. */
|
|
442
|
-
currency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "
|
|
442
|
+
currency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd";
|
|
443
443
|
};
|
|
444
444
|
};
|
|
445
445
|
responses: {
|
|
@@ -492,7 +492,7 @@ export interface paths {
|
|
|
492
492
|
originChainId: number;
|
|
493
493
|
destinationChainId: number;
|
|
494
494
|
/** @enum {string} */
|
|
495
|
-
currency: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "
|
|
495
|
+
currency: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd";
|
|
496
496
|
/** @description Amount to bridge as the base amount (can be switched to exact input using the dedicated flag), denoted in wei */
|
|
497
497
|
amount: string;
|
|
498
498
|
/** @description App fees to be charged for execution */
|
|
@@ -596,7 +596,7 @@ export interface paths {
|
|
|
596
596
|
* @description Origin chain gas currency
|
|
597
597
|
* @enum {string}
|
|
598
598
|
*/
|
|
599
|
-
gasCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "
|
|
599
|
+
gasCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "avax" | "bnb" | "matic" | "sei" | "mnt" | "trx" | "bera" | "ip" | "s" | "lrds" | "celo" | "flow" | "ron" | "metis" | "btcn" | "core" | "sui" | "ton" | "cronos" | "hype" | "mcade" | "usd";
|
|
600
600
|
/** @description Combination of the relayerGas and relayerService to give you the full relayer fee in wei */
|
|
601
601
|
relayer?: string;
|
|
602
602
|
/** @description Destination chain gas fee in wei */
|
|
@@ -607,10 +607,10 @@ export interface paths {
|
|
|
607
607
|
* @description The currency for all relayer fees (gas and service)
|
|
608
608
|
* @enum {string}
|
|
609
609
|
*/
|
|
610
|
-
relayerCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "
|
|
610
|
+
relayerCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd";
|
|
611
611
|
app?: string;
|
|
612
612
|
/** @enum {string} */
|
|
613
|
-
appCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "
|
|
613
|
+
appCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd";
|
|
614
614
|
};
|
|
615
615
|
breakdown?: {
|
|
616
616
|
/** @description Amount that will be bridged in the estimated time */
|
|
@@ -672,7 +672,7 @@ export interface paths {
|
|
|
672
672
|
originChainId: number;
|
|
673
673
|
destinationChainId: number;
|
|
674
674
|
/** @enum {string} */
|
|
675
|
-
currency: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "
|
|
675
|
+
currency: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd";
|
|
676
676
|
/** @description Amount to bridge as the base amount (can be switched to exact input using the dedicated flag), denoted in wei */
|
|
677
677
|
amount: string;
|
|
678
678
|
/** @description App fees to be charged for execution */
|
|
@@ -1153,7 +1153,7 @@ export interface paths {
|
|
|
1153
1153
|
* @description Origin chain gas currency
|
|
1154
1154
|
* @enum {string}
|
|
1155
1155
|
*/
|
|
1156
|
-
gasCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "
|
|
1156
|
+
gasCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "avax" | "bnb" | "matic" | "sei" | "mnt" | "trx" | "bera" | "ip" | "s" | "lrds" | "celo" | "flow" | "ron" | "metis" | "btcn" | "core" | "sui" | "ton" | "cronos" | "hype" | "mcade" | "usd";
|
|
1157
1157
|
/** @description Combination of the relayerGas and relayerService to give you the full relayer fee in wei */
|
|
1158
1158
|
relayer?: string;
|
|
1159
1159
|
/** @description Destination chain gas fee in wei */
|
|
@@ -1164,10 +1164,10 @@ export interface paths {
|
|
|
1164
1164
|
* @description The currency for all relayer fees (gas and service)
|
|
1165
1165
|
* @enum {string}
|
|
1166
1166
|
*/
|
|
1167
|
-
relayerCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "
|
|
1167
|
+
relayerCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd";
|
|
1168
1168
|
app?: string;
|
|
1169
1169
|
/** @enum {string} */
|
|
1170
|
-
appCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "
|
|
1170
|
+
appCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "wbtc" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd";
|
|
1171
1171
|
};
|
|
1172
1172
|
/**
|
|
1173
1173
|
* @example {
|
|
@@ -7494,8 +7494,7 @@ export interface paths {
|
|
|
7494
7494
|
status?: string;
|
|
7495
7495
|
report?: {
|
|
7496
7496
|
version?: string;
|
|
7497
|
-
|
|
7498
|
-
[key: string]: ({
|
|
7497
|
+
[key: string]: string | ({
|
|
7499
7498
|
status?: string;
|
|
7500
7499
|
reason?: string | null;
|
|
7501
7500
|
}) | undefined;
|
|
@@ -7510,8 +7509,7 @@ export interface paths {
|
|
|
7510
7509
|
status?: string;
|
|
7511
7510
|
report?: {
|
|
7512
7511
|
version?: string;
|
|
7513
|
-
|
|
7514
|
-
[key: string]: ({
|
|
7512
|
+
[key: string]: string | ({
|
|
7515
7513
|
status?: string;
|
|
7516
7514
|
reason?: string | null;
|
|
7517
7515
|
}) | undefined;
|
|
@@ -7579,6 +7577,8 @@ export interface paths {
|
|
|
7579
7577
|
time?: number;
|
|
7580
7578
|
originChainId?: number;
|
|
7581
7579
|
destinationChainId?: number;
|
|
7580
|
+
/** @description The timestamp when the quote request was created */
|
|
7581
|
+
quoteCreatedAt?: number;
|
|
7582
7582
|
};
|
|
7583
7583
|
};
|
|
7584
7584
|
};
|
|
@@ -7609,6 +7609,8 @@ export interface paths {
|
|
|
7609
7609
|
updatedAt?: number;
|
|
7610
7610
|
originChainId?: number;
|
|
7611
7611
|
destinationChainId?: number;
|
|
7612
|
+
/** @description The timestamp when the quote request was created */
|
|
7613
|
+
quoteCreatedAt?: number;
|
|
7612
7614
|
};
|
|
7613
7615
|
};
|
|
7614
7616
|
};
|
|
@@ -7956,7 +7958,8 @@ export interface paths {
|
|
|
7956
7958
|
* "recipient": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
|
|
7957
7959
|
* "depositAddress": {
|
|
7958
7960
|
* "address": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
|
|
7959
|
-
* "depositAddressType": "open"
|
|
7961
|
+
* "depositAddressType": "open",
|
|
7962
|
+
* "depositor": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea"
|
|
7960
7963
|
* },
|
|
7961
7964
|
* "data": {
|
|
7962
7965
|
* "subsidizedRequest": false,
|
|
@@ -8022,6 +8025,7 @@ export interface paths {
|
|
|
8022
8025
|
address?: string;
|
|
8023
8026
|
/** @enum {string} */
|
|
8024
8027
|
depositAddressType?: "strict" | "open";
|
|
8028
|
+
depositor?: string | null;
|
|
8025
8029
|
}) | null;
|
|
8026
8030
|
data?: {
|
|
8027
8031
|
/** @description Slippage tolerance for the swap. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage */
|
|
@@ -9334,6 +9338,55 @@ export interface paths {
|
|
|
9334
9338
|
};
|
|
9335
9339
|
};
|
|
9336
9340
|
};
|
|
9341
|
+
/** @description Breakdown of price impact by component, with quoted and actual values */
|
|
9342
|
+
expandedPriceImpact?: {
|
|
9343
|
+
/** @description Price impact as estimated at quote time */
|
|
9344
|
+
quoted?: {
|
|
9345
|
+
/** @description Cost to execute swap or bridge depending on available liquidity. This value can be negative (representing network rewards for improving liquidity distribution) */
|
|
9346
|
+
swap?: {
|
|
9347
|
+
usd?: string;
|
|
9348
|
+
};
|
|
9349
|
+
/** @description Fees paid to cover transaction execution costs */
|
|
9350
|
+
execution?: {
|
|
9351
|
+
usd?: string;
|
|
9352
|
+
};
|
|
9353
|
+
/** @description Fees paid to the protocol */
|
|
9354
|
+
relay?: {
|
|
9355
|
+
usd?: string;
|
|
9356
|
+
};
|
|
9357
|
+
/** @description Fees paid to the app. Currency will be the same as the relayer fee currency. This needs to be claimed later by the app owner and is not immediately distributed to the app */
|
|
9358
|
+
app?: {
|
|
9359
|
+
usd?: string;
|
|
9360
|
+
};
|
|
9361
|
+
/** @description Fees paid by a sponsor for this request */
|
|
9362
|
+
sponsored?: {
|
|
9363
|
+
usd?: string;
|
|
9364
|
+
};
|
|
9365
|
+
};
|
|
9366
|
+
/** @description Price impact as computed at fill time */
|
|
9367
|
+
actual?: {
|
|
9368
|
+
/** @description Cost to execute swap or bridge depending on available liquidity. This value can be negative (representing network rewards for improving liquidity distribution) */
|
|
9369
|
+
swap?: {
|
|
9370
|
+
usd?: string;
|
|
9371
|
+
};
|
|
9372
|
+
/** @description Fees paid to cover transaction execution costs */
|
|
9373
|
+
execution?: {
|
|
9374
|
+
usd?: string;
|
|
9375
|
+
};
|
|
9376
|
+
/** @description Fees paid to the protocol */
|
|
9377
|
+
relay?: {
|
|
9378
|
+
usd?: string;
|
|
9379
|
+
};
|
|
9380
|
+
/** @description Fees paid to the app. Currency will be the same as the relayer fee currency. This needs to be claimed later by the app owner and is not immediately distributed to the app */
|
|
9381
|
+
app?: {
|
|
9382
|
+
usd?: string;
|
|
9383
|
+
};
|
|
9384
|
+
/** @description Fees paid by a sponsor for this request */
|
|
9385
|
+
sponsored?: {
|
|
9386
|
+
usd?: string;
|
|
9387
|
+
};
|
|
9388
|
+
};
|
|
9389
|
+
} | null;
|
|
9337
9390
|
paidAppFees?: {
|
|
9338
9391
|
recipient?: string;
|
|
9339
9392
|
bps?: string;
|
|
@@ -9648,6 +9701,82 @@ export interface paths {
|
|
|
9648
9701
|
status?: "success" | "failure";
|
|
9649
9702
|
})[];
|
|
9650
9703
|
};
|
|
9704
|
+
protocol?: {
|
|
9705
|
+
orderId?: string;
|
|
9706
|
+
/** @enum {string} */
|
|
9707
|
+
hubType?: "onchain";
|
|
9708
|
+
/** @description True if the deposit is recoverable via the protocol withdrawal flow. */
|
|
9709
|
+
isWithdrawable?: boolean;
|
|
9710
|
+
solver?: {
|
|
9711
|
+
address?: string;
|
|
9712
|
+
protocolChainId?: string;
|
|
9713
|
+
chainId?: number;
|
|
9714
|
+
};
|
|
9715
|
+
deposit?: {
|
|
9716
|
+
origin?: {
|
|
9717
|
+
amount?: string;
|
|
9718
|
+
chainId?: number;
|
|
9719
|
+
currency?: string;
|
|
9720
|
+
depositor?: string;
|
|
9721
|
+
depository?: string;
|
|
9722
|
+
onchainId?: string;
|
|
9723
|
+
transactionId?: string;
|
|
9724
|
+
};
|
|
9725
|
+
relay?: {
|
|
9726
|
+
amount?: string;
|
|
9727
|
+
chainId?: number;
|
|
9728
|
+
currency?: string;
|
|
9729
|
+
hash?: string;
|
|
9730
|
+
/** @enum {string} */
|
|
9731
|
+
operation?: "mint";
|
|
9732
|
+
};
|
|
9733
|
+
attestation?: {
|
|
9734
|
+
execution?: {
|
|
9735
|
+
actions?: string[];
|
|
9736
|
+
idempotencyKey?: string;
|
|
9737
|
+
};
|
|
9738
|
+
attestations?: {
|
|
9739
|
+
oracleChainId?: string;
|
|
9740
|
+
oracleContract?: string;
|
|
9741
|
+
signerAddress?: string;
|
|
9742
|
+
signature?: string;
|
|
9743
|
+
}[];
|
|
9744
|
+
};
|
|
9745
|
+
};
|
|
9746
|
+
settlement?: {
|
|
9747
|
+
destination?: {
|
|
9748
|
+
fills?: {
|
|
9749
|
+
chainId?: number;
|
|
9750
|
+
transactionId?: string;
|
|
9751
|
+
}[];
|
|
9752
|
+
refunds?: {
|
|
9753
|
+
chainId?: number;
|
|
9754
|
+
transactionId?: string;
|
|
9755
|
+
}[];
|
|
9756
|
+
};
|
|
9757
|
+
relay?: {
|
|
9758
|
+
amount?: string;
|
|
9759
|
+
chainId?: number;
|
|
9760
|
+
currency?: string;
|
|
9761
|
+
hash?: string;
|
|
9762
|
+
/** @enum {string} */
|
|
9763
|
+
operation?: "transfer" | "burn" | "mixed";
|
|
9764
|
+
solver?: string;
|
|
9765
|
+
};
|
|
9766
|
+
attestation?: {
|
|
9767
|
+
execution?: {
|
|
9768
|
+
actions?: string[];
|
|
9769
|
+
idempotencyKey?: string;
|
|
9770
|
+
};
|
|
9771
|
+
attestations?: {
|
|
9772
|
+
oracleChainId?: string;
|
|
9773
|
+
oracleContract?: string;
|
|
9774
|
+
signerAddress?: string;
|
|
9775
|
+
signature?: string;
|
|
9776
|
+
}[];
|
|
9777
|
+
};
|
|
9778
|
+
};
|
|
9779
|
+
};
|
|
9651
9780
|
orderData?: unknown;
|
|
9652
9781
|
referrer?: string;
|
|
9653
9782
|
moonpayId?: string;
|
|
@@ -9756,6 +9885,7 @@ export interface paths {
|
|
|
9756
9885
|
depositAddress: string;
|
|
9757
9886
|
sweep?: boolean;
|
|
9758
9887
|
targetChainId?: number;
|
|
9888
|
+
currency?: string;
|
|
9759
9889
|
};
|
|
9760
9890
|
};
|
|
9761
9891
|
};
|