@alephium/web3 0.5.0-rc.8 → 0.5.0

package/dist/src/api/api-explorer.d.ts

@@ -1,3 +1,19 @@
+export interface AcceptedTransaction {
+    /** @format 32-byte-hash */
+    hash: string;
+    /** @format block-hash */
+    blockHash: string;
+    /** @format int64 */
+    timestamp: number;
+    inputs?: Input[];
+    outputs?: Output[];
+    /** @format int32 */
+    gasAmount: number;
+    /** @format uint256 */
+    gasPrice: string;
+    coinbase: boolean;
+    type: string;
+}
 export interface AddressBalance {
     /** @format uint256 */
     balance: string;
@@ -19,6 +35,7 @@ export interface AssetOutput {
     key: string;
     /** @format uint256 */
     attoAlphAmount: string;
+    /** @format address */
     address: string;
     tokens?: Token[];
     /** @format int64 */
@@ -49,22 +66,6 @@ export interface BlockEntryLite {
     /** @format bigint */
     hashRate: string;
 }
-export interface ConfirmedTransaction {
-    /** @format 32-byte-hash */
-    hash: string;
-    /** @format block-hash */
-    blockHash: string;
-    /** @format int64 */
-    timestamp: number;
-    inputs?: Input[];
-    outputs?: Output[];
-    /** @format int32 */
-    gasAmount: number;
-    /** @format uint256 */
-    gasPrice: string;
-    coinbase: boolean;
-    type: string;
-}
 export interface ContractOutput {
     /** @format int32 */
     hint: number;
@@ -72,6 +73,7 @@ export interface ContractOutput {
     key: string;
     /** @format uint256 */
     attoAlphAmount: string;
+    /** @format address */
     address: string;
     tokens?: Token[];
     /** @format 32-byte-hash */
@@ -83,7 +85,9 @@ export interface Event {
     blockHash: string;
     /** @format 32-byte-hash */
     txHash: string;
+    /** @format address */
     contractAddress: string;
+    /** @format address */
     inputAddress?: string;
     /** @format int32 */
     eventIndex: number;
@@ -105,6 +109,7 @@ export interface Input {
     unlockScript?: string;
     /** @format 32-byte-hash */
     txHashRef?: string;
+    /** @format address */
     address?: string;
     /** @format uint256 */
     attoAlphAmount?: string;
@@ -126,6 +131,22 @@ export interface LogbackValue {
     name: string;
     level: string;
 }
+export interface MempoolTransaction {
+    /** @format 32-byte-hash */
+    hash: string;
+    /** @format int32 */
+    chainFrom: number;
+    /** @format int32 */
+    chainTo: number;
+    inputs?: Input[];
+    outputs?: Output[];
+    /** @format int32 */
+    gasAmount: number;
+    /** @format uint256 */
+    gasPrice: string;
+    /** @format int64 */
+    lastSeen: number;
+}
 export interface NotFound {
     detail: string;
     resource: string;
@@ -137,6 +158,23 @@ export interface OutputRef {
     /** @format 32-byte-hash */
     key: string;
 }
+export interface PendingTransaction {
+    /** @format 32-byte-hash */
+    hash: string;
+    /** @format int32 */
+    chainFrom: number;
+    /** @format int32 */
+    chainTo: number;
+    inputs?: Input[];
+    outputs?: Output[];
+    /** @format int32 */
+    gasAmount: number;
+    /** @format uint256 */
+    gasPrice: string;
+    /** @format int64 */
+    lastSeen: number;
+    type: string;
+}
 export interface PerChainCount {
     /** @format int32 */
     chainFrom: number;
@@ -214,27 +252,10 @@ export interface Transaction {
     gasPrice: string;
     coinbase: boolean;
 }
-export declare type TransactionLike = ConfirmedTransaction | UnconfirmedTransaction;
+export declare type TransactionLike = AcceptedTransaction | PendingTransaction;
 export interface Unauthorized {
     detail: string;
 }
-export interface UnconfirmedTransaction {
-    /** @format 32-byte-hash */
-    hash: string;
-    /** @format int32 */
-    chainFrom: number;
-    /** @format int32 */
-    chainTo: number;
-    inputs?: Input[];
-    outputs?: Output[];
-    /** @format int32 */
-    gasAmount: number;
-    /** @format uint256 */
-    gasPrice: string;
-    /** @format int64 */
-    lastSeen: number;
-    type: string;
-}
 export declare type Val = ValAddress | ValArray | ValBool | ValByteVec | ValI256 | ValU256;
 export interface ValAddress {
     /** @format address */
@@ -300,7 +321,8 @@ declare type CancelToken = Symbol | string | number;
 export declare enum ContentType {
     Json = "application/json",
     FormData = "multipart/form-data",
-    UrlEncoded = "application/x-www-form-urlencoded"
+    UrlEncoded = "application/x-www-form-urlencoded",
+    Text = "text/plain"
 }
 export declare class HttpClient<SecurityDataType = unknown> {
     baseUrl: string;
@@ -311,14 +333,14 @@ export declare class HttpClient<SecurityDataType = unknown> {
     private baseApiParams;
     constructor(apiConfig?: ApiConfig<SecurityDataType>);
     setSecurityData: (data: SecurityDataType | null) => void;
-    private encodeQueryParam;
-    private addQueryParam;
-    private addArrayQueryParam;
+    protected encodeQueryParam(key: string, value: any): string;
+    protected addQueryParam(query: QueryParamsType, key: string): string;
+    protected addArrayQueryParam(query: QueryParamsType, key: string): any;
     protected toQueryString(rawQuery?: QueryParamsType): string;
     protected addQueryParams(rawQuery?: QueryParamsType): string;
     private contentFormatters;
-    private mergeRequestParams;
-    private createAbortSignal;
+    protected mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams;
+    protected createAbortSignal: (cancelToken: CancelToken) => AbortSignal | undefined;
     abortRequest: (cancelToken: CancelToken) => void;
     request: <T = any, E = any>({ body, secure, path, type, query, format, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
 }
@@ -336,8 +358,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/blocks
          */
         getBlocks: (query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, params?: RequestParams) => Promise<ListBlocks>;
         /**
@@ -356,8 +387,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/blocks/{block_hash}/transactions
          */
         getBlocksBlockHashTransactions: (blockHash: string, query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, params?: RequestParams) => Promise<Transaction[]>;
     };
@@ -369,7 +409,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name GetTransactionsTransactionHash
          * @request GET:/transactions/{transaction_hash}
          */
-        getTransactionsTransactionHash: (transactionHash: string, params?: RequestParams) => Promise<ConfirmedTransaction | UnconfirmedTransaction>;
+        getTransactionsTransactionHash: (transactionHash: string, params?: RequestParams) => Promise<AcceptedTransaction | PendingTransaction>;
     };
     addresses: {
         /**
@@ -388,8 +428,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/addresses/{address}/transactions
          */
         getAddressesAddressTransactions: (address: string, query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, params?: RequestParams) => Promise<Transaction[]>;
         /**
@@ -400,8 +449,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/addresses/transactions
          */
         postAddressesTransactions: (query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, data?: string[], params?: RequestParams) => Promise<Transaction[]>;
         /**
@@ -412,10 +470,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/addresses/{address}/timeranged-transactions
          */
         getAddressesAddressTimerangedTransactions: (address: string, query: {
+            /**
+             * @format int64
+             * @min 0
+             */
             fromTs: number;
+            /**
+             * @format int64
+             * @min 0
+             */
             toTs: number;
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, params?: RequestParams) => Promise<Transaction[]>;
         /**
@@ -427,13 +502,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getAddressesAddressTotalTransactions: (address: string, params?: RequestParams) => Promise<number>;
         /**
-         * @description List unconfirmed transactions of a given address
+         * @description List mempool transactions of a given address
          *
          * @tags Addresses
-         * @name GetAddressesAddressUnconfirmedTransactions
-         * @request GET:/addresses/{address}/unconfirmed-transactions
+         * @name GetAddressesAddressMempoolTransactions
+         * @request GET:/addresses/{address}/mempool/transactions
          */
-        getAddressesAddressUnconfirmedTransactions: (address: string, params?: RequestParams) => Promise<TransactionLike[]>;
+        getAddressesAddressMempoolTransactions: (address: string, params?: RequestParams) => Promise<MempoolTransaction[]>;
         /**
          * @description Get address balance
          *
@@ -458,8 +533,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/addresses/{address}/tokens/{token_id}/transactions
          */
         getAddressesAddressTokensTokenIdTransactions: (address: string, tokenId: string, query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, params?: RequestParams) => Promise<Transaction[]>;
         /**
@@ -486,7 +570,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/addresses/{address}/export-transactions/csv
          */
         getAddressesAddressExportTransactionsCsv: (address: string, query: {
+            /**
+             * @format int64
+             * @min 0
+             */
             fromTs: number;
+            /**
+             * @format int64
+             * @min 0
+             */
             toTs: number;
         }, params?: RequestParams) => Promise<string>;
     };
@@ -515,8 +607,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/infos/supply
          */
         getInfosSupply: (query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, params?: RequestParams) => Promise<TokenSupply[]>;
         /**
@@ -568,19 +669,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getInfosAverageBlockTimes: (params?: RequestParams) => Promise<PerChainDuration[]>;
     };
-    unconfirmedTransactions: {
+    mempool: {
         /**
-         * @description list unconfirmed transactions
+         * @description list mempool transactions
          *
-         * @tags Transactions
-         * @name GetUnconfirmedTransactions
-         * @request GET:/unconfirmed-transactions
+         * @tags Mempool
+         * @name GetMempoolTransactions
+         * @request GET:/mempool/transactions
          */
-        getUnconfirmedTransactions: (query?: {
+        getMempoolTransactions: (query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
-        }, params?: RequestParams) => Promise<TransactionLike[]>;
+        }, params?: RequestParams) => Promise<MempoolTransaction[]>;
     };
     tokens: {
         /**
@@ -591,8 +701,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/tokens
          */
         getTokens: (query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, params?: RequestParams) => Promise<string[]>;
         /**
@@ -603,8 +722,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/tokens/{token_id}/transactions
          */
         getTokensTokenIdTransactions: (tokenId: string, query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, params?: RequestParams) => Promise<Transaction[]>;
     };
@@ -618,7 +746,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/charts/hashrates
          */
         getChartsHashrates: (query: {
+            /**
+             * @format int64
+             * @min 0
+             */
             fromTs: number;
+            /**
+             * @format int64
+             * @min 0
+             */
             toTs: number;
             'interval-type': IntervalType;
         }, params?: RequestParams) => Promise<Hashrate[]>;
@@ -631,7 +767,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/charts/transactions-count
          */
         getChartsTransactionsCount: (query: {
+            /**
+             * @format int64
+             * @min 0
+             */
             fromTs: number;
+            /**
+             * @format int64
+             * @min 0
+             */
             toTs: number;
             'interval-type': IntervalType;
         }, params?: RequestParams) => Promise<TimedCount[]>;
@@ -644,7 +788,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/charts/transactions-count-per-chain
          */
         getChartsTransactionsCountPerChain: (query: {
+            /**
+             * @format int64
+             * @min 0
+             */
             fromTs: number;
+            /**
+             * @format int64
+             * @min 0
+             */
             toTs: number;
             'interval-type': IntervalType;
         }, params?: RequestParams) => Promise<PerChainTimedCount[]>;
@@ -666,8 +818,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/contract-events/contract-address/{contract_address}
          */
         getContractEventsContractAddressContractAddress: (contractAddress: string, query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, params?: RequestParams) => Promise<Event[]>;
         /**
@@ -678,8 +839,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/contract-events/contract-address/{contract_address}/input-address/{input_address}
          */
         getContractEventsContractAddressContractAddressInputAddressInputAddress: (contractAddress: string, inputAddress: string, query?: {
+            /**
+             * Page number
+             * @format int32
+             */
             page?: number;
+            /**
+             * Number of items per page
+             * @format int32
+             */
             limit?: number;
+            /** Reverse pagination */
             reverse?: boolean;
         }, params?: RequestParams) => Promise<Event[]>;
     };

package/dist/src/api/api-explorer.js

@@ -23,6 +23,7 @@ var ContentType;
     ContentType["Json"] = "application/json";
     ContentType["FormData"] = "multipart/form-data";
     ContentType["UrlEncoded"] = "application/x-www-form-urlencoded";
+    ContentType["Text"] = "text/plain";
 })(ContentType = exports.ContentType || (exports.ContentType = {}));
 class HttpClient {
     constructor(apiConfig = {}) {
@@ -41,6 +42,7 @@ class HttpClient {
         };
         this.contentFormatters = {
             [ContentType.Json]: (input) => input !== null && (typeof input === 'object' || typeof input === 'string') ? JSON.stringify(input) : input,
+            [ContentType.Text]: (input) => (input !== null && typeof input !== 'string' ? JSON.stringify(input) : input),
             [ContentType.FormData]: (input) => Object.keys(input || {}).reduce((formData, key) => {
                 const property = input[key];
                 formData.append(key, property instanceof Blob
@@ -83,10 +85,10 @@ class HttpClient {
             return this.customFetch(`${baseUrl || this.baseUrl || ''}${path}${queryString ? `?${queryString}` : ''}`, {
                 ...requestParams,
                 headers: {
-                    ...(type && type !== ContentType.FormData ? { 'Content-Type': type } : {}),
-                    ...(requestParams.headers || {})
+                    ...(requestParams.headers || {}),
+                    ...(type && type !== ContentType.FormData ? { 'Content-Type': type } : {})
                 },
-                signal: cancelToken ? this.createAbortSignal(cancelToken) : void 0,
+                signal: cancelToken ? this.createAbortSignal(cancelToken) : requestParams.signal,
                 body: typeof body === 'undefined' || body === null ? null : payloadFormatter(body)
             }).then(async (response) => {
                 const r = response;
@@ -289,14 +291,14 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description List unconfirmed transactions of a given address
+             * @description List mempool transactions of a given address
              *
              * @tags Addresses
-             * @name GetAddressesAddressUnconfirmedTransactions
-             * @request GET:/addresses/{address}/unconfirmed-transactions
+             * @name GetAddressesAddressMempoolTransactions
+             * @request GET:/addresses/{address}/mempool/transactions
              */
-            getAddressesAddressUnconfirmedTransactions: (address, params = {}) => this.request({
-                path: `/addresses/${address}/unconfirmed-transactions`,
+            getAddressesAddressMempoolTransactions: (address, params = {}) => this.request({
+                path: `/addresses/${address}/mempool/transactions`,
                 method: 'GET',
                 format: 'json',
                 ...params
@@ -498,16 +500,16 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse)
         };
-        this.unconfirmedTransactions = {
+        this.mempool = {
             /**
-             * @description list unconfirmed transactions
+             * @description list mempool transactions
              *
-             * @tags Transactions
-             * @name GetUnconfirmedTransactions
-             * @request GET:/unconfirmed-transactions
+             * @tags Mempool
+             * @name GetMempoolTransactions
+             * @request GET:/mempool/transactions
              */
-            getUnconfirmedTransactions: (query, params = {}) => this.request({
-                path: `/unconfirmed-transactions`,
+            getMempoolTransactions: (query, params = {}) => this.request({
+                path: `/mempool/transactions`,
                 method: 'GET',
                 query: query,
                 format: 'json',

package/dist/src/api/explorer-provider.d.ts

@@ -0,0 +1,18 @@
+import { ApiRequestArguments, ApiRequestHandler } from './types';
+import { Api as ExplorerApi } from './api-explorer';
+export declare class ExplorerProvider {
+    readonly blocks: ExplorerApi<string>['blocks'];
+    readonly transactions: ExplorerApi<string>['transactions'];
+    readonly addresses: ExplorerApi<string>['addresses'];
+    readonly infos: ExplorerApi<string>['infos'];
+    readonly mempool: ExplorerApi<string>['mempool'];
+    readonly tokens: ExplorerApi<string>['tokens'];
+    readonly charts: ExplorerApi<string>['charts'];
+    readonly utils: ExplorerApi<string>['utils'];
+    constructor(baseUrl: string, apiKey?: string);
+    constructor(provider: ExplorerProvider);
+    constructor(handler: ApiRequestHandler);
+    request: (args: ApiRequestArguments) => Promise<any>;
+    static Proxy(explorerProvider: ExplorerProvider): ExplorerProvider;
+    static Remote(handler: ApiRequestHandler): ExplorerProvider;
+}

package/dist/src/api/explorer-provider.js

@@ -0,0 +1,65 @@
+"use strict";
+/*
+Copyright 2018 - 2022 The Alephium Authors
+This file is part of the alephium project.
+
+The library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+The library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with the library. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExplorerProvider = void 0;
+const types_1 = require("./types");
+const api_explorer_1 = require("./api-explorer");
+function initializeExplorerApi(baseUrl, apiKey) {
+    const explorerApi = new api_explorer_1.Api({
+        baseUrl: baseUrl,
+        baseApiParams: { secure: true },
+        securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {})
+    });
+    explorerApi.setSecurityData(apiKey ?? null);
+    return explorerApi;
+}
+class ExplorerProvider {
+    constructor(param0, apiKey) {
+        this.request = (args) => {
+            return (0, types_1.request)(this, args);
+        };
+        let explorerApi;
+        if (typeof param0 === 'string') {
+            explorerApi = initializeExplorerApi(param0, apiKey);
+        }
+        else if (typeof param0 === 'function') {
+            explorerApi = new ExplorerProvider('https://1.2.3.4:0');
+            (0, types_1.forwardRequests)(explorerApi, param0);
+        }
+        else {
+            explorerApi = param0;
+        }
+        this.blocks = { ...explorerApi.blocks };
+        this.transactions = { ...explorerApi.transactions };
+        this.addresses = { ...explorerApi.addresses };
+        this.infos = { ...explorerApi.infos };
+        this.mempool = { ...explorerApi.mempool };
+        this.tokens = { ...explorerApi.tokens };
+        this.charts = { ...explorerApi.charts };
+        this.utils = { ...explorerApi.utils };
+    }
+    // This can prevent the proxied explorer provider from being modified
+    static Proxy(explorerProvider) {
+        return new ExplorerProvider(explorerProvider);
+    }
+    static Remote(handler) {
+        return new ExplorerProvider(handler);
+    }
+}
+exports.ExplorerProvider = ExplorerProvider;