@alephium/web3 0.1.0-rc.3 → 0.2.0-rc.0

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,18 +113,26 @@ 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;
+    address: {
+        addr: string;
+        port: number;
+    };
 }
 export interface BuildDeployContractTx {
     /** @format public-key */
@@ -133,9 +148,13 @@ export interface BuildDeployContractTx {
     gasAmount?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format block-hash */
+    targetBlockHash?: string;
 }
 export interface BuildDeployContractTxResult {
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
     unsignedTx: string;
     /** @format gas */
@@ -159,9 +178,13 @@ export interface BuildExecuteScriptTx {
     gasAmount?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format block-hash */
+    targetBlockHash?: string;
 }
 export interface BuildExecuteScriptTxResult {
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
     unsignedTx: string;
     /** @format gas */
@@ -187,6 +210,7 @@ export interface BuildMultisig {
 }
 export interface BuildMultisigAddress {
     keys: string[];
+    /** @format int32 */
     mrequired: number;
 }
 export interface BuildMultisigAddressResult {
@@ -204,10 +228,14 @@ export interface BuildSweepAddressTransactions {
     gasAmount?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format block-hash */
+    targetBlockHash?: string;
 }
 export interface BuildSweepAddressTransactionsResult {
     unsignedTxs: SweepAddressTransaction[];
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
 }
 export interface BuildTransaction {
@@ -219,6 +247,8 @@ export interface BuildTransaction {
     gasAmount?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format block-hash */
+    targetBlockHash?: string;
 }
 export interface BuildTransactionResult {
     unsignedTx: string;
@@ -228,10 +258,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 +272,7 @@ export interface CallContract {
     txId?: string;
     /** @format address */
     address: string;
+    /** @format int32 */
     methodIndex: number;
     args?: Val[];
     existingContracts?: string[];
@@ -246,6 +280,7 @@ export interface CallContract {
 }
 export interface CallContractResult {
     returns: Val[];
+    /** @format int32 */
     gasUsed: number;
     contracts: ContractState[];
     txInputs: string[];
@@ -253,12 +288,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 +320,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 +338,7 @@ export interface ContractEvent {
     blockHash: string;
     /** @format 32-byte-hash */
     txId: string;
+    /** @format int32 */
     eventIndex: number;
     fields: Val[];
 }
@@ -303,18 +347,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 +389,9 @@ export interface DecodeUnsignedTx {
     unsignedTx: string;
 }
 export interface DecodeUnsignedTxResult {
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
     unsignedTx: UnsignedTx;
 }
@@ -372,6 +422,7 @@ export interface FieldsSig {
     types: string[];
 }
 export interface FixedAssetOutput {
+    /** @format int32 */
     hint: number;
     /** @format 32-byte-hash */
     key: string;
@@ -393,6 +444,7 @@ export interface FunctionSig {
     returnTypes: string[];
 }
 export interface Group {
+    /** @format int32 */
     group: number;
 }
 export interface HashesAtHeight {
@@ -401,10 +453,15 @@ 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;
+    address: {
+        addr: string;
+        port: number;
+    };
     isSynced: boolean;
     clientVersion: string;
 }
@@ -425,7 +482,10 @@ export interface NodeInfo {
     buildInfo: BuildInfo;
     upnp: boolean;
     /** @format inet-socket-address */
-    externalAddress?: string;
+    externalAddress?: {
+        addr: string;
+        port: number;
+    };
 }
 export interface NodeVersion {
     version: ReleaseVersion;
@@ -436,6 +496,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 +504,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 +518,7 @@ export interface PeerMisbehavior {
 }
 export declare type PeerStatus = Banned | Penalty;
 export interface Penalty {
+    /** @format int32 */
     value: number;
     type: string;
 }
@@ -462,8 +527,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 +572,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,7 +586,10 @@ export interface Sweep {
     gasAmount?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format int32 */
     utxosLimit?: number;
+    /** @format block-hash */
+    targetBlockHash?: string;
 }
 export interface SweepAddressTransaction {
     /** @format 32-byte-hash */
@@ -528,6 +601,7 @@ export interface SweepAddressTransaction {
     gasPrice: string;
 }
 export interface TestContract {
+    /** @format int32 */
     group?: number;
     /** @format block-hash */
     blockHash?: string;
@@ -539,6 +613,7 @@ export interface TestContract {
     bytecode: string;
     initialFields?: Val[];
     initialAsset?: AssetState;
+    /** @format int32 */
     methodIndex?: number;
     args?: Val[];
     existingContracts?: ContractState[];
@@ -550,6 +625,7 @@ export interface TestContractResult {
     /** @format 32-byte-hash */
     codeHash: string;
     returns: Val[];
+    /** @format int32 */
     gasUsed: number;
     contracts: ContractState[];
     txInputs: string[];
@@ -586,6 +662,7 @@ export interface Transfer {
     gas?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format int32 */
     utxosLimit?: number;
 }
 export interface TransferResult {
@@ -625,7 +702,9 @@ export interface Unban {
     type: string;
 }
 export interface UnconfirmedTransactions {
+    /** @format int32 */
     fromGroup: number;
+    /** @format int32 */
     toGroup: number;
     unconfirmedTransactions: TransactionTemplate[];
 }
@@ -640,6 +719,7 @@ export interface UnsignedTx {
     networkId: number;
     /** @format script */
     scriptOpt?: string;
+    /** @format int32 */
     gasAmount: number;
     /** @format uint256 */
     gasPrice: string;
@@ -666,6 +746,7 @@ export interface ValByteVec {
     type: string;
 }
 export interface ValI256 {
+    /** @format bigint */
     value: string;
     type: string;
 }
@@ -774,7 +855,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 1.4.0
+ * @version 1.5.0-rc0
  * @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.5.0-rc0
  * @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/contract.d.ts

@@ -1,6 +1,13 @@
 import { NodeProvider } from '../api';
 import { node } from '../api';
 import { SignDeployContractTxParams, SignExecuteScriptTxParams, SignerWithNodeProvider } from '../signer';
+declare class SourceFile {
+    readonly dirs: string[];
+    readonly dirPath: string;
+    readonly contractPath: string;
+    readonly artifactPath: string;
+    constructor(dirs: string[], fileName: string);
+}
 export declare abstract class Common {
     readonly sourceCodeSha256: string;
     readonly functions: node.FunctionSig[];
@@ -13,16 +20,15 @@ export declare abstract class Common {
     protected static _getArtifactFromCache(codeHash: string): Contract | Script | undefined;
     protected static _putArtifactToCache(contract: Contract): void;
     constructor(sourceCodeSha256: string, functions: node.FunctionSig[]);
-    protected static _contractPath(fileName: string): string;
-    protected static _artifactPath(fileName: string): string;
     protected static _artifactsFolder(): string;
-    protected static _handleImports(contractStr: string, importsCache: string[]): Promise<string>;
-    protected static _loadContractStr(fileName: string, importsCache: string[], validate: (fileName: string) => void): Promise<string>;
+    static getSourceFile(path: string, _dirs: string[]): SourceFile;
+    protected static _handleImports(pathes: string[], contractStr: string, importsCache: string[]): Promise<string>;
+    protected static _loadContractStr(sourceFile: SourceFile, importsCache: string[], validate: (code: string) => void): Promise<string>;
     static checkFileNameExtension(fileName: string): void;
     protected static _from<T extends {
         sourceCodeSha256: string;
-    }>(provider: NodeProvider, fileName: string, loadContractStr: (fileName: string, importsCache: string[]) => Promise<string>, compile: (provider: NodeProvider, fileName: string, contractStr: string, contractHash: string) => Promise<T>): Promise<T>;
-    protected _saveToFile(fileName: string): Promise<void>;
+    }>(provider: NodeProvider, sourceFile: SourceFile, loadContractStr: (sourceFile: SourceFile, importsCache: string[]) => Promise<string>, compile: (provider: NodeProvider, sourceFile: SourceFile, contractStr: string, contractHash: string) => Promise<T>): Promise<T>;
+    protected _saveToFile(sourceFile: SourceFile): Promise<void>;
     abstract buildByteCodeToDeploy(initialFields?: Fields): string;
 }
 export declare class Contract extends Common {
@@ -33,10 +39,11 @@ export declare class Contract extends Common {
     constructor(sourceCodeSha256: string, bytecode: string, codeHash: string, fieldsSig: node.FieldsSig, eventsSig: node.EventSig[], functions: node.FunctionSig[]);
     static checkCodeType(fileName: string, contractStr: string): void;
     private static loadContractStr;
-    static fromSource(provider: NodeProvider, fileName: string): Promise<Contract>;
+    static fromSource(provider: NodeProvider, path: string): Promise<Contract>;
     private static compile;
     static fromJson(artifact: any): Contract;
-    static fromArtifactFile(fileName: string): Promise<Contract>;
+    static fromArtifactFile(path: string): Promise<Contract>;
+    fetchState(provider: NodeProvider, address: string, group: number): Promise<ContractState>;
     toString(): string;
     toState(fields: Fields, asset: Asset, address?: string): ContractState;
     static randomAddress(): string;
@@ -65,10 +72,10 @@ export declare class Script extends Common {
     constructor(sourceCodeSha256: string, bytecodeTemplate: string, fieldsSig: node.FieldsSig, functions: node.FunctionSig[]);
     static checkCodeType(fileName: string, contractStr: string): void;
     private static loadContractStr;
-    static fromSource(provider: NodeProvider, fileName: string): Promise<Script>;
+    static fromSource(provider: NodeProvider, path: string): Promise<Script>;
     private static compile;
     static fromJson(artifact: any): Script;
-    static fromArtifactFile(fileName: string): Promise<Script>;
+    static fromArtifactFile(path: string): Promise<Script>;
     toString(): string;
     paramsForDeployment(params: BuildExecuteScriptTx): Promise<SignExecuteScriptTxParams>;
     transactionForDeployment(signer: SignerWithNodeProvider, params: Omit<BuildExecuteScriptTx, 'signerAddress'>): Promise<BuildScriptTxResult>;
@@ -180,3 +187,4 @@ export interface BuildScriptTxResult {
     unsignedTx: string;
     txId: string;
 }
+export {};