Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ContractsApi

Index

Constructors

  • new ContractsApi(configuration: Configuration, requestFactory?: ContractsApiRequestFactory, responseProcessor?: ContractsApiResponseProcessor): ContractsApi

Properties

api: ObservableContractsApi

Methods

  • List of all contracts per project. By default, a maximum of ten contracts are shown. List contracts.

    Parameters

    • Optional limit: number

      Specifies the maximum number of records to return.

    • Optional skip: number

      Specifies the offset for the first records to return.

    • Optional order: SortOrder

      Specifies the order in which to sort the results.

    • Optional name: string

      Specifies the name of the contract.

    • Optional deleted: boolean

      Specifies whether to include deleted contracts.

    • Optional chainId: number

      The chain ID of the contract.

    • Optional address: string

      Specifies the address of the contract.

    • Optional _options: Configuration

    Returns Promise<ContractListResponse>

  • Using this endpoint, you can get the repositories returned by any readable function listed in a contracts ABI. This could be things like querying the totalSupply of a currency contract, the number of owners of an items contract, and more. Read on chain contract repositories.

    Parameters

    • id: string

      Specifies the unique contract ID (starts with con_).

    • functionName: string

      The function name of the contract.

    • Optional functionArgs: any[]

      The function arguments of the contract, in string format. Accepts pla_, con_ and acc_ IDs.

    • Optional _options: Configuration

    Returns Promise<ContractReadResponse>

Generated using TypeDoc