TokenAPI

Index

Constructors

• constructor

Properties

• client

Methods

• getResults
• proveTransaction
• proveTransactions
• waitForJobResults

Constructors

constructor

• new TokenAPI(params: { chain: blockchain; jwt: string; zkcloudworker?: (cloud: Cloud) => Promise<zkCloudWorker> }): TokenAPI

• Parameters

  • params: { chain: blockchain; jwt: string; zkcloudworker?: (cloud: Cloud) => Promise<zkCloudWorker> }

  • chain: blockchain

  • jwt: string

  • optionalzkcloudworker: (cloud: Cloud) => Promise<zkCloudWorker>

  Returns TokenAPI

Properties

readonlyclient

client: zkCloudWorkerClient

Methods

getResults

• getResults(jobId: string): Promise<{ jobStatus?: JobStatus; results?: JobResult[]; success: true } | { error?: string; jobStatus?: JobStatus; success: false }>

• Parameters

  • jobId: string

  Returns Promise<{ jobStatus?: JobStatus; results?: JobResult[]; success: true } | { error?: string; jobStatus?: JobStatus; success: false }>

proveTransaction

• proveTransaction(params: TokenTransaction): Promise<string>

• Parameters

  • params: TokenTransaction

  Returns Promise<string>

proveTransactions

• proveTransactions(params: TokenTransaction[]): Promise<string>

• Parameters

  • params: TokenTransaction[]

  Returns Promise<string>

waitForJobResults

• waitForJobResults(params: { interval?: number; jobId: string; maxAttempts?: number; maxErrors?: number; printLogs?: boolean }): Promise<string[]>

• Parameters

  • params: { interval?: number; jobId: string; maxAttempts?: number; maxErrors?: number; printLogs?: boolean }

  • optionalinterval: number

  • jobId: string

  • optionalmaxAttempts: number

  • optionalmaxErrors: number

  • optionalprintLogs: boolean

  Returns Promise<string[]>