[AUTOMATED] Update: api/proto/clients/api.gen.ts

Author: VojtechVitek

packages/api/src/api.gen.ts

@@ -1,13 +1,13 @@
 /* eslint-disable */
 // sequence-api v0.4.0 2409c101bc62a1b7aa797e099d913b1c4046e9f6
 // --
-// Code generated by webrpc-gen@v0.24.0 with typescript generator. DO NOT EDIT.
+// Code generated by webrpc-gen@v0.25.3 with typescript generator. DO NOT EDIT.
 //
 // webrpc-gen -schema=api.ridl -target=typescript -client -out=./clients/api.gen.ts
 
 export const WebrpcHeader = 'Webrpc'
 
-export const WebrpcHeaderValue = 'webrpc@v0.24.0;gen-typescript@v0.16.3;[email protected]'
+export const WebrpcHeaderValue = 'webrpc@v0.25.3;gen-typescript@v0.17.0;[email protected]'
 
 // WebRPC description and code-gen version
 export const WebRPCVersion = 'v1'
@@ -703,11 +703,22 @@ export interface TransakChain {
 }
 
 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(
@@ -717,6 +728,11 @@ export interface API {
   ): 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>
@@ -727,19 +743,41 @@ export interface API {
     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,
@@ -773,12 +811,21 @@ export interface API {
   ): 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,
@@ -792,28 +839,69 @@ export interface API {
     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,
@@ -824,7 +912,18 @@ export interface API {
     headers?: object,
     signal?: AbortSignal
   ): Promise<ValidateWaaSVerificationNonceReturn>
+  /**
+   *
+   *
+   * WaaS child wallet adoption
+   *
+   */
   listAdoptedWallets(args: ListAdoptedWalletsArgs, headers?: object, signal?: AbortSignal): Promise<ListAdoptedWalletsReturn>
+  /**
+   *
+   * Currency abstraction
+   *
+   */
   getSwapPermit2Price(args: GetSwapPermit2PriceArgs, headers?: object, signal?: AbortSignal): Promise<GetSwapPermit2PriceReturn>
   getSwapPermit2Prices(
     args: GetSwapPermit2PricesArgs,
@@ -836,7 +935,17 @@ export interface API {
   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>
+  /**
+   *
+   * Chain abstraction
+   *
+   */
   intentQuery(args: IntentQueryArgs, headers?: object, signal?: AbortSignal): Promise<IntentQueryReturn>
+  /**
+   *
+   * Inventory, payments and management
+   *
+   */
   listCurrencyGroups(headers?: object, signal?: AbortSignal): Promise<ListCurrencyGroupsReturn>
   addOffchainInventory(
     args: AddOffchainInventoryArgs,
@@ -873,6 +982,11 @@ export interface API {
     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>