@0xsequence/metadata 2.3.1 → 2.3.3

package/src/metadata.gen.ts

@@ -1,13 +1,13 @@
 /* eslint-disable */
-// sequence-metadata v0.4.0 7910b31b7ff3c61ec7cf9fe4021ac00e9f9eeea5
+// sequence-metadata v0.4.0 136240089e035d0bcdadfa59508ddbf164efd5e7
 // --
-// Code generated by webrpc-gen@v0.25.2 with typescript generator. DO NOT EDIT.
+// Code generated by webrpc-gen@v0.25.3 with typescript generator. DO NOT EDIT.
 //
 // webrpc-gen -schema=metadata.ridl -target=typescript -client -out=./clients/metadata.gen.ts
 
 export const WebrpcHeader = 'Webrpc'
 
-export const WebrpcHeaderValue = 'webrpc@v0.25.2;gen-typescript@v0.17.0;sequence-metadata@v0.4.0'
+export const WebrpcHeaderValue = 'webrpc@v0.25.3;gen-typescript@v0.17.0;sequence-metadata@v0.4.0'
 
 // WebRPC description and code-gen version
 export const WebRPCVersion = 'v1'
@@ -16,7 +16,7 @@ export const WebRPCVersion = 'v1'
 export const WebRPCSchemaVersion = 'v0.4.0'
 
 // Schema hash generated from your RIDL schema
