@alephium/web3 0.1.0-rc.3 → 0.1.0-rc.3-hc

package/dist/src/transaction/status.d.ts

@@ -0,0 +1,10 @@
+import { TxStatus } from '../api/api-alephium';
+import { Subscription, SubscribeOptions } from '../utils';
+export declare class TxStatusSubscription extends Subscription<TxStatus> {
+    readonly txId: string;
+    readonly fromGroup?: number;
+    readonly toGroup?: number;
+    constructor(options: SubscribeOptions<TxStatus>, txId: string, fromGroup?: number, toGroup?: number);
+    polling(): Promise<void>;
+}
+export declare function subscribeToTxStatus(options: SubscribeOptions<TxStatus>, txId: string, fromGroup?: number, toGroup?: number): TxStatusSubscription;

package/dist/src/transaction/status.js

@@ -0,0 +1,48 @@
+"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.subscribeToTxStatus = exports.TxStatusSubscription = void 0;
+const utils_1 = require("../utils");
+class TxStatusSubscription extends utils_1.Subscription {
+    constructor(options, txId, fromGroup, toGroup) {
+        super(options);
+        this.txId = txId;
+        this.fromGroup = fromGroup;
+        this.toGroup = toGroup;
+        this.startPolling();
+    }
+    async polling() {
+        try {
+            const txStatus = await this.provider.transactions.getTransactionsStatus({
+                txId: this.txId,
+                fromGroup: this.fromGroup,
+                toGroup: this.toGroup
+            });
+            await this.messageCallback(txStatus);
+        }
+        catch (err) {
+            await this.errorCallback(err, this);
+        }
+    }
+}
+exports.TxStatusSubscription = TxStatusSubscription;
+function subscribeToTxStatus(options, txId, fromGroup, toGroup) {
+    return new TxStatusSubscription(options, txId, fromGroup, toGroup);
+}
+exports.subscribeToTxStatus = subscribeToTxStatus;

package/dist/src/utils/index.d.ts

@@ -2,5 +2,5 @@ export * from './address';
 export * from './bs58';
 export * from './djb2';
 export * from './password-crypto';
-export * from './transaction';
 export * from './utils';
+export * from './subscription';

package/dist/src/utils/index.js

@@ -31,5 +31,5 @@ __exportStar(require("./address"), exports);
 __exportStar(require("./bs58"), exports);
 __exportStar(require("./djb2"), exports);
 __exportStar(require("./password-crypto"), exports);
-__exportStar(require("./transaction"), exports);
 __exportStar(require("./utils"), exports);
+__exportStar(require("./subscription"), exports);

package/dist/src/utils/subscription.d.ts

@@ -0,0 +1,24 @@
+import EventEmitter from 'eventemitter3';
+import { NodeProvider } from '../api';
+declare type MessageCallback<Message> = (message: Message) => Promise<void>;
+declare type ErrorCallback<Message> = (error: any, subscription: Subscription<Message>) => Promise<void>;
+export interface SubscribeOptions<Message> {
+    provider: NodeProvider;
+    pollingInterval: number;
+    messageCallback: MessageCallback<Message>;
+    errorCallback: ErrorCallback<Message>;
+}
+export declare abstract class Subscription<Message> {
+    provider: NodeProvider;
+    pollingInterval: number;
+    protected messageCallback: MessageCallback<Message>;
+    protected errorCallback: ErrorCallback<Message>;
+    protected task: ReturnType<typeof setTimeout> | undefined;
+    protected eventEmitter: EventEmitter;
+    protected cancelled: boolean;
+    constructor(options: SubscribeOptions<Message>);
+    startPolling(): void;
+    unsubscribe(): void;
+    abstract polling(): Promise<void>;
+}
+export {};

package/dist/src/utils/subscription.js

