@0xsequence/metadata 2.2.11 → 2.2.13

package/src/metadata.gen.ts

@@ -1,10 +1,14 @@
 /* eslint-disable */
-// sequence-metadata v0.4.0 9d0976f6ff345b6a688b69cff647454e7fd0e3a6
+// sequence-metadata v0.4.0 9594f86f8681f364dd514a1bd7cae1c1dc77e3de
 // --
-// Code generated by webrpc-gen@v0.18.6 with typescript generator. DO NOT EDIT.
+// Code generated by webrpc-gen@v0.21.1 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.21.1;gen-typescript@v0.15.1;sequence-metadata@v0.4.0'
+
 // WebRPC description and code-gen version
 export const WebRPCVersion = 'v1'
 
@@ -12,7 +16,55 @@ export const WebRPCVersion = 'v1'
 export const WebRPCSchemaVersion = 'v0.4.0'
 
 // Schema hash generated from your RIDL schema
-export const WebRPCSchemaHash = '9d0976f6ff345b6a688b69cff647454e7fd0e3a6'
+export const WebRPCSchemaHash = '9594f86f8681f364dd514a1bd7cae1c1dc77e3de'
+
+type WebrpcGenVersions = {
+  webrpcGenVersion: string
+  codeGenName: string
+  codeGenVersion: string
+  schemaName: string
+  schemaVersion: string
+}
+
+export function VersionFromHeader(headers: Headers): WebrpcGenVersions {
+  const headerValue = headers.get(WebrpcHeader)
+  if (!headerValue) {
+    return {
+      webrpcGenVersion: '',
+      codeGenName: '',
+      codeGenVersion: '',
+      schemaName: '',
+      schemaVersion: ''
+    }
+  }
+
+  return parseWebrpcGenVersions(headerValue)
+}
+
+function parseWebrpcGenVersions(header: string): WebrpcGenVersions {
+  const versions = header.split(';')
+  if (versions.length < 3) {
+    return {
+      webrpcGenVersion: '',
+      codeGenName: '',
+      codeGenVersion: '',
+      schemaName: '',
+      schemaVersion: ''
+    }
+  }
+
+  const [_, webrpcGenVersion] = versions[0].split('@')
+  const [codeGenName, codeGenVersion] = versions[1].split('@')
+  const [schemaName, schemaVersion] = versions[2].split('@')
+
+  return {
+    webrpcGenVersion,
+    codeGenName,
+    codeGenVersion,
+    schemaName,
+    schemaVersion
+  }
+}
 
 //
 // Types
@@ -25,6 +77,29 @@ export enum ContractType {
   ERC1155 = 'ERC1155'
 }
 
