@maestro-org/typescript-sdk/src/api/transactions/index.ts

TypeScript SDK for the Maestro Dapp Platform

import { AxiosRequestConfig } from 'axios';
import { BaseAPI } from '../../base';
import { TransactionsApiFp } from './helpers';
import { TxoByTxoRefQueryParams, TxosByTxoRefsQueryParams } from './type';

/**
 * TransactionsApi - object-oriented interface
 * @export
 * @class TransactionsApi
 * @extends {BaseAPI}
 */
export class TransactionsApi extends BaseAPI {
    /**
     * Returns the address which was specified in the given transaction output.  Note that if the transaction is invalid this will only return a result for the collateral return output, should one be present in the transaction. If the transaction is valid it will not return a result for the collateral return output.
     * @summary Address by transaction output reference
     * @param {string} txHash Transaction Hash
     * @param {number} index Output Index
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TransactionsApi
     */
    public addressByTxo(txHash: string, index: number, options?: AxiosRequestConfig) {
        return TransactionsApiFp(this.configuration).addressByTxo(txHash, index, options)();
    }

    /**
     * Returns hex-encoded CBOR bytes of a transaction
     * @summary CBOR bytes of a transaction
     * @param {string} txHash Transaction Hash
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TransactionsApi
     */
    public txCborByTxHash(txHash: string, options?: AxiosRequestConfig) {
        return TransactionsApiFp(this.configuration).txCborByTxHash(txHash, options)();
    }

    /**
     * Returns detailed information about a transaction
     * @summary Transaction details
     * @param {string} txHash Transaction hash in hex
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TransactionsApi
     */
    public txInfo(txHash: string, options?: AxiosRequestConfig) {
        return TransactionsApiFp(this.configuration).txInfo(txHash, options)();
    }

    /**
     * Returns the specified transaction output.
     * @summary Transaction output by output reference
     * @param {string} txHash Transaction Hash
     * @param {number} index Output Index
     * @param {TxoByTxoRefQueryParams} [queryParams] Query Parameters
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TransactionsApi
     */
    public txoByTxoRef(
        txHash: string,
        index: number,
        queryParams?: TxoByTxoRefQueryParams,
        options?: AxiosRequestConfig,
    ) {
        return TransactionsApiFp(this.configuration).txoByTxoRef(txHash, index, queryParams, options)();
    }

    /**
     * Returns the specified transaction outputs
     * @summary Transaction outputs by output references
     * @param {Array<string>} requestBody
     * @param {TxosByTxoRefsQueryParams} [queryParams] Query Parameters
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TransactionsApi
     */
    public txosByTxoRefs(
        requestBody: Array<string>,
        queryParams?: TxosByTxoRefsQueryParams,
        options?: AxiosRequestConfig,
    ) {
        return TransactionsApiFp(this.configuration).txosByTxoRefs(requestBody, queryParams, options)();
    }
}