-export const WebRPCSchemaHash = '7910b31b7ff3c61ec7cf9fe4021ac00e9f9eeea5'
+export const WebRPCSchemaHash = '136240089e035d0bcdadfa59508ddbf164efd5e7'
 
 type WebrpcGenVersions = {
   webrpcGenVersion: string
@@ -74,7 +74,9 @@ export enum ContractType {
   UNKNOWN = 'UNKNOWN',
   ERC20 = 'ERC20',
   ERC721 = 'ERC721',
-  ERC1155 = 'ERC1155'
+  ERC1155 = 'ERC1155',
+  ERC6909 = 'ERC6909',
+  MISC = 'MISC'
 }
 
 export enum Source {
@@ -85,6 +87,7 @@ export enum Source {
   FETCHER_ON_CHAIN_ERC20_INTERFACE = 'FETCHER_ON_CHAIN_ERC20_INTERFACE',
   FETCHER_ON_CHAIN_TOKEN_URI = 'FETCHER_ON_CHAIN_TOKEN_URI',
   FETCHER_ON_CHAIN_CONTRACT_URI = 'FETCHER_ON_CHAIN_CONTRACT_URI',
+  FETCHER_TOKEN_DIRECTORY_ADMIN = 'FETCHER_TOKEN_DIRECTORY_ADMIN',
   TOKEN_DIRECTORY = 'TOKEN_DIRECTORY',
   TOKEN_DIRECTORY_PUBLIC_TOKEN_LIST = 'TOKEN_DIRECTORY_PUBLIC_TOKEN_LIST',
   TOKEN_DIRECTORY_3RD_PARTY = 'TOKEN_DIRECTORY_3RD_PARTY',
@@ -208,6 +211,29 @@ export interface ContractInfoExtensions {
   featureIndex: number
 }
 
+export interface ContractInfoOverride {
+  name?: string
+  type?: string
+  symbol?: string
+  decimals?: number
+  logoURI?: string
+  extensions: ContractInfoExtensionsOverride
+}
+
+export interface ContractInfoExtensionsOverride {
+  link?: string
+  description?: string
+  categories?: Array<string>
+  ogImage?: string
+  ogName?: string
+  originChainId?: number
+  originAddress?: string
+  blacklist?: boolean
+  verified?: boolean
+  verifiedBy?: string
+  featureIndex?: number
+}
+
 export interface TokenMetadata {
   contractAddress?: string
   tokenId: string
@@ -484,6 +510,14 @@ export interface Metadata {
    * @deprecated Use SearchTokenMetadataTokenIDs instead. (renamed)
    */
   searchTokenIDs(args: SearchTokenIDsArgs, headers?: object, signal?: AbortSignal): Promise<SearchTokenIDsReturn>
+  /**
+   * Gets Token Directory supported networks
+   */
+  getTokenDirectoryNetworks(
+    args: GetTokenDirectoryNetworksArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<GetTokenDirectoryNetworksReturn>
   /**
    * Gets Token Directory entries
    */
@@ -496,14 +530,6 @@ export interface Metadata {
     headers?: object,
     signal?: AbortSignal
   ): Promise<SearchTokenDirectoryReturn>
-  /**
-   * Gets Token Directory supported networks
-   */
-  getTokenDirectoryNetworks(
-    args: GetTokenDirectoryNetworksArgs,
-    headers?: object,
-    signal?: AbortSignal
-  ): Promise<GetTokenDirectoryNetworksReturn>
   /**
    * @deprecated Use GetTokenDirectoryNetworks instead.
    */
@@ -796,6 +822,15 @@ export interface SearchTokenIDsReturn {
   page: Page
   tokenIds: Array<string>
 }
+export interface GetTokenDirectoryNetworksArgs {
+  includeTestnets?: boolean
+  onlyFeatured?: boolean
+}
+
+export interface GetTokenDirectoryNetworksReturn {
+  chainIDs: Array<number>
+  networks: Array<string>
+}
 export interface GetTokenDirectoryArgs {
   chainID?: string
   includeTestnets?: boolean
@@ -804,7 +839,7 @@ export interface GetTokenDirectoryArgs {
 }
 
 export interface GetTokenDirectoryReturn {
-  collections: Array<ContractInfo>
+  contracts: Array<ContractInfo>
   page: Page
 }
 export interface SearchTokenDirectoryArgs {
@@ -816,18 +851,9 @@ export interface SearchTokenDirectoryArgs {
 }
 
 export interface SearchTokenDirectoryReturn {
-  collections: Array<ContractInfo>
+  contracts: Array<ContractInfo>
   page: Page
 }
-export interface GetTokenDirectoryNetworksArgs {
-  includeTestnets?: boolean
-  onlyFeatured?: boolean
-}
-
-export interface GetTokenDirectoryNetworksReturn {
-  chainIDs: Array<number>
-  networks: Array<string>
-}
 export interface DirectoryGetNetworksArgs {
   includeTestnets?: boolean
   onlyFeatured?: boolean
@@ -1124,6 +1150,11 @@ export interface Admin {
   /**
    * Contract Info Overrides
    */
+  getContractInfoOverride(
+    args: GetContractInfoOverrideArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<GetContractInfoOverrideReturn>
   getContractInfoOverrides(
     args: GetContractInfoOverridesArgs,
     headers?: object,
@@ -1147,6 +1178,22 @@ export interface Admin {
   /**
    * Token Directory
    */
+  isInTokenDirectory(args: IsInTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<IsInTokenDirectoryReturn>
+  setTokenDirectoryFeatureIndex(
+    args: SetTokenDirectoryFeatureIndexArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<SetTokenDirectoryFeatureIndexReturn>
+  addContractToTokenDirectory(
+    args: AddContractToTokenDirectoryArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<AddContractToTokenDirectoryReturn>
+  removeContractFromTokenDirectory(
+    args: RemoveContractFromTokenDirectoryArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<RemoveContractFromTokenDirectoryReturn>
   refreshTokenDirectory(headers?: object, signal?: AbortSignal): Promise<RefreshTokenDirectoryReturn>
   /**
    * @deprecated use new admin api
@@ -1178,31 +1225,83 @@ export interface Admin {
   listTokenDirectory(args: ListTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<ListTokenDirectoryReturn>
 }
 
+export interface GetContractInfoOverrideArgs {
+  chainID: string
+  contractAddress: string
+}
+
+export interface GetContractInfoOverrideReturn {
+  contractInfoOverride: ContractInfoOverride
+}
 export interface GetContractInfoOverridesArgs {
   chainID?: string
   page?: Page
 }
 
 export interface GetContractInfoOverridesReturn {
-  contractInfoOverrides: Array<ContractInfo>
+  contractInfoOverrides: Array<ContractInfoOverride>
   page: Page
 }
 export interface AddContractInfoOverrideArgs {
-  contractInfoOverride: ContractInfo
+  chainID: string
+  contractAddress: string
+  contractInfoOverride: ContractInfoOverride
 }
 
-export interface AddContractInfoOverrideReturn {}
+export interface AddContractInfoOverrideReturn {
+  ok: boolean
+}
 export interface UpdateContractInfoOverrideArgs {
-  contractInfoOverride: ContractInfo
+  chainID: string
+  contractAddress: string
+  contractInfoOverride: ContractInfoOverride
 }
 
-export interface UpdateContractInfoOverrideReturn {}
+export interface UpdateContractInfoOverrideReturn {
+  ok: boolean
+}
 export interface RemoveContractInfoOverrideArgs {
   chainID: string
   contractAddress: string
 }
 
-export interface RemoveContractInfoOverrideReturn {}
+export interface RemoveContractInfoOverrideReturn {
+  ok: boolean
+}
+export interface IsInTokenDirectoryArgs {
+  chainID: string
+  contractAddress: string
+}
+
+export interface IsInTokenDirectoryReturn {
+  ok: boolean
+  featureIndex: number
+}
+export interface SetTokenDirectoryFeatureIndexArgs {
+  chainID: string
+  contractAddress: string
+  featureIndex: number
+}
+
+export interface SetTokenDirectoryFeatureIndexReturn {
+  ok: boolean
+}
+export interface AddContractToTokenDirectoryArgs {
+  chainID: string
+  contractAddress: string
+}
+
+export interface AddContractToTokenDirectoryReturn {
+  ok: boolean
+}
+export interface RemoveContractFromTokenDirectoryArgs {
+  chainID: string
+  contractAddress: string
+}
+
+export interface RemoveContractFromTokenDirectoryReturn {
+  ok: boolean
+}
 export interface RefreshTokenDirectoryArgs {}
 
 export interface RefreshTokenDirectoryReturn {
@@ -1767,13 +1866,17 @@ export class Metadata implements Metadata {
     )
   }
 
-  getTokenDirectory = (args: GetTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<GetTokenDirectoryReturn> => {
-    return this.fetch(this.url('GetTokenDirectory'), createHTTPRequest(args, headers, signal)).then(
+  getTokenDirectoryNetworks = (
+    args: GetTokenDirectoryNetworksArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<GetTokenDirectoryNetworksReturn> => {
+    return this.fetch(this.url('GetTokenDirectoryNetworks'), createHTTPRequest(args, headers, signal)).then(
       res => {
         return buildResponse(res).then(_data => {
           return {
-            collections: <Array<ContractInfo>>_data.collections,
-            page: <Page>_data.page
+            chainIDs: <Array<number>>_data.chainIDs,
+            networks: <Array<string>>_data.networks
           }
         })
       },
@@ -1783,16 +1886,12 @@ export class Metadata implements Metadata {
     )
   }
 
-  searchTokenDirectory = (
-    args: SearchTokenDirectoryArgs,
-    headers?: object,
-    signal?: AbortSignal
-  ): Promise<SearchTokenDirectoryReturn> => {
-    return this.fetch(this.url('SearchTokenDirectory'), createHTTPRequest(args, headers, signal)).then(
+  getTokenDirectory = (args: GetTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<GetTokenDirectoryReturn> => {
+    return this.fetch(this.url('GetTokenDirectory'), createHTTPRequest(args, headers, signal)).then(
       res => {
         return buildResponse(res).then(_data => {
           return {
-            collections: <Array<ContractInfo>>_data.collections,
+            contracts: <Array<ContractInfo>>_data.contracts,
             page: <Page>_data.page
           }
         })
@@ -1803,17 +1902,17 @@ export class Metadata implements Metadata {
     )
   }
 
-  getTokenDirectoryNetworks = (
-    args: GetTokenDirectoryNetworksArgs,
+  searchTokenDirectory = (
+    args: SearchTokenDirectoryArgs,
     headers?: object,
     signal?: AbortSignal
-  ): Promise<GetTokenDirectoryNetworksReturn> => {
-    return this.fetch(this.url('GetTokenDirectoryNetworks'), createHTTPRequest(args, headers, signal)).then(
+  ): Promise<SearchTokenDirectoryReturn> => {
+    return this.fetch(this.url('SearchTokenDirectory'), createHTTPRequest(args, headers, signal)).then(
       res => {
         return buildResponse(res).then(_data => {
           return {
-            chainIDs: <Array<number>>_data.chainIDs,
-            networks: <Array<string>>_data.networks
+            contracts: <Array<ContractInfo>>_data.contracts,
+            page: <Page>_data.page
           }
         })
       },
@@ -2312,6 +2411,25 @@ export class Admin implements Admin {
     return this.hostname + this.path + name
   }
 
+  getContractInfoOverride = (
+    args: GetContractInfoOverrideArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<GetContractInfoOverrideReturn> => {
+    return this.fetch(this.url('GetContractInfoOverride'), createHTTPRequest(args, headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return {
+            contractInfoOverride: <ContractInfoOverride>_data.contractInfoOverride
+          }
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error.message || ''}` })
+      }
+    )
+  }
+
   getContractInfoOverrides = (
     args: GetContractInfoOverridesArgs,
     headers?: object,
@@ -2321,7 +2439,7 @@ export class Admin implements Admin {
       res => {
         return buildResponse(res).then(_data => {
           return {
-            contractInfoOverrides: <Array<ContractInfo>>_data.contractInfoOverrides,
+            contractInfoOverrides: <Array<ContractInfoOverride>>_data.contractInfoOverrides,
             page: <Page>_data.page
           }
         })
@@ -2340,7 +2458,9 @@ export class Admin implements Admin {
     return this.fetch(this.url('AddContractInfoOverride'), createHTTPRequest(args, headers, signal)).then(
       res => {
         return buildResponse(res).then(_data => {
-          return {}
+          return {
+            ok: <boolean>_data.ok
+          }
         })
       },
       error => {
@@ -2357,7 +2477,9 @@ export class Admin implements Admin {
     return this.fetch(this.url('UpdateContractInfoOverride'), createHTTPRequest(args, headers, signal)).then(
       res => {
         return buildResponse(res).then(_data => {
-          return {}
+          return {
+            ok: <boolean>_data.ok
+          }
         })
       },
       error => {
@@ -2374,7 +2496,86 @@ export class Admin implements Admin {
     return this.fetch(this.url('RemoveContractInfoOverride'), createHTTPRequest(args, headers, signal)).then(
       res => {
         return buildResponse(res).then(_data => {
-          return {}
+          return {
+            ok: <boolean>_data.ok
+          }
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error.message || ''}` })
+      }
+    )
+  }
+
+  isInTokenDirectory = (
+    args: IsInTokenDirectoryArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<IsInTokenDirectoryReturn> => {
+    return this.fetch(this.url('IsInTokenDirectory'), createHTTPRequest(args, headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return {
+            ok: <boolean>_data.ok,
+            featureIndex: <number>_data.featureIndex
+          }
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error.message || ''}` })
+      }
+    )
+  }
+
+  setTokenDirectoryFeatureIndex = (
+    args: SetTokenDirectoryFeatureIndexArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<SetTokenDirectoryFeatureIndexReturn> => {
+    return this.fetch(this.url('SetTokenDirectoryFeatureIndex'), createHTTPRequest(args, headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return {
+            ok: <boolean>_data.ok
+          }
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error.message || ''}` })
+      }
+    )
+  }
+
+  addContractToTokenDirectory = (
+    args: AddContractToTokenDirectoryArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<AddContractToTokenDirectoryReturn> => {
+    return this.fetch(this.url('AddContractToTokenDirectory'), createHTTPRequest(args, headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return {
+            ok: <boolean>_data.ok
+          }
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error.message || ''}` })
+      }
+    )
+  }
+
+  removeContractFromTokenDirectory = (
+    args: RemoveContractFromTokenDirectoryArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<RemoveContractFromTokenDirectoryReturn> => {
+    return this.fetch(this.url('RemoveContractFromTokenDirectory'), createHTTPRequest(args, headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return {
+            ok: <boolean>_data.ok
+          }
         })
       },
       error => {
@@ -2807,6 +3008,19 @@ export class TaskFailedError extends WebrpcError {
   }
 }
 
+export class DeprecatedError extends WebrpcError {
+  constructor(
+    name: string = 'Deprecated',
+    code: number = 1008,
+    message: string = `RPC method is deprecated`,
+    status: number = 0,
+    cause?: string
+  ) {
+    super(name, code, message, status, cause)
+    Object.setPrototypeOf(this, DeprecatedError.prototype)
+  }
+}
+
 export class TimeoutError extends WebrpcError {
   constructor(
     name: string = 'Timeout',
@@ -2957,6 +3171,7 @@ export enum errors {
   Fail = 'Fail',
   Geoblocked = 'Geoblocked',
   TaskFailed = 'TaskFailed',
+  Deprecated = 'Deprecated',
   Timeout = 'Timeout',
   InvalidArgument = 'InvalidArgument',
   RequiredArgument = 'RequiredArgument',
@@ -2989,6 +3204,7 @@ export enum WebrpcErrorCodes {
   Fail = 1005,
   Geoblocked = 1006,
   TaskFailed = 1007,
+  Deprecated = 1008,
   Timeout = 2000,
   InvalidArgument = 2001,
   RequiredArgument = 2002,
@@ -3021,6 +3237,7 @@ export const webrpcErrorByCode: { [code: number]: any } = {
   [1005]: FailError,
   [1006]: GeoblockedError,
   [1007]: TaskFailedError,
+  [1008]: DeprecatedError,
   [2000]: TimeoutError,
   [2001]: InvalidArgumentError,
   [2002]: RequiredArgumentError,