@shapeshiftoss/unchained-client 0.1.3 → 0.2.3

package/README.md

@@ -0,0 +1,26 @@
+# Unchained API Client
+
+Provides a typescript axios client to interact with all supported unchained API's
+
+## Installing
+
+Using npm:
+```
+npm install @shapeshiftoss/unchained-client
+```
+
+Using yarn:
+```
+yarn add @shapeshiftoss/unchained-client
+```
+
+## Usage
+
+```
+import { Ethereum } from '@shapeshiftoss/unchained-client'
+
+const config = new Ethereum.Configuration({ basePath: 'https://api.ethereum.shapeshift.com' })
+const ethClient = new Ethereum.V1Api(config)
+
+const { data } = await ethClient.getBalance({ pubkey: '0xB3DD70991aF983Cf82d95c46C24979ee98348ffa' })
+```

package/dist/generated/bitcoin/api.d.ts

@@ -0,0 +1,482 @@
+/**
+ * @shapeshiftoss/bitcoin-api
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Configuration } from './configuration';
+import { AxiosPromise, AxiosInstance } from 'axios';
+import { RequestArgs, BaseAPI } from './base';
+/**
+ * Contains info about a 400 Bad Request response
+ * @export
+ * @interface BadRequestError
+ */
+export interface BadRequestError {
+    /**
+     *
+     * @type {string}
+     * @memberof BadRequestError
+     */
+    error: string;
+}
+/**
+ * Contains info about balance by pubkey (address or xpub)
+ * @export
+ * @interface Balance
+ */
+export interface Balance {
+    /**
+     *
+     * @type {string}
+     * @memberof Balance
+     */
+    pubkey: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Balance
+     */
+    balance: string;
+}
+/**
+ * Contains additional bitcoin specific balance info
+ * @export
+ * @interface BitcoinBalance
+ */
+export interface BitcoinBalance {
+    /**
+     *
+     * @type {string}
+     * @memberof BitcoinBalance
+     */
+    pubkey: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BitcoinBalance
+     */
+    balance: string;
+    /**
+     *
+     * @type {Array<Balance>}
+     * @memberof BitcoinBalance
+     */
+    addresses?: Array<Balance>;
+}
+/**
+ * Contains info about a 500 Internal Server Error response
+ * @export
+ * @interface InternalServerError
+ */
+export interface InternalServerError {
+    /**
+     *
+     * @type {string}
+     * @memberof InternalServerError
+     */
+    message: string;
+}
+/**
+ * Contains the serialized raw transaction hex
+ * @export
+ * @interface SendTxBody
+ */
+export interface SendTxBody {
+    /**
+     *
+     * @type {string}
+     * @memberof SendTxBody
+     */
+    hex: string;
+}
+/**
+ * Contains info about a transaction
+ * @export
+ * @interface Tx
+ */
+export interface Tx {
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    txid: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    status: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    blockHash?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Tx
+     */
+    blockHeight?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Tx
+     */
+    confirmations?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Tx
+     */
+    timestamp?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    from: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    to?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    value: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    fee: string;
+}
+/**
+ * Contains paginated transaction history
+ * @export
+ * @interface TxHistory
+ */
+export interface TxHistory {
+    /**
+     *
+     * @type {number}
+     * @memberof TxHistory
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TxHistory
+     */
+    totalPages: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TxHistory
+     */
+    txs: number;
+    /**
+     *
+     * @type {Array<Tx>}
+     * @memberof TxHistory
+     */
+    transactions: Array<Tx>;
+}
+/**
+ * Contains info about an unspent transaction output
+ * @export
+ * @interface Utxo
+ */
+export interface Utxo {
+    /**
+     *
+     * @type {string}
+     * @memberof Utxo
+     */
+    address: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Utxo
+     */
+    confirmations: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Utxo
+     */
+    txid: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Utxo
+     */
+    value: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Utxo
+     */
+    vout: number;
+}
+/**
+ * Contains info about a 422 Validation Error response
+ * @export
+ * @interface ValidationError
+ */
+export interface ValidationError {
+    /**
+     *
+     * @type {string}
+     * @memberof ValidationError
+     */
+    message: ValidationErrorMessageEnum;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof ValidationError
+     */
+    details: {
+        [key: string]: any;
+    };
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum ValidationErrorMessageEnum {
+    ValidationFailed = "Validation failed"
+}
+/**
+ * V1Api - axios parameter creator
+ * @export
+ */
+export declare const V1ApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Get balance of a pubkey  Examples 1. Bitcoin (address) 2. Bitcoin (xpub)
+     * @param {string} pubkey account pubkey
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBalance: (pubkey: string, options?: any) => Promise<RequestArgs>;
+    /**
+     * Get transaction history of a pubkey
+     * @param {string} address
+     * @param {number} [page] page number
+     * @param {number} [pageSize] page size
+     * @param {string} [contract] filter by contract address (only supported by coins which support contracts)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTxHistory: (address: string, page?: number | undefined, pageSize?: number | undefined, contract?: string | undefined, options?: any) => Promise<RequestArgs>;
+    /**
+     * Get all unspent transaction outputs for a pubkey
+     * @param {string} pubkey account pubkey
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUtxos: (pubkey: string, options?: any) => Promise<RequestArgs>;
+    /**
+     * Sends raw transaction to be broadcast to the node.
+     * @param {SendTxBody} sendTxBody serialized raw transaction hex
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendTx: (sendTxBody: SendTxBody, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * V1Api - functional programming interface
+ * @export
+ */
+export declare const V1ApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Get balance of a pubkey  Examples 1. Bitcoin (address) 2. Bitcoin (xpub)
+     * @param {string} pubkey account pubkey
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBalance(pubkey: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<BitcoinBalance>>;
+    /**
+     * Get transaction history of a pubkey
+     * @param {string} address
+     * @param {number} [page] page number
+     * @param {number} [pageSize] page size
+     * @param {string} [contract] filter by contract address (only supported by coins which support contracts)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTxHistory(address: string, page?: number | undefined, pageSize?: number | undefined, contract?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<TxHistory>>;
+    /**
+     * Get all unspent transaction outputs for a pubkey
+     * @param {string} pubkey account pubkey
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUtxos(pubkey: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Array<Utxo>>>;
+    /**
+     * Sends raw transaction to be broadcast to the node.
+     * @param {SendTxBody} sendTxBody serialized raw transaction hex
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendTx(sendTxBody: SendTxBody, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<string>>;
+};
+/**
+ * V1Api - factory interface
+ * @export
+ */
+export declare const V1ApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Get balance of a pubkey  Examples 1. Bitcoin (address) 2. Bitcoin (xpub)
+     * @param {string} pubkey account pubkey
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBalance(pubkey: string, options?: any): AxiosPromise<BitcoinBalance>;
+    /**
+     * Get transaction history of a pubkey
+     * @param {string} address
+     * @param {number} [page] page number
+     * @param {number} [pageSize] page size
+     * @param {string} [contract] filter by contract address (only supported by coins which support contracts)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTxHistory(address: string, page?: number | undefined, pageSize?: number | undefined, contract?: string | undefined, options?: any): AxiosPromise<TxHistory>;
+    /**
+     * Get all unspent transaction outputs for a pubkey
+     * @param {string} pubkey account pubkey
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUtxos(pubkey: string, options?: any): AxiosPromise<Array<Utxo>>;
+    /**
+     * Sends raw transaction to be broadcast to the node.
+     * @param {SendTxBody} sendTxBody serialized raw transaction hex
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendTx(sendTxBody: SendTxBody, options?: any): AxiosPromise<string>;
+};
+/**
+ * Request parameters for getBalance operation in V1Api.
+ * @export
+ * @interface V1ApiGetBalanceRequest
+ */
+export interface V1ApiGetBalanceRequest {
+    /**
+     * account pubkey
+     * @type {string}
+     * @memberof V1ApiGetBalance
+     */
+    readonly pubkey: string;
+}
+/**
+ * Request parameters for getTxHistory operation in V1Api.
+ * @export
+ * @interface V1ApiGetTxHistoryRequest
+ */
+export interface V1ApiGetTxHistoryRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof V1ApiGetTxHistory
+     */
+    readonly address: string;
+    /**
+     * page number
+     * @type {number}
+     * @memberof V1ApiGetTxHistory
+     */
+    readonly page?: number;
+    /**
+     * page size
+     * @type {number}
+     * @memberof V1ApiGetTxHistory
+     */
+    readonly pageSize?: number;
+    /**
+     * filter by contract address (only supported by coins which support contracts)
+     * @type {string}
+     * @memberof V1ApiGetTxHistory
+     */
+    readonly contract?: string;
+}
+/**
+ * Request parameters for getUtxos operation in V1Api.
+ * @export
+ * @interface V1ApiGetUtxosRequest
+ */
+export interface V1ApiGetUtxosRequest {
+    /**
+     * account pubkey
+     * @type {string}
+     * @memberof V1ApiGetUtxos
+     */
+    readonly pubkey: string;
+}
+/**
+ * Request parameters for sendTx operation in V1Api.
+ * @export
+ * @interface V1ApiSendTxRequest
+ */
+export interface V1ApiSendTxRequest {
+    /**
+     * serialized raw transaction hex
+     * @type {SendTxBody}
+     * @memberof V1ApiSendTx
+     */
+    readonly sendTxBody: SendTxBody;
+}
+/**
+ * V1Api - object-oriented interface
+ * @export
+ * @class V1Api
+ * @extends {BaseAPI}
+ */
+export declare class V1Api extends BaseAPI {
+    /**
+     * Get balance of a pubkey  Examples 1. Bitcoin (address) 2. Bitcoin (xpub)
+     * @param {V1ApiGetBalanceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getBalance(requestParameters: V1ApiGetBalanceRequest, options?: any): Promise<import("axios").AxiosResponse<BitcoinBalance>>;
+    /**
+     * Get transaction history of a pubkey
+     * @param {V1ApiGetTxHistoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getTxHistory(requestParameters: V1ApiGetTxHistoryRequest, options?: any): Promise<import("axios").AxiosResponse<TxHistory>>;
+    /**
+     * Get all unspent transaction outputs for a pubkey
+     * @param {V1ApiGetUtxosRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getUtxos(requestParameters: V1ApiGetUtxosRequest, options?: any): Promise<import("axios").AxiosResponse<Utxo[]>>;
+    /**
+     * Sends raw transaction to be broadcast to the node.
+     * @param {V1ApiSendTxRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    sendTx(requestParameters: V1ApiSendTxRequest, options?: any): Promise<import("axios").AxiosResponse<string>>;
+}
+//# sourceMappingURL=api.d.ts.map