Hierarchy

Constructors

Properties

axiosInstance: AxiosInstance
payloadBuilder: EngineExecuteBuilder

Methods

  • 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

  • Parameters

    • Optionaladdress: string

    Returns Promise<string>

  • Signs a given request with the signer provided to the engine

    Type Parameters

    Parameters

    Returns Promise<string>

  • Retrieves a subaccount summary reflective of the state within the offchain engine. This adheres to the same return interface as the contract version

    Parameters

    Returns Promise<SubaccountSummaryResponse>

  • Retrieves the estimated max order size for a product

    Parameters

    Returns Promise<BigNumber>

  • Retrieves the estimated max withdrawal size for a product

    Returns Promise<BigNumber>

  • Gets the orderbook contract address for a given product

    Parameters

    • productId: number

    Returns Promise<string>

  • Determines whether client IP is blocked from interacting with the engine

    Returns 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

  • Retrieves current server epoch in milliseconds

    Returns Promise<number>