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

TypeScript SDK for the Maestro Dapp Platform

import { AxiosRequestConfig } from 'axios';
import { RequestArgs } from '../../base';
import {
    assertParamExists,
    DUMMY_BASE_URL,
    setApiKeyToObject,
    setSearchParams,
    toPathString,
    serializeDataIfNeeded,
    createRequestFunction,
    HEADER_AMOUNTS_AS_STRING,
} from '../../common';
import { Configuration } from '../../configuration';
import {
    TimestampedAddress,
    TimestampedTxCbor,
    TimestampedTransactionInfo,
    TimestampedUtxo,
    PaginatedUtxoWithBytes,
} from '../type';
import { TxoByTxoRefQueryParams, TxosByTxoRefsQueryParams } from './type';

/**
 * TransactionsApi - axios parameter creator
 * @export
 */
export const TransactionsApiAxiosParamCreator = (configuration: Configuration) => ({
    /**
     * 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}
     */
    addressByTxo: (txHash: string, index: number, options: AxiosRequestConfig = {}): RequestArgs => {
        // verify required parameter 'txHash' is not null or undefined
        assertParamExists('addressByTxo', 'txHash', txHash);
        // verify required parameter 'index' is not null or undefined
        assertParamExists('addressByTxo', 'index', index);
        const localVarPath = `/transactions/{tx_hash}/outputs/{index}/address`
            .replace(`{${'tx_hash'}}`, encodeURIComponent(String(txHash)))
            .replace(`{${'index'}}`, encodeURIComponent(String(index)));
        // use dummy base URL string because the URL constructor only accepts absolute URLs.
        const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
        const { baseOptions } = configuration;

        const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
        const localVarHeaderParameter = {} as Record<string, string>;
        const localVarQueryParameter = {} as Record<string, string>;

        // authentication api-key required
        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);

        setSearchParams(localVarUrlObj, localVarQueryParameter);
        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
        localVarRequestOptions.headers = {
            ...localVarHeaderParameter,
            ...headersFromBaseOptions,
            ...options.headers,
        };

        return {
            url: toPathString(localVarUrlObj),
            options: localVarRequestOptions,
        };
    },
    /**
     * 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}
     */
    txCborByTxHash: (txHash: string, options: AxiosRequestConfig = {}): RequestArgs => {
        // verify required parameter 'txHash' is not null or undefined
        assertParamExists('txCborByTxHash', 'txHash', txHash);
        const localVarPath = `/transactions/{tx_hash}/cbor`.replace(
            `{${'tx_hash'}}`,
            encodeURIComponent(String(txHash)),
        );
        // use dummy base URL string because the URL constructor only accepts absolute URLs.
        const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
        const { baseOptions } = configuration;

        const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
        const localVarHeaderParameter = {} as Record<string, string>;
        const localVarQueryParameter = {} as Record<string, string>;

        // authentication api-key required
        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);

        setSearchParams(localVarUrlObj, localVarQueryParameter);
        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
        localVarRequestOptions.headers = {
            ...localVarHeaderParameter,
            ...headersFromBaseOptions,
            ...options.headers,
        };

        return {
            url: toPathString(localVarUrlObj),
            options: localVarRequestOptions,
        };
    },
    /**
     * Returns detailed information about a transaction
     * @summary Transaction details
     * @param {string} txHash Transaction hash in hex
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    txInfo: (txHash: string, options: AxiosRequestConfig = {}): RequestArgs => {
        // verify required parameter 'txHash' is not null or undefined
        assertParamExists('txInfo', 'txHash', txHash);
        const localVarPath = `/transactions/{tx_hash}`.replace(`{${'tx_hash'}}`, encodeURIComponent(String(txHash)));
        // use dummy base URL string because the URL constructor only accepts absolute URLs.
        const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
        const { baseOptions } = configuration;

        const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
        const localVarHeaderParameter = {} as Record<string, string>;
        const localVarQueryParameter = {} as Record<string, string>;

        // authentication api-key required
        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);

        setSearchParams(localVarUrlObj, localVarQueryParameter);
        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
        localVarRequestOptions.headers = {
            ...localVarHeaderParameter,
            ...headersFromBaseOptions,
            ...options.headers,
        };

        return {
            url: toPathString(localVarUrlObj),
            options: localVarRequestOptions,
        };
    },
    /**
     * Returns the specified transaction output.
     * @summary Transaction output by output reference
     * @param {string} txHash Transaction Hash
     * @param {number} index Output Index
     * @param {TxoByTxoRefQueryParams} [localVarQueryParameter] Query Parameters
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    txoByTxoRef: (
        txHash: string,
        index: number,
        localVarQueryParameter: TxoByTxoRefQueryParams = {},
        options: AxiosRequestConfig = {},
    ): RequestArgs => {
        // verify required parameter 'txHash' is not null or undefined
        assertParamExists('txoByTxoRef', 'txHash', txHash);
        // verify required parameter 'index' is not null or undefined
        assertParamExists('txoByTxoRef', 'index', index);
        const localVarPath = `/transactions/{tx_hash}/outputs/{index}/txo`
            .replace(`{${'tx_hash'}}`, encodeURIComponent(String(txHash)))
            .replace(`{${'index'}}`, encodeURIComponent(String(index)));
        // use dummy base URL string because the URL constructor only accepts absolute URLs.
        const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
        const { baseOptions } = configuration;

        const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
        const localVarHeaderParameter = {} as Record<string, string>;

        // authentication api-key required
        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);

        setSearchParams(localVarUrlObj, localVarQueryParameter);
        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
        localVarRequestOptions.headers = {
            ...localVarHeaderParameter,
            ...headersFromBaseOptions,
            ...options.headers,
        };

        return {
            url: toPathString(localVarUrlObj),
            options: localVarRequestOptions,
        };
    },
    /**
     * Returns the specified transaction outputs
     * @summary Transaction outputs by output references
     * @param {Array<string>} requestBody
     * @param {TxosByTxoRefsQueryParams} [localVarQueryParameter] Query Parameters
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    txosByTxoRefs: (
        requestBody: Array<string>,
        localVarQueryParameter: TxosByTxoRefsQueryParams = {},
        options: AxiosRequestConfig = {},
    ): RequestArgs => {
        // verify required parameter 'requestBody' is not null or undefined
        assertParamExists('txosByTxoRefs', 'requestBody', requestBody);
        const localVarPath = `/transactions/outputs`;
        // use dummy base URL string because the URL constructor only accepts absolute URLs.
        const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
        const { baseOptions } = configuration;

        const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
        const localVarHeaderParameter = {} as Record<string, string>;

        // authentication api-key required
        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);

        localVarHeaderParameter['Content-Type'] = 'application/json';

        setSearchParams(localVarUrlObj, localVarQueryParameter);
        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
        localVarRequestOptions.headers = {
            ...localVarHeaderParameter,
            ...headersFromBaseOptions,
            ...options.headers,
            ...HEADER_AMOUNTS_AS_STRING,
        };
        localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration);

        return {
            url: toPathString(localVarUrlObj),
            options: localVarRequestOptions,
        };
    },
});

/**
 * TransactionsApi - functional programming interface
 * @export
 */