+export enum Source {
+  UNKNOWN = 'UNKNOWN',
+  FETCHER = 'FETCHER',
+  FETCHER_OPENSEA_API = 'FETCHER_OPENSEA_API',
+  FETCHER_ENS_API = 'FETCHER_ENS_API',
+  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',
+  TOKEN_DIRECTORY = 'TOKEN_DIRECTORY',
+  TOKEN_DIRECTORY_PUBLIC_TOKEN_LIST = 'TOKEN_DIRECTORY_PUBLIC_TOKEN_LIST',
+  TOKEN_DIRECTORY_3RD_PARTY = 'TOKEN_DIRECTORY_3RD_PARTY',
+  TOKEN_DIRECTORY_SEQUENCE_GITHUB = 'TOKEN_DIRECTORY_SEQUENCE_GITHUB',
+  TOKEN_DIRECTORY_SEQUENCE_BUILDER = 'TOKEN_DIRECTORY_SEQUENCE_BUILDER',
+  SEQUENCE_BUILDER = 'SEQUENCE_BUILDER',
+  SEQUENCE_BUILDER_COLLECTIONS = 'SEQUENCE_BUILDER_COLLECTIONS'
+}
+
+export enum ResourceStatus {
+  NOT_AVAILABLE = 'NOT_AVAILABLE',
+  STALE = 'STALE',
+  AVAILABLE = 'AVAILABLE'
+}
+
 export enum PropertyType {
   INT = 'INT',
   STRING = 'STRING',
@@ -39,11 +114,10 @@ export enum SwapType {
 }
 
 export enum TaskStatus {
-  PENDING = 'PENDING',
+  QUEUED = 'QUEUED',
   PAUSED = 'PAUSED',
   FAILED = 'FAILED',
-  COMPLETED = 'COMPLETED',
-  DISABLED = 'DISABLED'
+  COMPLETED = 'COMPLETED'
 }
 
 export interface Version {
@@ -57,10 +131,20 @@ export interface RuntimeStatus {
   healthOK: boolean
   startTime: string
   uptime: number
+  uptimeString: string
   ver: string
   branch: string
   commitHash: string
   checks: RuntimeChecks
+  runnable: { [key: string]: RunnableStatus }
+}
+
+export interface RunnableStatus {
+  running: boolean
+  restarts: number
+  startTime: string
+  endTime?: string
+  lastError: any
 }
 
 export interface RuntimeChecks {}
@@ -69,16 +153,20 @@ export interface ContractIndex {
   chainId: number
   address: string
   type: ContractType
+  source: Source
   metadata: { [key: string]: any }
   contentHash: number
   deployed: boolean
   bytecodeHash: string
   notFound: boolean
   updatedAt: string
+  queuedAt?: string
+  status: ResourceStatus
 }
 
 export interface TokenIndex {
   key: string
+  source: Source
   chainId: number
   contractAddress: string
   tokenId: string
@@ -87,11 +175,13 @@ export interface TokenIndex {
   lastFetched?: string
   fetchCount?: number
   updatedAt: string
+  queuedAt?: string
 }
 
 export interface ContractInfo {
   chainId: number
   address: string
+  source: string
   name: string
   type: string
   symbol: string
@@ -101,11 +191,15 @@ export interface ContractInfo {
   bytecodeHash: string
   extensions: ContractInfoExtensions
   updatedAt: string
+  notFound: boolean
+  queuedAt?: string
+  status: ResourceStatus
 }
 
 export interface ContractInfoExtensions {
   link: string
   description: string
+  categories: Array<string>
   ogImage: string
   ogName: string
   originChainId: number
@@ -114,11 +208,11 @@ export interface ContractInfoExtensions {
   verified: boolean
   verifiedBy: string
   featured: boolean
-  private: boolean
 }
 
 export interface TokenMetadata {
   tokenId: string
+  source: string
   name: string
   description?: string
   image?: string
@@ -133,6 +227,9 @@ export interface TokenMetadata {
   decimals?: number
   updatedAt?: string
   assets?: Array<Asset>
+  status: ResourceStatus
+  queuedAt?: string
+  lastFetched?: string
 }
 
 export interface PropertyFilter {
@@ -248,7 +345,8 @@ export interface Metadata {
   ping(headers?: object, signal?: AbortSignal): Promise<PingReturn>
   version(headers?: object, signal?: AbortSignal): Promise<VersionReturn>
   runtimeStatus(headers?: object, signal?: AbortSignal): Promise<RuntimeStatusReturn>
-  getTokenMetadata(args: GetTokenMetadataArgs, headers?: object, signal?: AbortSignal): Promise<GetTokenMetadataReturn>
+  getTask(args: GetTaskArgs, headers?: object, signal?: AbortSignal): Promise<GetTaskReturn>
+  getTaskStatus(args: GetTaskStatusArgs, headers?: object, signal?: AbortSignal): Promise<GetTaskStatusReturn>
   refreshTokenMetadata(
     args: RefreshTokenMetadataArgs,
     headers?: object,
@@ -270,6 +368,18 @@ export interface Metadata {
     signal?: AbortSignal
   ): Promise<GetTokenRefreshResultReturn>
   cancelRefreshJob(args: CancelRefreshJobArgs, headers?: object, signal?: AbortSignal): Promise<CancelRefreshJobReturn>
+  refreshContractInfo(args: RefreshContractInfoArgs, headers?: object, signal?: AbortSignal): Promise<RefreshContractInfoReturn>
+  refreshContractTokens(
+    args: RefreshContractTokensArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<RefreshContractTokensReturn>
+  refreshAllContractTokens(
+    args: RefreshAllContractTokensArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<RefreshAllContractTokensReturn>
+  getTokenMetadata(args: GetTokenMetadataArgs, headers?: object, signal?: AbortSignal): Promise<GetTokenMetadataReturn>
   getTokenMetadataBatch(
     args: GetTokenMetadataBatchArgs,
     headers?: object,
@@ -371,14 +481,19 @@ export interface RuntimeStatusArgs {}
 export interface RuntimeStatusReturn {
   status: RuntimeStatus
 }
-export interface GetTokenMetadataArgs {
-  chainID: string
-  contractAddress: string
-  tokenIDs: Array<string>
+export interface GetTaskArgs {
+  taskId: number
 }
 
-export interface GetTokenMetadataReturn {
-  tokenMetadata: Array<TokenMetadata>
+export interface GetTaskReturn {
+  task: Task
+}
+export interface GetTaskStatusArgs {
+  taskId: number
+}
+
+export interface GetTaskStatusReturn {
+  status?: TaskStatus
 }
 export interface RefreshTokenMetadataArgs {
   chainID: string
@@ -423,6 +538,40 @@ export interface CancelRefreshJobArgs {
 export interface CancelRefreshJobReturn {
   ok: boolean
 }
+export interface RefreshContractInfoArgs {
+  chainHandle: string
+  contractAddress: string
+}
+
+export interface RefreshContractInfoReturn {}
+export interface RefreshContractTokensArgs {
+  chainHandle: string
+  contractAddress: string
+  tokenIDs: Array<string>
+}
+
+export interface RefreshContractTokensReturn {
+  taskID?: number
+}
+export interface RefreshAllContractTokensArgs {
+  chainHandle: string
+  contractAddress: string
+}
+
+export interface RefreshAllContractTokensReturn {
+  taskID?: number
+  retryAfter: number
+}
+export interface GetTokenMetadataArgs {
+  chainID: string
+  contractAddress: string
+  tokenIDs: Array<string>
+}
+
+export interface GetTokenMetadataReturn {
+  tokenMetadata: Array<TokenMetadata>
+  taskID?: number
+}
 export interface GetTokenMetadataBatchArgs {
   chainID: string
   contractTokenMap: { [key: string]: Array<string> }
@@ -430,6 +579,7 @@ export interface GetTokenMetadataBatchArgs {
 
 export interface GetTokenMetadataBatchReturn {
   contractTokenMetadata: { [key: string]: Array<TokenMetadata> }
+  taskID?: number
 }
 export interface SearchTokenMetadataArgs {
   chainID: string
@@ -468,6 +618,7 @@ export interface GetContractInfoArgs {
 
 export interface GetContractInfoReturn {
   contractInfo: ContractInfo
+  taskID?: number
 }
 export interface GetContractInfoBatchArgs {
   chainID: string
@@ -476,6 +627,7 @@ export interface GetContractInfoBatchArgs {
 
 export interface GetContractInfoBatchReturn {
   contractInfoMap: { [key: string]: ContractInfo }
+  taskID?: number
 }
 export interface SearchContractInfoArgs {
   contractAddress: string
@@ -941,7 +1093,7 @@ export class Metadata implements Metadata {
   protected path = '/rpc/Metadata/'
 
   constructor(hostname: string, fetch: Fetch) {
-    this.hostname = hostname
+    this.hostname = hostname.replace(/\/*$/, '')
     this.fetch = (input: RequestInfo, init?: RequestInit) => fetch(input, init)
   }
 
@@ -994,12 +1146,27 @@ export class Metadata implements Metadata {
     )
   }
 
-  getTokenMetadata = (args: GetTokenMetadataArgs, headers?: object, signal?: AbortSignal): Promise<GetTokenMetadataReturn> => {
-    return this.fetch(this.url('GetTokenMetadata'), createHTTPRequest(args, headers, signal)).then(
+  getTask = (args: GetTaskArgs, headers?: object, signal?: AbortSignal): Promise<GetTaskReturn> => {
+    return this.fetch(this.url('GetTask'), createHTTPRequest(args, headers, signal)).then(
       res => {
         return buildResponse(res).then(_data => {
           return {
-            tokenMetadata: <Array<TokenMetadata>>_data.tokenMetadata
+            task: <Task>_data.task
+          }
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error.message || ''}` })
+      }
+    )
+  }
+
+  getTaskStatus = (args: GetTaskStatusArgs, headers?: object, signal?: AbortSignal): Promise<GetTaskStatusReturn> => {
+    return this.fetch(this.url('GetTaskStatus'), createHTTPRequest(args, headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return {
+            status: <TaskStatus>_data.status
           }
         })
       },
@@ -1102,6 +1269,78 @@ export class Metadata implements Metadata {
     )
   }
 
+  refreshContractInfo = (
+    args: RefreshContractInfoArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<RefreshContractInfoReturn> => {
+    return this.fetch(this.url('RefreshContractInfo'), createHTTPRequest(args, headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return {}
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error.message || ''}` })
+      }
+    )
+  }
+
+  refreshContractTokens = (
+    args: RefreshContractTokensArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<RefreshContractTokensReturn> => {
+    return this.fetch(this.url('RefreshContractTokens'), createHTTPRequest(args, headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return {
+            taskID: <number>_data.taskID
+          }
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error.message || ''}` })
+      }
+    )
+  }
+
+  refreshAllContractTokens = (
+    args: RefreshAllContractTokensArgs,
+    headers?: object,
+    signal?: AbortSignal
+  ): Promise<RefreshAllContractTokensReturn> => {
+    return this.fetch(this.url('RefreshAllContractTokens'), createHTTPRequest(args, headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return {
+            taskID: <number>_data.taskID,
+            retryAfter: <number>_data.retryAfter
+          }
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error.message || ''}` })
+      }
+    )
+  }
+
+  getTokenMetadata = (args: GetTokenMetadataArgs, headers?: object, signal?: AbortSignal): Promise<GetTokenMetadataReturn> => {
+    return this.fetch(this.url('GetTokenMetadata'), createHTTPRequest(args, headers, signal)).then(
+      res => {
+        return buildResponse(res).then(_data => {
+          return {
+            tokenMetadata: <Array<TokenMetadata>>_data.tokenMetadata,
+            taskID: <number>_data.taskID
+          }
+        })
+      },
+      error => {
+        throw WebrpcRequestFailedError.new({ cause: `fetch(): ${error.message || ''}` })
+      }
+    )
+  }
+
   getTokenMetadataBatch = (
     args: GetTokenMetadataBatchArgs,
     headers?: object,
@@ -1111,7 +1350,8 @@ export class Metadata implements Metadata {
       res => {
         return buildResponse(res).then(_data => {
           return {
-            contractTokenMetadata: <{ [key: string]: Array<TokenMetadata> }>_data.contractTokenMetadata
+            contractTokenMetadata: <{ [key: string]: Array<TokenMetadata> }>_data.contractTokenMetadata,
+            taskID: <number>_data.taskID
           }
         })
       },
@@ -1181,7 +1421,8 @@ export class Metadata implements Metadata {
       res => {
         return buildResponse(res).then(_data => {
           return {
-            contractInfo: <ContractInfo>_data.contractInfo
+            contractInfo: <ContractInfo>_data.contractInfo,
+            taskID: <number>_data.taskID
           }
         })
       },
@@ -1200,7 +1441,8 @@ export class Metadata implements Metadata {
       res => {
         return buildResponse(res).then(_data => {
           return {
-            contractInfoMap: <{ [key: string]: ContractInfo }>_data.contractInfoMap
+            contractInfoMap: <{ [key: string]: ContractInfo }>_data.contractInfoMap,
+            taskID: <number>_data.taskID
           }
         })
       },
@@ -1548,7 +1790,7 @@ export class Collections implements Collections {
   protected path = '/rpc/Collections/'
 
   constructor(hostname: string, fetch: Fetch) {
-    this.hostname = hostname
+    this.hostname = hostname.replace(/\/*$/, '')
     this.fetch = (input: RequestInfo, init?: RequestInit) => fetch(input, init)
   }
 
@@ -1907,7 +2149,7 @@ export class Admin implements Admin {
   protected path = '/rpc/Admin/'
 
   constructor(hostname: string, fetch: Fetch) {
-    this.hostname = hostname
+    this.hostname = hostname.replace(/\/*$/, '')
     this.fetch = (input: RequestInfo, init?: RequestInit) => fetch(input, init)
   }
 
@@ -2009,9 +2251,12 @@ export class Admin implements Admin {
 }
 
 const createHTTPRequest = (body: object = {}, headers: object = {}, signal: AbortSignal | null = null): object => {
+  const reqHeaders: { [key: string]: string } = { ...headers, 'Content-Type': 'application/json' }
+  reqHeaders[WebrpcHeader] = WebrpcHeaderValue
+
   return {
     method: 'POST',
-    headers: { ...headers, 'Content-Type': 'application/json' },
+    headers: reqHeaders,
     body: JSON.stringify(body || {}),
     signal
   }