Class EngineWebClient

Queries that talk directly to web, not the engine. Placing here in the engine-client as we don't have enough use cases to justify a separate package

Hierarchy (view full)

EngineBaseClient
- EngineWebClient

Index

Constructors

constructor

new EngineWebClient(opts): EngineWebClient
Parameters
- opts: EngineClientOpts
Returns EngineWebClient
Inherited from EngineBaseClient.constructor
- Defined in EngineBaseClient.ts:47

Properties

`Readonly`opts

opts: EngineClientOpts

`Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

setLinkedSigner

setLinkedSigner(linkedSigner): void
Sets the linked signer for execute requests
Parameters
- linkedSigner: null | Signer
  The linkedSigner to use for all signatures. Set to null to revert to the chain signer
Returns void
Inherited from EngineBaseClient.setLinkedSigner
- Defined in EngineBaseClient.ts:59

getTxNonce

getTxNonce(address?): Promise<string>
Parameters
- Optionaladdress: string
Returns Promise<string>
Inherited from EngineBaseClient.getTxNonce
- Defined in EngineBaseClient.ts:63

getNonces

getNonces(params): Promise<GetEngineNoncesResponse>
Parameters
- params: EngineServerNoncesParams
Returns Promise<GetEngineNoncesResponse>
Inherited from EngineBaseClient.getNonces
- Defined in EngineBaseClient.ts:75

query

query<TRequestType>(requestType, params): Promise<EngineServerQueryResponseByType[TRequestType]>
Queries the engine, all query params are stringified into the query string
Type Parameters
- TRequestType extends keyof EngineServerQueryRequestByType
Parameters
- requestType: TRequestType
- params: EngineServerQueryRequestByType[TRequestType]
Returns Promise<EngineServerQueryResponseByType[TRequestType]>
Inherited from EngineBaseClient.query
- Defined in EngineBaseClient.ts:93

getQueryRequest

getQueryRequest<TRequestType>(requestType, params): EngineServerQueryRequest<TRequestType>
A simple, typechecked fn for constructing a query request in the format expected by the server.
Type Parameters
- TRequestType extends keyof EngineServerQueryRequestByType
Parameters
- requestType: TRequestType
- params: EngineServerQueryRequestByType[TRequestType]
Returns EngineServerQueryRequest<TRequestType>
Inherited from EngineBaseClient.getQueryRequest
- Defined in EngineBaseClient.ts:121

execute

execute<TRequestType>(requestType, params): Promise<EngineServerExecuteSuccessResult<TRequestType>>
POSTs an execute message to the engine and returns the successful response. Throws the failure response wrapped in an EngineServerFailureError on failure.
Type Parameters
- TRequestType extends keyof EngineServerExecuteRequestByType
Parameters
- requestType: TRequestType
- params: EngineServerExecuteRequestByType[TRequestType]
Returns Promise<EngineServerExecuteSuccessResult<TRequestType>>
Inherited from EngineBaseClient.execute
- Defined in EngineBaseClient.ts:139

getExecuteRequest

getExecuteRequest<TRequestType>(requestType, params): Partial<EngineServerExecuteRequestByType>
A simple, typechecked fn for constructing an execute request in the format expected by the server.
Type Parameters
- TRequestType extends keyof EngineServerExecuteRequestByType
Parameters
- requestType: TRequestType
- params: EngineServerExecuteRequestByType[TRequestType]
Returns Partial<EngineServerExecuteRequestByType>
Inherited from EngineBaseClient.getExecuteRequest
- Defined in EngineBaseClient.ts:161

sign

sign<T>(requestType, verifyingContract, chainId, params): Promise<string>
Signs a given request with the signer provided to the engine
Type Parameters
- T extends keyof SignableRequestTypeToParams
Parameters
- requestType: T
- verifyingContract: string
- chainId: BigNumberish
- params: SignableRequestTypeToParams[T]
Returns Promise<string>
Inherited from EngineBaseClient.sign
- Defined in EngineBaseClient.ts:179

getIsBlockedIp

getIsBlockedIp(): Promise<boolean>
Determines whether client IP is blocked from interacting with the engine

Returns Promise<boolean>
- Defined in EngineWebClient.ts:12

getRequiresCloudflareAuth

getRequiresCloudflareAuth(): Promise<boolean>
Determines whether a client needs to complete the cloudflare JS challenge to interact with the API

Returns Promise<boolean>
true if the client needs to complete the JS challenge at '/challenge', false otherwise
- Defined in EngineWebClient.ts:38

getTime

getTime(): Promise<number>
Retrieves current server epoch in milliseconds

Returns Promise<number>
- Defined in EngineWebClient.ts:59

Class EngineWebClient

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EngineWebClient

Properties

Readonlyopts

ReadonlyaxiosInstance

Methods

setLinkedSigner

Parameters

Returns void

getTxNonce

Parameters

Returns Promise<string>

getNonces

Parameters

Returns Promise<GetEngineNoncesResponse>

query

Type Parameters

Parameters

Returns Promise<EngineServerQueryResponseByType[TRequestType]>

getQueryRequest

Type Parameters

Parameters

Returns EngineServerQueryRequest<TRequestType>

execute

Type Parameters

Parameters

Returns Promise<EngineServerExecuteSuccessResult<TRequestType>>

getExecuteRequest

Type Parameters

Parameters

Returns Partial<EngineServerExecuteRequestByType>

sign

Type Parameters

Parameters

Returns Promise<string>

getIsBlockedIp

Returns Promise<boolean>

getRequiresCloudflareAuth

Returns Promise<boolean>

getTime

Returns Promise<number>

Settings

On This Page

`Readonly`opts

`Readonly`axiosInstance