Class GetTransactionProof

Base abstract class for JSON requests.

Data: The type returned from the do() method

Body: The structure of the response's body

Hierarchy

Constructors

Properties

Methods - JSONRequest

Methods - Other

Methods - query

Constructors

Properties

intDecoding: IntDecoding
query: Record<string, any>

JSONRequest Methods

  • Execute the request.

    Returns

    A promise which resolves to the parsed response data.

    Parameters

    • headers: Record<string, any> = {}

      Additional headers to send in the request. Optional.

    Returns Promise<Record<string, any>>

  • Execute the request, but do not process the response data in any way.

    Returns

    A promise which resolves to the raw response data, exactly as returned by the server.

    Parameters

    • headers: Record<string, any> = {}

      Additional headers to send in the request. Optional.

    Returns Promise<Uint8Array>

  • Prepare a JSON response before returning it.

    Use this method to change and restructure response data as needed after receiving it from the do() method.

    Parameters

    • body: Uint8Array | Record<string, any>

      Response body received

    Returns Record<string, any>

  • Configure how integers in this request's JSON response will be decoded.

    The options are:

    • "default": Integers will be decoded according to JSON.parse, meaning they will all be Numbers and any values greater than Number.MAX_SAFE_INTEGER will lose precision.
    • "safe": All integers will be decoded as Numbers, but if any values are greater than Number.MAX_SAFE_INTEGER an error will be thrown.
    • "mixed": Integers will be decoded as Numbers if they are less than or equal to Number.MAX_SAFE_INTEGER, otherwise they will be decoded as BigInts.
    • "bigint": All integers will be decoded as BigInts.

    Parameters

    • method: IntDecoding

      The method to use when parsing the response for this request. Must be one of "default", "safe", "mixed", or "bigint".

    Returns GetTransactionProof

Other Methods

query Methods

  • Exclude assets and application data from results The type of hash function used to create the proof, must be one of: "sha512_256", "sha256"

    Example

    const hashType = "sha256";
    const round = 123456;
    const txId = "abc123;
    const txProof = await algodClient.getTransactionProof(round, txId)
    .hashType(hashType)
    .do();

    Parameters

    • hashType: string

    Returns GetTransactionProof

Generated using TypeDoc