ContractInvocationsApi - interface

Export

ContractInvocationsApi

interface ContractInvocationsApiInterface {
    broadcastContractInvocation(walletId, addressId, contractInvocationId, broadcastContractInvocationRequest, options?): AxiosPromise<ContractInvocation>;
    createContractInvocation(walletId, addressId, createContractInvocationRequest, options?): AxiosPromise<ContractInvocation>;
    getContractInvocation(walletId, addressId, contractInvocationId, options?): AxiosPromise<ContractInvocation>;
    listContractInvocations(walletId, addressId, limit?, page?, options?): AxiosPromise<ContractInvocationList>;
}

Implemented by

Methods

  • Broadcast a contract invocation.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address the contract invocation belongs to.

    • contractInvocationId: string

      The ID of the contract invocation to broadcast.

    • broadcastContractInvocationRequest: BroadcastContractInvocationRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ContractInvocation>

    Summary

    Broadcast a contract invocation.

    Throws

    Memberof

    ContractInvocationsApiInterface

  • Create a new contract invocation.

    Parameters

    • walletId: string

      The ID of the wallet the source address belongs to.

    • addressId: string

      The ID of the address to invoke the contract from.

    • createContractInvocationRequest: CreateContractInvocationRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ContractInvocation>

    Summary

    Create a new contract invocation for an address.

    Throws

    Memberof

    ContractInvocationsApiInterface

  • Get a contract invocation by ID.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address the contract invocation belongs to.

    • contractInvocationId: string

      The ID of the contract invocation to fetch.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ContractInvocation>

    Summary

    Get a contract invocation by ID.

    Throws

    Memberof

    ContractInvocationsApiInterface

  • List contract invocations for an address.

    Parameters

    • walletId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The ID of the address to list contract invocations for.

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ContractInvocationList>

    Summary

    List contract invocations for an address.

    Throws

    Memberof

    ContractInvocationsApiInterface