export const TransactionsApiFp = (configuration: Configuration) => {
    const localVarAxiosParamCreator = TransactionsApiAxiosParamCreator(configuration);
    return {
        /**
         * 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}
         */
        addressByTxo(txHash: string, index: number, options?: AxiosRequestConfig): () => Promise<TimestampedAddress> {
            const localVarAxiosArgs = localVarAxiosParamCreator.addressByTxo(txHash, index, options);
            return createRequestFunction(localVarAxiosArgs, configuration);
        },
        /**
         * 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}
         */
        txCborByTxHash(txHash: string, options?: AxiosRequestConfig): () => Promise<TimestampedTxCbor> {
            const localVarAxiosArgs = localVarAxiosParamCreator.txCborByTxHash(txHash, options);
            return createRequestFunction(localVarAxiosArgs, configuration);
        },
        /**
         * Returns detailed information about a transaction
         * @summary Transaction details
         * @param {string} txHash Transaction hash in hex
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        txInfo(txHash: string, options?: AxiosRequestConfig): () => Promise<TimestampedTransactionInfo> {
            const localVarAxiosArgs = localVarAxiosParamCreator.txInfo(txHash, options);
            return createRequestFunction(localVarAxiosArgs, configuration);
        },
        /**
         * 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}
         */
        txoByTxoRef(
            txHash: string,
            index: number,
            queryParams?: TxoByTxoRefQueryParams,
            options?: AxiosRequestConfig,
        ): () => Promise<TimestampedUtxo> {
            const localVarAxiosArgs = localVarAxiosParamCreator.txoByTxoRef(txHash, index, queryParams, options);
            return createRequestFunction(localVarAxiosArgs, configuration);
        },
        /**
         * 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}
         */
        txosByTxoRefs(
            requestBody: Array<string>,
            queryParams?: TxosByTxoRefsQueryParams,
            options?: AxiosRequestConfig,
        ): () => Promise<PaginatedUtxoWithBytes> {
            const localVarAxiosArgs = localVarAxiosParamCreator.txosByTxoRefs(requestBody, queryParams, options);
            return createRequestFunction(localVarAxiosArgs, configuration);
        },
    };
};