@alephium/web3 0.28.0 → 0.29.0

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

@@ -37,6 +37,9 @@ export interface AddressTokenBalance {
     /** @format uint256 */
     lockedBalance: string;
 }
+export interface AmountHistory {
+    amountHistory?: TimedAmount[];
+}
 export interface AssetOutput {
     /** @format int32 */
     hint: number;
@@ -145,7 +148,8 @@ export interface InternalServerError {
 }
 export declare enum IntervalType {
     Daily = "daily",
-    Hourly = "hourly"
+    Hourly = "hourly",
+    Weekly = "weekly"
 }
 export interface ListBlocks {
     /** @format int32 */
@@ -253,12 +257,22 @@ export interface ServiceUnavailable {
 export interface SubContracts {
     subContracts?: string[];
 }
+export interface TimedAmount {
+    /** @format int64 */
+    timestamp: number;
+    /** @format bigint */
+    amount: string;
+}
 export interface TimedCount {
     /** @format int64 */
     timestamp: number;
     /** @format int64 */
     totalCountAllChains: number;
 }
+export interface TimedPrices {
+    timestamps?: number[];
+    prices?: number[];
+}
 export interface Token {
     /** @format 32-byte-hash */
     id: string;
@@ -662,6 +676,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             toTs: number;
         }, params?: RequestParams) => Promise<string>;
+        /**
+         * No description
+         *
+         * @tags Addresses
+         * @name GetAddressesAddressAmountHistoryDeprecated
+         * @request GET:/addresses/{address}/amount-history-DEPRECATED
+         * @deprecated
+         */
+        getAddressesAddressAmountHistoryDeprecated: (address: string, query: {
+            /**
+             * @format int64
+             * @min 0
+             */
+            fromTs: number;
+            /**
+             * @format int64
+             * @min 0
+             */
+            toTs: number;
+            'interval-type': IntervalType;
+        }, params?: RequestParams) => Promise<string>;
         /**
          * No description
          *
@@ -681,7 +716,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
              */
             toTs: number;
             'interval-type': IntervalType;
-        }, params?: RequestParams) => Promise<string>;
+        }, params?: RequestParams) => Promise<AmountHistory>;
     };
     infos: {
         /**
@@ -1008,6 +1043,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
         }, params?: RequestParams) => Promise<SubContracts>;
     };
+    market: {
+        /**
+         * No description
+         *
+         * @tags Market
+         * @name PostMarketPrices
+         * @request POST:/market/prices
+         */
+        postMarketPrices: (query: {
+            currency: string;
+        }, data?: string[], params?: RequestParams) => Promise<number[]>;
+        /**
+         * No description
+         *
+         * @tags Market
+         * @name GetMarketPricesSymbolCharts
+         * @request GET:/market/prices/{symbol}/charts
+         */
+        getMarketPricesSymbolCharts: (symbol: string, query: {
+            currency: string;
+        }, params?: RequestParams) => Promise<TimedPrices>;
+    };
     utils: {
         /**
          * @description Perform a sanity check

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

@@ -15,6 +15,7 @@ var IntervalType;
 (function (IntervalType) {
     IntervalType["Daily"] = "daily";
     IntervalType["Hourly"] = "hourly";
+    IntervalType["Weekly"] = "weekly";
 })(IntervalType = exports.IntervalType || (exports.IntervalType = {}));
 var TokenStdInterfaceId;
 (function (TokenStdInterfaceId) {
@@ -415,6 +416,21 @@ class Api extends HttpClient {
                 format: 'text',
                 ...params
             }).then(utils_1.convertHttpResponse),
+            /**
+             * No description
+             *
+             * @tags Addresses
+             * @name GetAddressesAddressAmountHistoryDeprecated
+             * @request GET:/addresses/{address}/amount-history-DEPRECATED
+             * @deprecated
+             */
+            getAddressesAddressAmountHistoryDeprecated: (address, query, params = {}) => this.request({
+                path: `/addresses/${address}/amount-history-DEPRECATED`,
+                method: 'GET',
+                query: query,
+                format: 'json',
+                ...params
+            }).then(utils_1.convertHttpResponse),
             /**
              * No description
              *
@@ -775,6 +791,38 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse)
         };
+        this.market = {
+            /**
+             * No description
+             *
+             * @tags Market
+             * @name PostMarketPrices
+             * @request POST:/market/prices
+             */
+            postMarketPrices: (query, data, params = {}) => this.request({
+                path: `/market/prices`,
+                method: 'POST',
+                query: query,
+                body: data,
+                type: ContentType.Json,
+                format: 'json',
+                ...params
+            }).then(utils_1.convertHttpResponse),
+            /**
+             * No description
+             *
+             * @tags Market
+             * @name GetMarketPricesSymbolCharts
+             * @request GET:/market/prices/{symbol}/charts
+             */
+            getMarketPricesSymbolCharts: (symbol, query, params = {}) => this.request({
+                path: `/market/prices/${symbol}/charts`,
+                method: 'GET',
+                query: query,
+                format: 'json',
+                ...params
+            }).then(utils_1.convertHttpResponse)
+        };
         this.utils = {
             /**
              * @description Perform a sanity check

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

@@ -10,6 +10,7 @@ export declare class ExplorerProvider {
     readonly charts: ExplorerApi<string>['charts'];
     readonly contractEvents: ExplorerApi<string>['contractEvents'];
     readonly contracts: ExplorerApi<string>['contracts'];
+    readonly market: ExplorerApi<string>['market'];
     readonly utils: ExplorerApi<string>['utils'];
     constructor(baseUrl: string, apiKey?: string, customFetch?: typeof fetch);
     constructor(provider: ExplorerProvider);

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

@@ -55,6 +55,7 @@ class ExplorerProvider {
         this.charts = { ...explorerApi.charts };
         this.utils = { ...explorerApi.utils };
         this.contracts = { ...explorerApi.contracts };
+        this.market = { ...explorerApi.market };
         this.contractEvents = { ...explorerApi.contractEvents };
     }
     // This can prevent the proxied explorer provider from being modified

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

@@ -160,6 +160,7 @@ class NodeProvider {
         this.utils = { ...nodeApi.utils };
         this.miners = { ...nodeApi.miners };
         this.events = { ...nodeApi.events };
+        (0, types_1.requestWithLog)(this);
     }
     // This can prevent the proxied node provider from being modified
     static Proxy(nodeProvider) {

package/dist/src/api/types.d.ts

@@ -30,6 +30,7 @@ export interface ApiRequestArguments {
 }
 export type ApiRequestHandler = (args: ApiRequestArguments) => Promise<any>;
 export declare function forwardRequests(api: Record<string, any>, handler: ApiRequestHandler): void;
+export declare function requestWithLog(api: Record<string, any>): void;
 export declare function request(provider: Record<string, any>, args: ApiRequestArguments): Promise<any>;
 export declare enum StdInterfaceIds {
     FungibleToken = "0001",

package/dist/src/api/types.js

@@ -17,8 +17,9 @@ 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.StdInterfaceIds = exports.request = exports.forwardRequests = exports.typeLength = exports.getDefaultValue = exports.fromApiVal = exports.fromApiArray = exports.fromApiVals = exports.toApiVal = exports.toApiArray = exports.toApiAddress = exports.toApiByteVec = exports.fromApiNumber256 = exports.toApiNumber256Optional = exports.toApiNumber256 = exports.toApiBoolean = exports.fromApiTokens = exports.fromApiToken = exports.toApiTokens = exports.toApiToken = void 0;
+exports.StdInterfaceIds = exports.request = exports.requestWithLog = exports.forwardRequests = exports.typeLength = exports.getDefaultValue = exports.fromApiVal = exports.fromApiArray = exports.fromApiVals = exports.toApiVal = exports.toApiArray = exports.toApiAddress = exports.toApiByteVec = exports.fromApiNumber256 = exports.toApiNumber256Optional = exports.toApiNumber256 = exports.toApiBoolean = exports.fromApiTokens = exports.fromApiToken = exports.toApiTokens = exports.toApiToken = void 0;
 const constants_1 = require("../constants");
+const debug_1 = require("../debug");
 const utils_1 = require("../utils");
 utils_1.assertType;
 function toApiToken(token) {
@@ -263,17 +264,47 @@ function typeLength(tpe) {
     return dims.reduce((a, b) => a * b);
 }
 exports.typeLength = typeLength;
+async function call(args, handler) {
+    const debugModeEnabled = (0, debug_1.isDebugModeEnabled)();
+    const { path, method, params } = args;
+    if (debugModeEnabled) {
+        console.log(`[REQUEST] ${path} ${method} ${JSON.stringify(params)}`);
+    }
+    try {
+        const response = await handler(args);
+        if (debugModeEnabled) {
+            console.log(`[RESPONSE] ${path} ${method} ${JSON.stringify(response)}`);
+        }
+        return response;
+    }
+    catch (error) {
+        if (debugModeEnabled) {
+            console.error(`[ERROR] ${path} ${method} `, error);
+        }
+        throw error;
+    }
+}
 function forwardRequests(api, handler) {
     // Update class properties to forward requests
     for (const [path, pathObject] of Object.entries(api)) {
         for (const method of Object.keys(pathObject)) {
             pathObject[`${method}`] = async (...params) => {
-                return handler({ path, method, params });
+                return call({ path, method, params }, handler);
             };
         }
     }
 }
 exports.forwardRequests = forwardRequests;
+function requestWithLog(api) {
+    for (const [path, pathObject] of Object.entries(api)) {
+        for (const [method, handler] of Object.entries(pathObject)) {
+            pathObject[`${method}`] = async (...params) => {
+                return call({ path, method, params }, () => handler(...params));
+            };
+        }
+    }
+}
+exports.requestWithLog = requestWithLog;
 async function request(provider, args) {
     const call = provider[`${args.path}`][`${args.method}`];
     return call(...args.params);

package/dist/src/debug.d.ts

@@ -0,0 +1,3 @@
+export declare function isDebugModeEnabled(): boolean;
+export declare function enableDebugMode(): void;
+export declare function disableDebugMode(): void;

package/dist/src/debug.js

@@ -0,0 +1,33 @@
+"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.disableDebugMode = exports.enableDebugMode = exports.isDebugModeEnabled = void 0;
+let debugModeEnabled = false;
+function isDebugModeEnabled() {
+    return debugModeEnabled;
+}
+exports.isDebugModeEnabled = isDebugModeEnabled;
+function enableDebugMode() {
+    debugModeEnabled = true;
+}
+exports.enableDebugMode = enableDebugMode;
+function disableDebugMode() {
+    debugModeEnabled = false;
+}
+exports.disableDebugMode = disableDebugMode;

package/dist/src/index.d.ts

@@ -7,3 +7,4 @@ export * from './token';
 export * from './constants';
 export * as web3 from './global';
 export * as utils from './utils';
+export * from './debug';

package/dist/src/index.js

@@ -56,3 +56,4 @@ __exportStar(require("./token"), exports);
 __exportStar(require("./constants"), exports);
 exports.web3 = __importStar(require("./global"));
 exports.utils = __importStar(require("./utils"));
+__exportStar(require("./debug"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -28,7 +28,7 @@
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
     "alephium_version": "2.5.5",
-    "explorer_backend_version": "1.16.0"
+    "explorer_backend_version": "1.16.1"
   },
   "type": "commonjs",
   "dependencies": {

package/src/api/api-explorer.ts

@@ -52,6 +52,10 @@ export interface AddressTokenBalance {
   lockedBalance: string
 }
 
+export interface AmountHistory {
+  amountHistory?: TimedAmount[]
+}
+
 export interface AssetOutput {
   /** @format int32 */
   hint: number
@@ -171,7 +175,8 @@ export interface InternalServerError {
 
 export enum IntervalType {
   Daily = 'daily',
-  Hourly = 'hourly'
+  Hourly = 'hourly',
+  Weekly = 'weekly'
 }
 
 export interface ListBlocks {
@@ -295,6 +300,13 @@ export interface SubContracts {
   subContracts?: string[]
 }
 
+export interface TimedAmount {
+  /** @format int64 */
+  timestamp: number
+  /** @format bigint */
+  amount: string
+}
+
 export interface TimedCount {
   /** @format int64 */
   timestamp: number
@@ -302,6 +314,11 @@ export interface TimedCount {
   totalCountAllChains: number
 }
 
+export interface TimedPrices {
+  timestamps?: number[]
+  prices?: number[]
+}
+
 export interface Token {
   /** @format 32-byte-hash */
   id: string
@@ -1049,6 +1066,39 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params
       }).then(convertHttpResponse),
 
+    /**
+     * No description
+     *
+     * @tags Addresses
+     * @name GetAddressesAddressAmountHistoryDeprecated
+     * @request GET:/addresses/{address}/amount-history-DEPRECATED
+     * @deprecated
+     */
+    getAddressesAddressAmountHistoryDeprecated: (
+      address: string,
+      query: {
+        /**
+         * @format int64
+         * @min 0
+         */
+        fromTs: number
+        /**
+         * @format int64
+         * @min 0
+         */
+        toTs: number
+        'interval-type': IntervalType
+      },
+      params: RequestParams = {}
+    ) =>
+      this.request<string, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/addresses/${address}/amount-history-DEPRECATED`,
+        method: 'GET',
+        query: query,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
     /**
      * No description
      *
@@ -1073,7 +1123,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       },
       params: RequestParams = {}
     ) =>
-      this.request<string, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+      this.request<AmountHistory, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
         path: `/addresses/${address}/amount-history`,
         method: 'GET',
         query: query,
@@ -1635,6 +1685,53 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params
       }).then(convertHttpResponse)
   }
+  market = {
+    /**
+     * No description
+     *
+     * @tags Market
+     * @name PostMarketPrices
+     * @request POST:/market/prices
+     */
+    postMarketPrices: (
+      query: {
+        currency: string
+      },
+      data?: string[],
+      params: RequestParams = {}
+    ) =>
+      this.request<number[], BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/market/prices`,
+        method: 'POST',
+        query: query,
+        body: data,
+        type: ContentType.Json,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * No description
+     *
+     * @tags Market
+     * @name GetMarketPricesSymbolCharts
+     * @request GET:/market/prices/{symbol}/charts
+     */
+    getMarketPricesSymbolCharts: (
+      symbol: string,
+      query: {
+        currency: string
+      },
+      params: RequestParams = {}
+    ) =>
+      this.request<TimedPrices, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/market/prices/${symbol}/charts`,
+        method: 'GET',
+        query: query,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse)
+  }
   utils = {
     /**
      * @description Perform a sanity check

package/src/api/explorer-provider.ts

@@ -40,6 +40,7 @@ export class ExplorerProvider {
   readonly charts: ExplorerApi<string>['charts']
   readonly contractEvents: ExplorerApi<string>['contractEvents']
   readonly contracts: ExplorerApi<string>['contracts']
+  readonly market: ExplorerApi<string>['market']
   readonly utils: ExplorerApi<string>['utils']
 
   constructor(baseUrl: string, apiKey?: string, customFetch?: typeof fetch)
@@ -65,6 +66,7 @@ export class ExplorerProvider {
     this.charts = { ...explorerApi.charts }
     this.utils = { ...explorerApi.utils }
     this.contracts = { ...explorerApi.contracts }
+    this.market = { ...explorerApi.market }
     this.contractEvents = { ...explorerApi.contractEvents }
   }
 

package/src/api/node-provider.ts

@@ -24,7 +24,8 @@ import {
   FungibleTokenMetaData,
   NFTMetaData,
   NFTCollectionMetaData,
-  StdInterfaceIds
+  StdInterfaceIds,
+  requestWithLog
 } from './types'
 import { Api as NodeApi, CallContractFailed, CallContractSucceeded } from './api-alephium'
 import { HexString, tryGetCallResult } from '../contract'
@@ -100,6 +101,7 @@ export class NodeProvider implements NodeProviderApis {
     this.utils = { ...nodeApi.utils }
     this.miners = { ...nodeApi.miners }
     this.events = { ...nodeApi.events }
+    requestWithLog(this)
   }
 
   request = (args: ApiRequestArguments): Promise<any> => {

package/src/api/types.ts

@@ -17,6 +17,7 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
 import { ZERO_ADDRESS } from '../constants'
+import { isDebugModeEnabled } from '../debug'
 import { assertType, bs58, Eq, isBase58, isHexString } from '../utils'
 import * as node from './api-alephium'
 
@@ -267,12 +268,42 @@ export interface ApiRequestArguments {
 }
 export type ApiRequestHandler = (args: ApiRequestArguments) => Promise<any>
 
+async function call(args: ApiRequestArguments, handler: ApiRequestHandler): Promise<any> {
+  const debugModeEnabled = isDebugModeEnabled()
+  const { path, method, params } = args
+  if (debugModeEnabled) {
+    console.log(`[REQUEST] ${path} ${method} ${JSON.stringify(params)}`)
+  }
+  try {
+    const response = await handler(args)
+    if (debugModeEnabled) {
+      console.log(`[RESPONSE] ${path} ${method} ${JSON.stringify(response)}`)
+    }
+    return response
+  } catch (error) {
+    if (debugModeEnabled) {
+      console.error(`[ERROR] ${path} ${method} `, error)
+    }
+    throw error
+  }
+}
+
 export function forwardRequests(api: Record<string, any>, handler: ApiRequestHandler): void {
   // Update class properties to forward requests
   for (const [path, pathObject] of Object.entries(api)) {
     for (const method of Object.keys(pathObject)) {
       pathObject[`${method}`] = async (...params: any): Promise<any> => {
-        return handler({ path, method, params })
+        return call({ path, method, params }, handler)
+      }
+    }
+  }
+}
+
+export function requestWithLog(api: Record<string, any>) {
+  for (const [path, pathObject] of Object.entries(api)) {
+    for (const [method, handler] of Object.entries(pathObject)) {
+      pathObject[`${method}`] = async (...params: any): Promise<any> => {
+        return call({ path, method, params }, () => (handler as (...any) => Promise<any>)(...params))
       }
     }
   }

package/src/debug.ts

@@ -0,0 +1,31 @@
+/*
+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/>.
+*/
+
+let debugModeEnabled = false
+
+export function isDebugModeEnabled() {
+  return debugModeEnabled
+}
+
+export function enableDebugMode() {
+  debugModeEnabled = true
+}
+
+export function disableDebugMode() {
+  debugModeEnabled = false
+}

package/src/index.ts

@@ -31,3 +31,4 @@ export * from './constants'
 export * as web3 from './global'
 
 export * as utils from './utils'
+export * from './debug'