@@ -0,0 +1,52 @@
+"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/>.
+*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscription = void 0;
+const eventemitter3_1 = __importDefault(require("eventemitter3"));
+class Subscription {
+    constructor(options) {
+        this.provider = options.provider;
+        this.pollingInterval = options.pollingInterval;
+        this.messageCallback = options.messageCallback;
+        this.errorCallback = options.errorCallback;
+        this.task = undefined;
+        this.cancelled = false;
+        this.eventEmitter = new eventemitter3_1.default();
+    }
+    startPolling() {
+        this.eventEmitter.on('tick', async () => {
+            await this.polling();
+            if (!this.cancelled) {
+                this.task = setTimeout(() => this.eventEmitter.emit('tick'), this.pollingInterval);
+            }
+        });
+        this.eventEmitter.emit('tick');
+    }
+    unsubscribe() {
+        this.eventEmitter.removeAllListeners();
+        this.cancelled = true;
+        if (typeof this.task !== 'undefined') {
+            clearTimeout(this.task);
+        }
+    }
+}
+exports.Subscription = Subscription;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.1.0-rc.3",
+  "version": "0.1.0-rc.3-hc",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -27,14 +27,14 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "1.4.0-rc3",
-    "explorer_backend_version": "1.7.0-leman2"
+    "alephium_version": "token-balance",
+    "explorer_backend_version": "1.7.0"
   },
   "scripts": {
     "build": "rm -rf dist/* && npx tsc --build . && webpack",
     "bundle": "webpack",
     "update-schemas": "npm run update-schema:alephium && npm run update-schema:explorer",
-    "update-schema:alephium": "npx swagger-typescript-api -t ./configs -o ./src/api -n api-alephium.ts -p https://raw.githubusercontent.com/alephium/alephium/v${npm_package_config_alephium_version}/api/src/main/resources/openapi.json",
+    "update-schema:alephium": "npx swagger-typescript-api -t ./configs -o ./src/api -n api-alephium.ts -p https://raw.githubusercontent.com/alephium/alephium/${npm_package_config_alephium_version}/api/src/main/resources/openapi.json",
     "update-schema:explorer": "npx swagger-typescript-api -t ./configs -o ./src/api -n api-explorer.ts -p https://raw.githubusercontent.com/alephium/explorer-backend/v${npm_package_config_explorer_backend_version}/app/src/main/resources/explorer-backend-openapi.json",
     "check-versions": "node scripts/check-versions.js ${npm_package_config_alephium_version} ${npm_package_config_explorer_backend_version}",
     "dev": "tsnd --respawn lib/index.ts",

package/src/api/api-alephium.ts

@@ -53,6 +53,7 @@ export interface AssetInput {
 }
 
 export interface AssetOutput {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
@@ -95,6 +96,10 @@ export interface Balance {
 
   /** @format x.x ALPH */
   lockedBalanceHint: string
+  tokenBalances?: Token[]
+  lockedTokenBalances?: Token[]
+
+  /** @format int32 */
   utxoNum: number
   warning?: string
 }
@@ -125,8 +130,14 @@ export interface BlockEntry {
 
   /** @format int64 */
   timestamp: number
+
+  /** @format int32 */
   chainFrom: number
+
+  /** @format int32 */
   chainTo: number
+
+  /** @format int32 */
   height: number
   deps: string[]
   transactions: Transaction[]
@@ -151,8 +162,14 @@ export interface BlockHeaderEntry {
 
   /** @format int64 */
   timestamp: number
+
+  /** @format int32 */
   chainFrom: number
+
+  /** @format int32 */
   chainTo: number
+
+  /** @format int32 */
   height: number
   deps: string[]
 }
@@ -160,7 +177,11 @@ export interface BlockHeaderEntry {
 export interface BrokerInfo {
   /** @format clique-id */
   cliqueId: string
+
+  /** @format int32 */
   brokerId: number
+
+  /** @format int32 */
   brokerNum: number
 
   /** @format inet-socket-address */
@@ -189,7 +210,10 @@ export interface BuildDeployContractTx {
 }
 
 export interface BuildDeployContractTxResult {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unsignedTx: string
 
@@ -225,7 +249,10 @@ export interface BuildExecuteScriptTx {
 }
 
 export interface BuildExecuteScriptTxResult {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unsignedTx: string
 
@@ -259,6 +286,8 @@ export interface BuildMultisig {
 
 export interface BuildMultisigAddress {
   keys: string[]
+
+  /** @format int32 */
   mrequired: number
 }
 
@@ -286,7 +315,11 @@ export interface BuildSweepAddressTransactions {
 
 export interface BuildSweepAddressTransactionsResult {
   unsignedTxs: SweepAddressTransaction[]
+
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
 }
 
@@ -314,11 +347,16 @@ export interface BuildTransactionResult {
 
   /** @format 32-byte-hash */
   txId: string
+
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
 }
 
 export interface CallContract {
+  /** @format int32 */
   group: number
 
   /** @format block-hash */
@@ -329,6 +367,8 @@ export interface CallContract {
 
   /** @format address */
   address: string
+
+  /** @format int32 */
   methodIndex: number
   args?: Val[]
   existingContracts?: string[]
@@ -337,6 +377,8 @@ export interface CallContract {
 
 export interface CallContractResult {
   returns: Val[]
+
+  /** @format int32 */
   gasUsed: number
   contracts: ContractState[]
   txInputs: string[]
@@ -345,13 +387,20 @@ export interface CallContractResult {
 }
 
 export interface ChainInfo {
+  /** @format int32 */
   currentHeight: number
 }
 
 export interface ChainParams {
   networkId: number
+
+  /** @format int32 */
   numZerosAtLeastInHash: number
+
+  /** @format int32 */
   groupNumPerBroker: number
+
+  /** @format int32 */
   groups: number
 }
 
@@ -379,9 +428,17 @@ export interface CompileScriptResult {
 export interface Confirmed {
   /** @format block-hash */
   blockHash: string
+
+  /** @format int32 */
   txIndex: number
+
+  /** @format int32 */
   chainConfirmations: number
+
+  /** @format int32 */
   fromGroupConfirmations: number
+
+  /** @format int32 */
   toGroupConfirmations: number
   type: string
 }
@@ -396,6 +453,8 @@ export interface ContractEvent {
 
   /** @format 32-byte-hash */
   txId: string
+
+  /** @format int32 */
   eventIndex: number
   fields: Val[]
 }
@@ -406,21 +465,28 @@ export interface ContractEventByTxId {
 
   /** @format address */
   contractAddress: string
+
+  /** @format int32 */
   eventIndex: number
   fields: Val[]
 }
 
 export interface ContractEvents {
   events: ContractEvent[]
+
+  /** @format int32 */
   nextStart: number
 }
 
 export interface ContractEventsByTxId {
   events: ContractEventByTxId[]
+
+  /** @format int32 */
   nextStart: number
 }
 
 export interface ContractOutput {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
@@ -456,7 +522,10 @@ export interface DecodeUnsignedTx {
 }
 
 export interface DecodeUnsignedTxResult {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unsignedTx: UnsignedTx
 }
@@ -496,6 +565,7 @@ export interface FieldsSig {
 }
 
 export interface FixedAssetOutput {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
@@ -524,6 +594,7 @@ export interface FunctionSig {
 }
 
 export interface Group {
+  /** @format int32 */
   group: number
 }
 
@@ -534,7 +605,11 @@ export interface HashesAtHeight {
 export interface InterCliquePeerInfo {
   /** @format clique-id */
   cliqueId: string
+
+  /** @format int32 */
   brokerId: number
+
+  /** @format int32 */
   groupNumPerBroker: number
 
   /** @format inet-socket-address */
@@ -581,6 +656,7 @@ export interface NotFound {
 export type Output = AssetOutput | ContractOutput
 
 export interface OutputRef {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
@@ -590,8 +666,14 @@ export interface OutputRef {
 export interface PeerAddress {
   /** @format inet-address */
   address: string
+
+  /** @format int32 */
   restPort: number
+
+  /** @format int32 */
   wsPort: number
+
+  /** @format int32 */
   minerApiPort: number
 }
 
@@ -604,6 +686,7 @@ export interface PeerMisbehavior {
 export type PeerStatus = Banned | Penalty
 
 export interface Penalty {
+  /** @format int32 */
   value: number
   type: string
 }
@@ -614,8 +697,13 @@ export interface Reachable {
 }
 
 export interface ReleaseVersion {
+  /** @format int32 */
   major: number
+
+  /** @format int32 */
   minor: number
+
+  /** @format int32 */
   patch: number
 }
 
@@ -667,7 +755,11 @@ export interface SubmitTransaction {
 export interface SubmitTxResult {
   /** @format 32-byte-hash */
   txId: string
+
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
 }
 
@@ -683,6 +775,8 @@ export interface Sweep {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format int32 */
   utxosLimit?: number
 }
 
@@ -699,6 +793,7 @@ export interface SweepAddressTransaction {
 }
 
 export interface TestContract {
+  /** @format int32 */
   group?: number
 
   /** @format block-hash */
@@ -714,6 +809,8 @@ export interface TestContract {
   bytecode: string
   initialFields?: Val[]
   initialAsset?: AssetState
+
+  /** @format int32 */
   methodIndex?: number
   args?: Val[]
   existingContracts?: ContractState[]
@@ -727,6 +824,8 @@ export interface TestContractResult {
   /** @format 32-byte-hash */
   codeHash: string
   returns: Val[]
+
+  /** @format int32 */
   gasUsed: number
   contracts: ContractState[]
   txInputs: string[]
@@ -771,6 +870,8 @@ export interface Transfer {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format int32 */
   utxosLimit?: number
 }
 
@@ -824,7 +925,10 @@ export interface Unban {
 }
 
 export interface UnconfirmedTransactions {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unconfirmedTransactions: TransactionTemplate[]
 }
@@ -842,6 +946,8 @@ export interface UnsignedTx {
 
   /** @format script */
   scriptOpt?: string
+
+  /** @format int32 */
   gasAmount: number
 
   /** @format uint256 */
@@ -875,6 +981,7 @@ export interface ValByteVec {
 }
 
 export interface ValI256 {
+  /** @format bigint */
   value: string
   type: string
 }
@@ -1157,7 +1264,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 1.4.0
+ * @version 1.4.1
  * @baseUrl {protocol}://{host}:{port}
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {