@0xsequence/api 2.3.8 → 2.3.10

package/dist/declarations/src/api.gen.d.ts

@@ -1,8 +1,8 @@
 export declare const WebrpcHeader = "Webrpc";
-export declare const WebrpcHeaderValue = "webrpc@v0.24.0;gen-typescript@v0.16.3;sequence-api@v0.4.0";
+export declare const WebrpcHeaderValue = "webrpc@v0.25.3;gen-typescript@v0.17.0;sequence-api@v0.4.0";
 export declare const WebRPCVersion = "v1";
 export declare const WebRPCSchemaVersion = "v0.4.0";
-export declare const WebRPCSchemaHash = "2409c101bc62a1b7aa797e099d913b1c4046e9f6";
+export declare const WebRPCSchemaHash = "fce15c8cb22b7e081fc97615dbf78baf9d718749";
 type WebrpcGenVersions = {
     webrpcGenVersion: string;
     codeGenName: string;
@@ -343,31 +343,33 @@ export interface SardinePaymentOption {
     subType: string;
     processingTime: string;
 }
-export interface SwapPermit2Price {
-    currencyAddress: string;
-    currencyBalance: string;
-    price: string;
-    maxPrice: string;
-    transactionValue: string;
+export interface LifiToken {
+    chainId: number;
+    address: string;
+    symbol: string;
+    name: string;
+    decimals: number;
+    priceUsd: string;
+    coinKey: string;
+    logoUri: string;
 }
-export interface SwapPermit2Quote {
-    currencyAddress: string;
-    currencyBalance: string;
-    price: string;
-    maxPrice: string;
-    to: string;
-    transactionData: string;
-    transactionValue: string;
-    approveData: string;
+export interface LifiSwapRoute {
+    fromChainId: number;
+    toChainId: number;
+    fromTokens: Array<LifiToken>;
+    toTokens: Array<LifiToken>;
 }
-export interface SwapPrice {
-    currencyAddress: string;
-    currencyBalance: string;
-    price: string;
-    maxPrice: string;
-    transactionValue: string;
+export interface GetLifiSwapQuoteParams {
+    chainId: number;
+    walletAddress: string;
+    fromTokenAddress: string;
+    toTokenAddress: string;
+    fromTokenAmount: string;
+    toTokenAmount: string;
+    includeApprove: boolean;
+    slippageBps: number;
 }
-export interface SwapQuote {
+export interface LifiSwapQuote {
     currencyAddress: string;
     currencyBalance: string;
     price: string;
@@ -376,6 +378,8 @@ export interface SwapQuote {
     transactionData: string;
     transactionValue: string;
     approveData: string;
+    amount: string;
+    amountMin: string;
 }
 export interface CurrencyGroup {
     name: string;
@@ -578,31 +582,69 @@ export interface TransakChain {
     chainId: number;
 }
 export interface API {
+    /**
+     *
+     * Runtime
+     *
+     */
     ping(headers?: object, signal?: AbortSignal): Promise<PingReturn>;
     version(headers?: object, signal?: AbortSignal): Promise<VersionReturn>;
     runtimeStatus(headers?: object, signal?: AbortSignal): Promise<RuntimeStatusReturn>;
     clock(headers?: object, signal?: AbortSignal): Promise<ClockReturn>;
     getSequenceContext(headers?: object, signal?: AbortSignal): Promise<GetSequenceContextReturn>;
+    /**
+     *
+     * Auth
+     *
+     * TODO: rename 'ewtString' arg to 'ethauthProof'
+     */
     getAuthToken(args: GetAuthTokenArgs, headers?: object, signal?: AbortSignal): Promise<GetAuthTokenReturn>;
     getAuthToken2(args: GetAuthToken2Args, headers?: object, signal?: AbortSignal): Promise<GetAuthToken2Return>;
     sendPasswordlessLink(args: SendPasswordlessLinkArgs, headers?: object, signal?: AbortSignal): Promise<SendPasswordlessLinkReturn>;
     registerPublicKey(args: RegisterPublicKeyArgs, headers?: object, signal?: AbortSignal): Promise<RegisterPublicKeyReturn>;
     getPublicKey(args: GetPublicKeyArgs, headers?: object, signal?: AbortSignal): Promise<GetPublicKeyReturn>;
+    /**
+     *
+     * Contacts / Friends
+     *
+     */
     friendList(args: FriendListArgs, headers?: object, signal?: AbortSignal): Promise<FriendListReturn>;
     getFriendByAddress(args: GetFriendByAddressArgs, headers?: object, signal?: AbortSignal): Promise<GetFriendByAddressReturn>;
     searchFriends(args: SearchFriendsArgs, headers?: object, signal?: AbortSignal): Promise<SearchFriendsReturn>;
     addFriend(args: AddFriendArgs, headers?: object, signal?: AbortSignal): Promise<AddFriendReturn>;
     updateFriendNickname(args: UpdateFriendNicknameArgs, headers?: object, signal?: AbortSignal): Promise<UpdateFriendNicknameReturn>;
     removeFriend(args: RemoveFriendArgs, headers?: object, signal?: AbortSignal): Promise<RemoveFriendReturn>;
+    /**
+     *
+     * Chain-Utils
+     *
+     */
     contractCall(args: ContractCallArgs, headers?: object, signal?: AbortSignal): Promise<ContractCallReturn>;
     decodeContractCall(args: DecodeContractCallArgs, headers?: object, signal?: AbortSignal): Promise<DecodeContractCallReturn>;
     lookupContractCallSelectors(args: LookupContractCallSelectorsArgs, headers?: object, signal?: AbortSignal): Promise<LookupContractCallSelectorsReturn>;
+    /**
+     *
+     * User Storage
+     *
+     */
     userStorageFetch(args: UserStorageFetchArgs, headers?: object, signal?: AbortSignal): Promise<UserStorageFetchReturn>;
     userStorageSave(args: UserStorageSaveArgs, headers?: object, signal?: AbortSignal): Promise<UserStorageSaveReturn>;
     userStorageDelete(args: UserStorageDeleteArgs, headers?: object, signal?: AbortSignal): Promise<UserStorageDeleteReturn>;
     userStorageFetchAll(args: UserStorageFetchAllArgs, headers?: object, signal?: AbortSignal): Promise<UserStorageFetchAllReturn>;
+    /**
+     *
+     * Wallet utils
+     *
+     */
     getMoonpayLink(args: GetMoonpayLinkArgs, headers?: object, signal?: AbortSignal): Promise<GetMoonpayLinkReturn>;
+    /**
+     * - IsUsingGoogleMail(domain: string) => (yes: bool)
+     */
     resolveENSAddress(args: ResolveENSAddressArgs, headers?: object, signal?: AbortSignal): Promise<ResolveENSAddressReturn>;
+    /**
+     * TODO: we can add walletContext optional in the future when we need it
+     * NOTE: chainId can be either a number or canonical name
+     */
     isValidSignature(args: IsValidSignatureArgs, headers?: object, signal?: AbortSignal): Promise<IsValidSignatureReturn>;
     isValidMessageSignature(args: IsValidMessageSignatureArgs, headers?: object, signal?: AbortSignal): Promise<IsValidMessageSignatureReturn>;
     isValidTypedDataSignature(args: IsValidTypedDataSignatureArgs, headers?: object, signal?: AbortSignal): Promise<IsValidTypedDataSignatureReturn>;
@@ -616,39 +658,101 @@ export interface API {
     sardineGetSupportedTokenForSwap(args: SardineGetSupportedTokenForSwapArgs, headers?: object, signal?: AbortSignal): Promise<SardineGetSupportedTokenForSwapReturn>;
     sardineGetEnabledTokens(headers?: object, signal?: AbortSignal): Promise<SardineGetEnabledTokensReturn>;
     sardineGetQuote(args: SardineGetQuoteArgs, headers?: object, signal?: AbortSignal): Promise<SardineGetQuoteReturn>;
+    /**
+     * Deprecated. Use SardineGetClientToken() instead.
+     */
     getSardineClientToken(headers?: object, signal?: AbortSignal): Promise<GetSardineClientTokenReturn>;
+    /**
+     * Deprecated. Use SardineGetNFTCheckoutToken() instead.
+     */
     getSardineNFTCheckoutToken(args: GetSardineNFTCheckoutTokenArgs, headers?: object, signal?: AbortSignal): Promise<GetSardineNFTCheckoutTokenReturn>;
+    /**
+     * Deprecated. Use SardineGetNFTCheckoutOrderStatus() instead.
+     */
     getSardineNFTCheckoutOrderStatus(args: GetSardineNFTCheckoutOrderStatusArgs, headers?: object, signal?: AbortSignal): Promise<GetSardineNFTCheckoutOrderStatusReturn>;
     transakGetCountries(headers?: object, signal?: AbortSignal): Promise<TransakGetCountriesReturn>;
     transakGetCryptoCurrencies(headers?: object, signal?: AbortSignal): Promise<TransakGetCryptoCurrenciesReturn>;
     transakGetFiatCurrencies(headers?: object, signal?: AbortSignal): Promise<TransakGetFiatCurrenciesReturn>;
     transakGetPrice(args: TransakGetPriceArgs, headers?: object, signal?: AbortSignal): Promise<TransakGetPriceReturn>;
     transakGetSupportedNFTCheckoutChains(headers?: object, signal?: AbortSignal): Promise<TransakGetSupportedNFTCheckoutChainsReturn>;
+    /**
+     *
+     * Price Feed
+     *
+     */
     getCoinPrices(args: GetCoinPricesArgs, headers?: object, signal?: AbortSignal): Promise<GetCoinPricesReturn>;
     getCollectiblePrices(args: GetCollectiblePricesArgs, headers?: object, signal?: AbortSignal): Promise<GetCollectiblePricesReturn>;
+    /**
+     *
+     * Price Feed utils
+     *
+     */
     getExchangeRate(args: GetExchangeRateArgs, headers?: object, signal?: AbortSignal): Promise<GetExchangeRateReturn>;
+    /**
+     *
+     * Util / misc
+     *
+     */
     memoryStore(args: MemoryStoreArgs, headers?: object, signal?: AbortSignal): Promise<MemoryStoreReturn>;
     memoryLoad(args: MemoryLoadArgs, headers?: object, signal?: AbortSignal): Promise<MemoryLoadReturn>;
+    /**
+     *
+     * Legacy
+     *
+     */
     getInviteInfo(headers?: object, signal?: AbortSignal): Promise<GetInviteInfoReturn>;
+    /**
+     * NOTE: we're still using this from SW-API to Sequence-API to claim invite code
+     */
     isValidAccessCode(args: IsValidAccessCodeArgs, headers?: object, signal?: AbortSignal): Promise<IsValidAccessCodeReturn>;
     internalClaimAccessCode(args: InternalClaimAccessCodeArgs, headers?: object, signal?: AbortSignal): Promise<InternalClaimAccessCodeReturn>;
+    /**
+     * Utils
+     */
     blockNumberAtTime(args: BlockNumberAtTimeArgs, headers?: object, signal?: AbortSignal): Promise<BlockNumberAtTimeReturn>;
+    /**
+     *
+     * Paper
+     * TODO: deprecate in the future
+     *
+     */
     paperSessionSecret(args: PaperSessionSecretArgs, headers?: object, signal?: AbortSignal): Promise<PaperSessionSecretReturn>;
     paperSessionSecret2(args: PaperSessionSecret2Args, headers?: object, signal?: AbortSignal): Promise<PaperSessionSecret2Return>;
+    /**
+     *
+     * Linked wallets (v0 -- simple support)
+     *
+     */
     linkWallet(args: LinkWalletArgs, headers?: object, signal?: AbortSignal): Promise<LinkWalletReturn>;
     getLinkedWallets(args: GetLinkedWalletsArgs, headers?: object, signal?: AbortSignal): Promise<GetLinkedWalletsReturn>;
     removeLinkedWallet(args: RemoveLinkedWalletArgs, headers?: object, signal?: AbortSignal): Promise<RemoveLinkedWalletReturn>;
+    /**
+     * NOTE: these methods are deprecated, please do not use them. We may resurface them in the future, but just wanted
+     * to be clear, they are not necessary for our linked wallets.
+     */
     generateWaaSVerificationURL(args: GenerateWaaSVerificationURLArgs, headers?: object, signal?: AbortSignal): Promise<GenerateWaaSVerificationURLReturn>;
     validateWaaSVerificationNonce(args: ValidateWaaSVerificationNonceArgs, headers?: object, signal?: AbortSignal): Promise<ValidateWaaSVerificationNonceReturn>;
+    /**
+     *
+     *
+     * WaaS child wallet adoption
+     *
+     */
     listAdoptedWallets(args: ListAdoptedWalletsArgs, headers?: object, signal?: AbortSignal): Promise<ListAdoptedWalletsReturn>;
-    getSwapPermit2Price(args: GetSwapPermit2PriceArgs, headers?: object, signal?: AbortSignal): Promise<GetSwapPermit2PriceReturn>;
-    getSwapPermit2Prices(args: GetSwapPermit2PricesArgs, headers?: object, signal?: AbortSignal): Promise<GetSwapPermit2PricesReturn>;
-    getSwapPermit2Quote(args: GetSwapPermit2QuoteArgs, headers?: object, signal?: AbortSignal): Promise<GetSwapPermit2QuoteReturn>;
-    getSwapPrice(args: GetSwapPriceArgs, headers?: object, signal?: AbortSignal): Promise<GetSwapPriceReturn>;
-    getSwapPrices(args: GetSwapPricesArgs, headers?: object, signal?: AbortSignal): Promise<GetSwapPricesReturn>;
-    getSwapQuote(args: GetSwapQuoteArgs, headers?: object, signal?: AbortSignal): Promise<GetSwapQuoteReturn>;
-    getSwapQuoteV2(args: GetSwapQuoteV2Args, headers?: object, signal?: AbortSignal): Promise<GetSwapQuoteV2Return>;
-    intentQuery(args: IntentQueryArgs, headers?: object, signal?: AbortSignal): Promise<IntentQueryReturn>;
+    /**
+     *
+     * Currency abstraction
+     *
+     */
+    getLifiChains(headers?: object, signal?: AbortSignal): Promise<GetLifiChainsReturn>;
+    getLifiTokens(args: GetLifiTokensArgs, headers?: object, signal?: AbortSignal): Promise<GetLifiTokensReturn>;
+    getLifiSwapRoutes(args: GetLifiSwapRoutesArgs, headers?: object, signal?: AbortSignal): Promise<GetLifiSwapRoutesReturn>;
+    getLifiSwapQuote(args: GetLifiSwapQuoteArgs, headers?: object, signal?: AbortSignal): Promise<GetLifiSwapQuoteReturn>;
+    /**
+     *
+     * Inventory, payments and management
+     *
+     */
     listCurrencyGroups(headers?: object, signal?: AbortSignal): Promise<ListCurrencyGroupsReturn>;
     addOffchainInventory(args: AddOffchainInventoryArgs, headers?: object, signal?: AbortSignal): Promise<AddOffchainInventoryReturn>;
     getOffchainInventory(args: GetOffchainInventoryArgs, headers?: object, signal?: AbortSignal): Promise<GetOffchainInventoryReturn>;
@@ -657,6 +761,11 @@ export interface API {
     deleteOffchainInventory(args: DeleteOffchainInventoryArgs, headers?: object, signal?: AbortSignal): Promise<DeleteOffchainInventoryReturn>;
     requestOffchainPayment(args: RequestOffchainPaymentArgs, headers?: object, signal?: AbortSignal): Promise<RequestOffchainPaymentReturn>;
     listOffchainPayments(args: ListOffchainPaymentsArgs, headers?: object, signal?: AbortSignal): Promise<ListOffchainPaymentsReturn>;
+    /**
+     *
+     * Packs
+     *
+     */
     savePack(args: SavePackArgs, headers?: object, signal?: AbortSignal): Promise<SavePackReturn>;
     getPack(args: GetPackArgs, headers?: object, signal?: AbortSignal): Promise<GetPackReturn>;
     deletePack(args: DeletePackArgs, headers?: object, signal?: AbortSignal): Promise<DeletePackReturn>;
@@ -1090,88 +1199,29 @@ export interface ListAdoptedWalletsReturn {
     page: Page;
     wallets: Array<AdoptedChildWallet>;
 }
-export interface GetSwapPermit2PriceArgs {
-    buyCurrencyAddress: string;
-    sellCurrencyAddress: string;
-    buyAmount: string;
-    chainId: number;
-    slippagePercentage?: number;
-}
-export interface GetSwapPermit2PriceReturn {
-    swapPermit2Price: SwapPermit2Price;
-}
-export interface GetSwapPermit2PricesArgs {
-    userAddress: string;
-    buyCurrencyAddress: string;
-    buyAmount: string;
-    chainId: number;
-    slippagePercentage?: number;
-}
-export interface GetSwapPermit2PricesReturn {
-    swapPermit2Prices: Array<SwapPermit2Price>;
-}
-export interface GetSwapPermit2QuoteArgs {
-    userAddress: string;
-    buyCurrencyAddress: string;
-    sellCurrencyAddress: string;
-    buyAmount: string;
-    chainId: number;
-    includeApprove: boolean;
-    slippagePercentage?: number;
-}
-export interface GetSwapPermit2QuoteReturn {
-    swapPermit2Quote: SwapPermit2Quote;
+export interface GetLifiChainsArgs {
 }
-export interface GetSwapPriceArgs {
-    buyCurrencyAddress: string;
-    sellCurrencyAddress: string;
-    buyAmount: string;
-    chainId: number;
-    slippagePercentage?: number;
-}
-export interface GetSwapPriceReturn {
-    swapPrice: SwapPrice;
-}
-export interface GetSwapPricesArgs {
-    userAddress: string;
-    buyCurrencyAddress: string;
-    buyAmount: string;
-    chainId: number;
-    slippagePercentage?: number;
-}
-export interface GetSwapPricesReturn {
-    swapPrices: Array<SwapPrice>;
+export interface GetLifiChainsReturn {
+    chains: Array<number>;
 }
-export interface GetSwapQuoteArgs {
-    userAddress: string;
-    buyCurrencyAddress: string;
-    sellCurrencyAddress: string;
-    buyAmount: string;
-    chainId: number;
-    includeApprove: boolean;
-    slippagePercentage?: number;
+export interface GetLifiTokensArgs {
+    chainIds: Array<number>;
 }
-export interface GetSwapQuoteReturn {
-    swapQuote: SwapQuote;
+export interface GetLifiTokensReturn {
+    tokens: Array<Token>;
 }
-export interface GetSwapQuoteV2Args {
-    userAddress: string;
-    buyCurrencyAddress: string;
-    sellCurrencyAddress: string;
-    buyAmount: string;
+export interface GetLifiSwapRoutesArgs {
     chainId: number;
-    includeApprove: boolean;
-    slippagePercentage?: number;
+    toTokenAddress: string;
 }
-export interface GetSwapQuoteV2Return {
-    swapQuote: SwapQuote;
+export interface GetLifiSwapRoutesReturn {
+    routes: Array<LifiSwapRoute>;
 }
-export interface IntentQueryArgs {
-    wallet: string;
-    preconditions: Array<IntentPrecondition>;
+export interface GetLifiSwapQuoteArgs {
+    params: GetLifiSwapQuoteParams;
 }
-export interface IntentQueryReturn {
-    solutions: Array<IntentSolution>;
+export interface GetLifiSwapQuoteReturn {
+    quote: LifiSwapQuote;
 }
 export interface ListCurrencyGroupsArgs {
 }
@@ -1319,14 +1369,10 @@ export declare class API implements API {
     generateWaaSVerificationURL: (args: GenerateWaaSVerificationURLArgs, headers?: object, signal?: AbortSignal) => Promise<GenerateWaaSVerificationURLReturn>;
     validateWaaSVerificationNonce: (args: ValidateWaaSVerificationNonceArgs, headers?: object, signal?: AbortSignal) => Promise<ValidateWaaSVerificationNonceReturn>;
     listAdoptedWallets: (args: ListAdoptedWalletsArgs, headers?: object, signal?: AbortSignal) => Promise<ListAdoptedWalletsReturn>;
-    getSwapPermit2Price: (args: GetSwapPermit2PriceArgs, headers?: object, signal?: AbortSignal) => Promise<GetSwapPermit2PriceReturn>;
-    getSwapPermit2Prices: (args: GetSwapPermit2PricesArgs, headers?: object, signal?: AbortSignal) => Promise<GetSwapPermit2PricesReturn>;
-    getSwapPermit2Quote: (args: GetSwapPermit2QuoteArgs, headers?: object, signal?: AbortSignal) => Promise<GetSwapPermit2QuoteReturn>;
-    getSwapPrice: (args: GetSwapPriceArgs, headers?: object, signal?: AbortSignal) => Promise<GetSwapPriceReturn>;
-    getSwapPrices: (args: GetSwapPricesArgs, headers?: object, signal?: AbortSignal) => Promise<GetSwapPricesReturn>;
-    getSwapQuote: (args: GetSwapQuoteArgs, headers?: object, signal?: AbortSignal) => Promise<GetSwapQuoteReturn>;
-    getSwapQuoteV2: (args: GetSwapQuoteV2Args, headers?: object, signal?: AbortSignal) => Promise<GetSwapQuoteV2Return>;
-    intentQuery: (args: IntentQueryArgs, headers?: object, signal?: AbortSignal) => Promise<IntentQueryReturn>;
+    getLifiChains: (headers?: object, signal?: AbortSignal) => Promise<GetLifiChainsReturn>;
+    getLifiTokens: (args: GetLifiTokensArgs, headers?: object, signal?: AbortSignal) => Promise<GetLifiTokensReturn>;
+    getLifiSwapRoutes: (args: GetLifiSwapRoutesArgs, headers?: object, signal?: AbortSignal) => Promise<GetLifiSwapRoutesReturn>;
+    getLifiSwapQuote: (args: GetLifiSwapQuoteArgs, headers?: object, signal?: AbortSignal) => Promise<GetLifiSwapQuoteReturn>;
     listCurrencyGroups: (headers?: object, signal?: AbortSignal) => Promise<ListCurrencyGroupsReturn>;
     addOffchainInventory: (args: AddOffchainInventoryArgs, headers?: object, signal?: AbortSignal) => Promise<AddOffchainInventoryReturn>;
     getOffchainInventory: (args: GetOffchainInventoryArgs, headers?: object, signal?: AbortSignal) => Promise<GetOffchainInventoryReturn>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/api",
-  "version": "2.3.8",
+  "version": "2.3.10",
   "description": "api sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/api",
   "source": "src/index.ts",