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

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

@@ -31,6 +31,7 @@ export interface AssetInput {
     unlockScript: string;
 }
 export interface AssetOutput {
+    /** @format int32 */
     hint: number;
     /** @format 32-byte-hash */
     key: string;
@@ -62,6 +63,9 @@ export interface Balance {
     lockedBalance: string;
     /** @format x.x ALPH */
     lockedBalanceHint: string;
+    tokenBalances?: Token[];
+    lockedTokenBalances?: Token[];
+    /** @format int32 */
     utxoNum: number;
     warning?: string;
 }
@@ -86,8 +90,11 @@ export interface BlockEntry {
     hash: string;
     /** @format int64 */
     timestamp: number;
+    /** @format int32 */
     chainFrom: number;
+    /** @format int32 */
     chainTo: number;
+    /** @format int32 */
     height: number;
     deps: string[];
     transactions: Transaction[];
@@ -106,15 +113,20 @@ export interface BlockHeaderEntry {
     hash: string;
     /** @format int64 */
     timestamp: number;
+    /** @format int32 */
     chainFrom: number;
+    /** @format int32 */
     chainTo: number;
+    /** @format int32 */
     height: number;
     deps: string[];
 }
 export interface BrokerInfo {
     /** @format clique-id */
     cliqueId: string;
+    /** @format int32 */
     brokerId: number;
+    /** @format int32 */
     brokerNum: number;
     /** @format inet-socket-address */
     address: string;
@@ -135,7 +147,9 @@ export interface BuildDeployContractTx {
     gasPrice?: string;
 }
 export interface BuildDeployContractTxResult {
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
     unsignedTx: string;
     /** @format gas */
@@ -161,7 +175,9 @@ export interface BuildExecuteScriptTx {
     gasPrice?: string;
 }
 export interface BuildExecuteScriptTxResult {
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
     unsignedTx: string;
     /** @format gas */
@@ -187,6 +203,7 @@ export interface BuildMultisig {
 }
 export interface BuildMultisigAddress {
     keys: string[];
+    /** @format int32 */
     mrequired: number;
 }
 export interface BuildMultisigAddressResult {
@@ -207,7 +224,9 @@ export interface BuildSweepAddressTransactions {
 }
 export interface BuildSweepAddressTransactionsResult {
     unsignedTxs: SweepAddressTransaction[];
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
 }
 export interface BuildTransaction {
@@ -228,10 +247,13 @@ export interface BuildTransactionResult {
     gasPrice: string;
     /** @format 32-byte-hash */
     txId: string;
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
 }
 export interface CallContract {
+    /** @format int32 */
     group: number;
     /** @format block-hash */
     worldStateBlockHash?: string;
@@ -239,6 +261,7 @@ export interface CallContract {
     txId?: string;
     /** @format address */
     address: string;
+    /** @format int32 */
     methodIndex: number;
     args?: Val[];
     existingContracts?: string[];
@@ -246,6 +269,7 @@ export interface CallContract {
 }
 export interface CallContractResult {
     returns: Val[];
+    /** @format int32 */
     gasUsed: number;
     contracts: ContractState[];
     txInputs: string[];
@@ -253,12 +277,16 @@ export interface CallContractResult {
     events: ContractEventByTxId[];
 }
 export interface ChainInfo {
+    /** @format int32 */
     currentHeight: number;
 }
 export interface ChainParams {
     networkId: number;
+    /** @format int32 */
     numZerosAtLeastInHash: number;
+    /** @format int32 */
     groupNumPerBroker: number;
+    /** @format int32 */
     groups: number;
 }
 export interface ChangeActiveAddress {
@@ -281,9 +309,13 @@ 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;
 }
@@ -295,6 +327,7 @@ export interface ContractEvent {
     blockHash: string;
     /** @format 32-byte-hash */
     txId: string;
+    /** @format int32 */
     eventIndex: number;
     fields: Val[];
 }
@@ -303,18 +336,22 @@ export interface ContractEventByTxId {
     blockHash: string;
     /** @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 */
     key: string;
@@ -341,7 +378,9 @@ export interface DecodeUnsignedTx {
     unsignedTx: string;
 }
 export interface DecodeUnsignedTxResult {
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
     unsignedTx: UnsignedTx;
 }
@@ -372,6 +411,7 @@ export interface FieldsSig {
     types: string[];
 }
 export interface FixedAssetOutput {
+    /** @format int32 */
     hint: number;
     /** @format 32-byte-hash */
     key: string;
@@ -393,6 +433,7 @@ export interface FunctionSig {
     returnTypes: string[];
 }
 export interface Group {
+    /** @format int32 */
     group: number;
 }
 export interface HashesAtHeight {
@@ -401,7 +442,9 @@ export interface HashesAtHeight {
 export interface InterCliquePeerInfo {
     /** @format clique-id */
     cliqueId: string;
+    /** @format int32 */
     brokerId: number;
+    /** @format int32 */
     groupNumPerBroker: number;
     /** @format inet-socket-address */
     address: string;
@@ -436,6 +479,7 @@ export interface NotFound {
 }
 export declare type Output = AssetOutput | ContractOutput;
 export interface OutputRef {
+    /** @format int32 */
     hint: number;
     /** @format 32-byte-hash */
     key: string;
@@ -443,8 +487,11 @@ export interface OutputRef {
 export interface PeerAddress {
     /** @format inet-address */
     address: string;
+    /** @format int32 */
     restPort: number;
+    /** @format int32 */
     wsPort: number;
+    /** @format int32 */
     minerApiPort: number;
 }
 export interface PeerMisbehavior {
@@ -454,6 +501,7 @@ export interface PeerMisbehavior {
 }
 export declare type PeerStatus = Banned | Penalty;
 export interface Penalty {
+    /** @format int32 */
     value: number;
     type: string;
 }
@@ -462,8 +510,11 @@ export interface Reachable {
     type: string;
 }
 export interface ReleaseVersion {
+    /** @format int32 */
     major: number;
+    /** @format int32 */
     minor: number;
+    /** @format int32 */
     patch: number;
 }
 export interface RevealMnemonic {
@@ -504,7 +555,9 @@ export interface SubmitTransaction {
 export interface SubmitTxResult {
     /** @format 32-byte-hash */
     txId: string;
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
 }
 export interface Sweep {
@@ -516,6 +569,7 @@ export interface Sweep {
     gasAmount?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format int32 */
     utxosLimit?: number;
 }
 export interface SweepAddressTransaction {
@@ -528,6 +582,7 @@ export interface SweepAddressTransaction {
     gasPrice: string;
 }
 export interface TestContract {
+    /** @format int32 */
     group?: number;
     /** @format block-hash */
     blockHash?: string;
@@ -539,6 +594,7 @@ export interface TestContract {
     bytecode: string;
     initialFields?: Val[];
     initialAsset?: AssetState;
+    /** @format int32 */
     methodIndex?: number;
     args?: Val[];
     existingContracts?: ContractState[];
@@ -550,6 +606,7 @@ export interface TestContractResult {
     /** @format 32-byte-hash */
     codeHash: string;
     returns: Val[];
+    /** @format int32 */
     gasUsed: number;
     contracts: ContractState[];
     txInputs: string[];
@@ -586,6 +643,7 @@ export interface Transfer {
     gas?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format int32 */
     utxosLimit?: number;
 }
 export interface TransferResult {
@@ -625,7 +683,9 @@ export interface Unban {
     type: string;
 }
 export interface UnconfirmedTransactions {
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
     unconfirmedTransactions: TransactionTemplate[];
 }
@@ -640,6 +700,7 @@ export interface UnsignedTx {
     networkId: number;
     /** @format script */
     scriptOpt?: string;
+    /** @format int32 */
     gasAmount: number;
     /** @format uint256 */
     gasPrice: string;
@@ -666,6 +727,7 @@ export interface ValByteVec {
     type: string;
 }
 export interface ValI256 {
+    /** @format bigint */
     value: string;
     type: string;
 }
@@ -774,7 +836,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 1.4.0
+ * @version 1.4.1
  * @baseUrl {protocol}://{host}:{port}
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {

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

@@ -158,7 +158,7 @@ class HttpClient {
 exports.HttpClient = HttpClient;
 /**
  * @title Alephium API
- * @version 1.4.0
+ * @version 1.4.1
  * @baseUrl {protocol}://{host}:{port}
  */
 class Api extends HttpClient {

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

@@ -9,30 +9,39 @@ export interface AddressInfo {
     balance: string;
     /** @format uint256 */
     lockedBalance: string;
+    /** @format int32 */
     txNumber: number;
 }
 export interface BadRequest {
     detail: string;
 }
 export interface BlockEntryLite {
+    /** @format block-hash */
     hash: string;
     /** @format int64 */
     timestamp: number;
+    /** @format int32 */
     chainFrom: number;
+    /** @format int32 */
     chainTo: number;
+    /** @format int32 */
     height: number;
+    /** @format int32 */
     txNumber: number;
     mainChain: boolean;
     /** @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;
@@ -45,12 +54,13 @@ export interface ExplorerInfo {
 export interface Hashrate {
     /** @format int64 */
     timestamp: number;
-    hashrate: string;
-    value: string;
+    hashrate: number;
+    value: number;
 }
 export interface Input {
     outputRef: OutputRef;
     unlockScript?: string;
+    /** @format 32-byte-hash */
     txHashRef: string;
     address: string;
     /** @format uint256 */
@@ -60,6 +70,7 @@ export interface InternalServerError {
     detail: string;
 }
 export interface ListBlocks {
+    /** @format int32 */
     total: number;
     blocks?: BlockEntryLite[];
 }
@@ -68,6 +79,7 @@ export interface NotFound {
     resource: string;
 }
 export interface Output {
+    /** @format int32 */
     hint: number;
     /** @format 32-byte-hash */
     key: string;
@@ -76,21 +88,27 @@ export interface Output {
     address: string;
     /** @format int64 */
     lockTime?: number;
+    /** @format 32-byte-hash */
     spent?: string;
 }
 export interface OutputRef {
+    /** @format int32 */
     hint: number;
     /** @format 32-byte-hash */
     key: string;
 }
 export interface PerChainCount {
+    /** @format int32 */
     chainFrom: number;
+    /** @format int32 */
     chainTo: number;
     /** @format int64 */
     count: number;
 }
 export interface PerChainDuration {
+    /** @format int32 */
     chainFrom: number;
+    /** @format int32 */
     chainTo: number;
     /** @format int64 */
     duration: number;
@@ -98,7 +116,9 @@ export interface PerChainDuration {
     value: number;
 }
 export interface PerChainHeight {
+    /** @format int32 */
     chainFrom: number;
+    /** @format int32 */
     chainTo: number;
     /** @format int64 */
     height: number;
@@ -134,12 +154,15 @@ export interface TokenSupply {
     maximum: string;
 }
 export interface Transaction {
+    /** @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;
@@ -160,11 +183,15 @@ export interface Unauthorized {
     detail: string;
 }
 export interface UnconfirmedTransaction {
+    /** @format 32-byte-hash */
     hash: string;
+    /** @format int32 */
     chainFrom: number;
+    /** @format int32 */
     chainTo: number;
     inputs?: UInput[];
     outputs?: UOutput[];
+    /** @format int32 */
     gasAmount: number;
     /** @format uint256 */
     gasPrice: string;
@@ -351,7 +378,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name GetInfosSupplyTotalAlph
          * @request GET:/infos/supply/total-alph
          */
-        getInfosSupplyTotalAlph: (params?: RequestParams) => Promise<string>;
+        getInfosSupplyTotalAlph: (params?: RequestParams) => Promise<number>;
         /**
          * @description Get the ALPH circulating supply
          *
@@ -359,7 +386,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name GetInfosSupplyCirculatingAlph
          * @request GET:/infos/supply/circulating-alph
          */
-        getInfosSupplyCirculatingAlph: (params?: RequestParams) => Promise<string>;
+        getInfosSupplyCirculatingAlph: (params?: RequestParams) => Promise<number>;
         /**
          * @description Get the ALPH reserved supply
          *
@@ -367,7 +394,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name GetInfosSupplyReservedAlph
          * @request GET:/infos/supply/reserved-alph
          */
-        getInfosSupplyReservedAlph: (params?: RequestParams) => Promise<string>;
+        getInfosSupplyReservedAlph: (params?: RequestParams) => Promise<number>;
         /**
          * @description Get the ALPH locked supply
          *
@@ -375,7 +402,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name GetInfosSupplyLockedAlph
          * @request GET:/infos/supply/locked-alph
          */
-        getInfosSupplyLockedAlph: (params?: RequestParams) => Promise<string>;
+        getInfosSupplyLockedAlph: (params?: RequestParams) => Promise<number>;
         /**
          * @description Get the total number of transactions
          *

package/dist/src/contract/events.d.ts

@@ -1,29 +1,11 @@
-import { node } from '../api';
-import { NodeProvider } from '../api';
-declare type EventCallback = (event: node.ContractEvent) => Promise<void>;
-declare type ErrorCallback = (error: any, subscription: Subscription) => Promise<void>;
-export interface SubscribeOptions {
-    provider: NodeProvider;
-    contractAddress: string;
-    fromCount?: number;
-    pollingInterval: number;
-    eventCallback: EventCallback;
-    errorCallback: ErrorCallback;
-}
-export declare class Subscription {
-    provider: NodeProvider;
+import { ContractEvent } from '../api/api-alephium';
+import { Subscription, SubscribeOptions } from '../utils';
+export declare class EventSubscription extends Subscription<ContractEvent> {
     readonly contractAddress: string;
-    pollingInterval: number;
     private fromCount;
-    private eventCallback;
-    private errorCallback;
-    private task;
-    private cancelled;
-    private eventEmitter;
-    constructor(options: SubscribeOptions);
-    unsubscribe(): void;
+    constructor(options: SubscribeOptions<ContractEvent>, contractAddress: string, fromCount?: number);
+    startPolling(): void;
     currentEventCount(): number;
-    private fetchEvents;
+    polling(): Promise<void>;
 }
-export declare function subscribe(options: SubscribeOptions): Subscription;
-export {};
+export declare function subscribeToEvents(options: SubscribeOptions<ContractEvent>, contractAddress: string, fromCount?: number): EventSubscription;

package/dist/src/contract/events.js

@@ -16,39 +16,26 @@ 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.subscribe = exports.Subscription = void 0;
-const eventemitter3_1 = __importDefault(require("eventemitter3"));
-class Subscription {
-    constructor(options) {
-        this.provider = options.provider;
-        this.contractAddress = options.contractAddress;
-        this.fromCount = typeof options.fromCount === 'undefined' ? 0 : options.fromCount;
-        this.pollingInterval = options.pollingInterval;
-        this.eventCallback = options.eventCallback;
-        this.errorCallback = options.errorCallback;
-        this.task = undefined;
-        this.cancelled = false;
-        this.eventEmitter = new eventemitter3_1.default();
+exports.subscribeToEvents = exports.EventSubscription = void 0;
+const utils_1 = require("../utils");
+class EventSubscription extends utils_1.Subscription {
+    constructor(options, contractAddress, fromCount) {
+        super(options);
+        this.contractAddress = contractAddress;
+        this.fromCount = typeof fromCount === 'undefined' ? 0 : fromCount;
+        this.startPolling();
+    }
+    startPolling() {
         this.eventEmitter.on('tick', async () => {
-            await this.fetchEvents();
+            await this.polling();
         });
         this.eventEmitter.emit('tick');
     }
-    unsubscribe() {
-        this.eventEmitter.removeAllListeners();
-        this.cancelled = true;
-        if (typeof this.task !== 'undefined') {
-            clearTimeout(this.task);
-        }
-    }
     currentEventCount() {
         return this.fromCount;
     }
-    async fetchEvents() {
+    async polling() {
         try {
             const events = await this.provider.events.getEventsContractContractaddress(this.contractAddress, {
                 start: this.fromCount
@@ -60,18 +47,18 @@ class Subscription {
                 this.task = setTimeout(() => this.eventEmitter.emit('tick'), this.pollingInterval);
                 return;
             }
-            const promises = events.events.map((event) => this.eventCallback(event));
+            const promises = events.events.map((event) => this.messageCallback(event));
             await Promise.all(promises);
             this.fromCount = events.nextStart;
-            await this.fetchEvents();
+            await this.polling();
         }
         catch (err) {
             await this.errorCallback(err, this);
         }
     }
 }
-exports.Subscription = Subscription;
-function subscribe(options) {
-    return new Subscription(options);
+exports.EventSubscription = EventSubscription;
+function subscribeToEvents(options, contractAddress, fromCount) {
+    return new EventSubscription(options, contractAddress, fromCount);
 }
-exports.subscribe = subscribe;
+exports.subscribeToEvents = subscribeToEvents;

package/dist/src/index.d.ts

@@ -2,4 +2,5 @@ export * from './api';
 export * from './contract';
 export * from './signer';
 export * from './utils';
+export * from './transaction';
 export * from './constants';

package/dist/src/index.js

@@ -31,4 +31,5 @@ __exportStar(require("./api"), exports);
 __exportStar(require("./contract"), exports);
 __exportStar(require("./signer"), exports);
 __exportStar(require("./utils"), exports);
+__exportStar(require("./transaction"), exports);
 __exportStar(require("./constants"), exports);

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

@@ -0,0 +1,2 @@
+export * from './sign-verify';
+export * from './status';

package/dist/src/transaction/index.js

@@ -0,0 +1,31 @@
+"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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./sign-verify"), exports);
+__exportStar(require("./status"), exports);

package/dist/src/{utils/transaction.js → transaction/sign-verify.js}

@@ -38,7 +38,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transactionVerifySignature = exports.transactionSign = void 0;
 const elliptic_1 = require("elliptic");
-const utils = __importStar(require("./utils"));
+const utils = __importStar(require("../utils"));
 const ec = new elliptic_1.ec('secp256k1');
 function transactionSign(txHash, privateKey) {
     const keyPair = ec.keyFromPrivate(privateKey);