@alephium/web3 0.2.0-test.0 → 0.2.0

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

@@ -85,6 +85,10 @@ export interface Banned {
     until: number;
     type: string;
 }
+export interface BlockAndEvents {
+    block: BlockEntry;
+    events: ContractEventByBlockHash[];
+}
 export interface BlockEntry {
     /** @format block-hash */
     hash: string;
@@ -121,6 +125,12 @@ export interface BlockHeaderEntry {
     height: number;
     deps: string[];
 }
+export interface BlocksAndEventsPerTimeStampRange {
+    blocksAndEvents: BlockAndEvents[][];
+}
+export interface BlocksPerTimeStampRange {
+    blocks: BlockEntry[][];
+}
 export interface BrokerInfo {
     /** @format clique-id */
     cliqueId: string;
@@ -148,6 +158,8 @@ export interface BuildDeployContractTx {
     gasAmount?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format block-hash */
+    targetBlockHash?: string;
 }
 export interface BuildDeployContractTxResult {
     /** @format int32 */
@@ -176,6 +188,8 @@ export interface BuildExecuteScriptTx {
     gasAmount?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format block-hash */
+    targetBlockHash?: string;
 }
 export interface BuildExecuteScriptTxResult {
     /** @format int32 */
@@ -224,6 +238,8 @@ export interface BuildSweepAddressTransactions {
     gasAmount?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format block-hash */
+    targetBlockHash?: string;
 }
 export interface BuildSweepAddressTransactionsResult {
     unsignedTxs: SweepAddressTransaction[];
@@ -241,6 +257,8 @@ export interface BuildTransaction {
     gasAmount?: number;
     /** @format uint256 */
     gasPrice?: string;
+    /** @format block-hash */
+    targetBlockHash?: string;
 }
 export interface BuildTransactionResult {
     unsignedTx: string;
@@ -297,17 +315,39 @@ export interface ChangeActiveAddress {
     address: string;
 }
 export interface CompileContractResult {
+    version: string;
+    name: string;
     bytecode: string;
+    bytecodeDebugPatch: string;
     /** @format 32-byte-hash */
     codeHash: string;
+    /** @format 32-byte-hash */
+    codeHashDebug: string;
     fields: FieldsSig;
     functions: FunctionSig[];
     events: EventSig[];
+    warnings: string[];
+}
+export interface CompileProjectResult {
+    contracts: CompileContractResult[];
+    scripts: CompileScriptResult[];
 }
 export interface CompileScriptResult {
+    version: string;
+    name: string;
     bytecodeTemplate: string;
+    bytecodeDebugPatch: string;
     fields: FieldsSig;
     functions: FunctionSig[];
+    warnings: string[];
+}
+export interface CompilerOptions {
+    ignoreUnusedConstantsWarnings?: boolean;
+    ignoreUnusedVariablesWarnings?: boolean;
+    ignoreUnusedFieldsWarnings?: boolean;
+    ignoreUnusedPrivateFunctionsWarnings?: boolean;
+    ignoreReadonlyCheckWarnings?: boolean;
+    ignoreExternalCallCheckWarnings?: boolean;
 }
 export interface Confirmed {
     /** @format block-hash */
@@ -324,6 +364,7 @@ export interface Confirmed {
 }
 export interface Contract {
     code: string;
+    compilerOptions?: CompilerOptions;
 }
 export interface ContractEvent {
     /** @format block-hash */
@@ -334,6 +375,15 @@ export interface ContractEvent {
     eventIndex: number;
     fields: Val[];
 }
+export interface ContractEventByBlockHash {
+    /** @format 32-byte-hash */
+    txId: string;
+    /** @format address */
+    contractAddress: string;
+    /** @format int32 */
+    eventIndex: number;
+    fields: Val[];
+}
 export interface ContractEventByTxId {
     /** @format block-hash */
     blockHash: string;
@@ -348,10 +398,11 @@ export interface ContractEvents {
     /** @format int32 */
     nextStart: number;
 }
+export interface ContractEventsByBlockHash {
+    events: ContractEventByBlockHash[];
+}
 export interface ContractEventsByTxId {
     events: ContractEventByTxId[];
-    /** @format int32 */
-    nextStart: number;
 }
 export interface ContractOutput {
     /** @format int32 */
@@ -377,6 +428,11 @@ export interface ContractState {
     fields: Val[];
     asset: AssetState;
 }
+export interface DebugMessage {
+    /** @format address */
+    contractAddress: string;
+    message: string;
+}
 export interface DecodeUnsignedTx {
     unsignedTx: string;
 }
@@ -401,17 +457,13 @@ export interface Destination {
 export declare type DiscoveryAction = Reachable | Unreachable;
 export interface EventSig {
     name: string;
-    signature: string;
     fieldNames: string[];
     fieldTypes: string[];
 }
-export interface FetchResponse {
-    blocks: BlockEntry[][];
-}
 export interface FieldsSig {
-    signature: string;
     names: string[];
     types: string[];
+    isMutable: boolean[];
 }
 export interface FixedAssetOutput {
     /** @format int32 */
@@ -430,9 +482,12 @@ export interface FixedAssetOutput {
 }
 export interface FunctionSig {
     name: string;
-    signature: string;
-    argNames: string[];
-    argTypes: string[];
+    usePreapprovedAssets: boolean;
+    useAssetsInContract: boolean;
+    isPublic: boolean;
+    paramNames: string[];
+    paramTypes: string[];
+    paramIsMutable: boolean[];
     returnTypes: string[];
 }
 export interface Group {
@@ -514,6 +569,10 @@ export interface Penalty {
     value: number;
     type: string;
 }
+export interface Project {
+    code: string;
+    compilerOptions?: CompilerOptions;
+}
 export interface Reachable {
     peers: string[];
     type: string;
@@ -534,6 +593,7 @@ export interface RevealMnemonicResult {
 }
 export interface Script {
     code: string;
+    compilerOptions?: CompilerOptions;
 }
 export interface SelfClique {
     /** @format clique-id */
@@ -580,6 +640,8 @@ export interface Sweep {
     gasPrice?: string;
     /** @format int32 */
     utxosLimit?: number;
+    /** @format block-hash */
+    targetBlockHash?: string;
 }
 export interface SweepAddressTransaction {
     /** @format 32-byte-hash */
@@ -621,6 +683,7 @@ export interface TestContractResult {
     txInputs: string[];
     txOutputs: Output[];
     events: ContractEventByTxId[];
+    debugMessages: DebugMessage[];
 }
 export interface TestInputAsset {
     /** @format address */
@@ -845,8 +908,8 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 1.4.2
- * @baseUrl {protocol}://{host}:{port}
+ * @version 1.5.0
+ * @baseUrl ../
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
     wallets: {
@@ -1003,8 +1066,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/wallets/{wallet_name}/derive-next-address
          */
         postWalletsWalletNameDeriveNextAddress: (walletName: string, query?: {
-            group?: number | undefined;
-        } | undefined, params?: RequestParams) => Promise<AddressInfo>;
+            group?: number;
+        }, params?: RequestParams) => Promise<AddressInfo>;
         /**
          * @description Your wallet need to have been created with the miner flag set to true
          *
@@ -1136,22 +1199,34 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/infos/current-hashrate
          */
         getInfosCurrentHashrate: (query?: {
-            timespan?: number | undefined;
-        } | undefined, params?: RequestParams) => Promise<string>;
+            timespan?: number;
+        }, params?: RequestParams) => Promise<string>;
     };
     blockflow: {
         /**
          * No description
          *
          * @tags Blockflow
-         * @name GetBlockflow
+         * @name GetBlockflowBlocks
          * @summary List blocks on the given time interval
-         * @request GET:/blockflow
+         * @request GET:/blockflow/blocks
          */
-        getBlockflow: (query: {
+        getBlockflowBlocks: (query: {
             fromTs: number;
             toTs?: number;
-        }, params?: RequestParams) => Promise<FetchResponse>;
+        }, params?: RequestParams) => Promise<BlocksPerTimeStampRange>;
+        /**
+         * No description
+         *
+         * @tags Blockflow
+         * @name GetBlockflowBlocksWithEvents
+         * @summary List blocks with events on the given time interval
+         * @request GET:/blockflow/blocks-with-events
+         */
+        getBlockflowBlocksWithEvents: (query: {
+            fromTs: number;
+            toTs?: number;
+        }, params?: RequestParams) => Promise<BlocksAndEventsPerTimeStampRange>;
         /**
          * No description
          *
@@ -1161,6 +1236,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/blockflow/blocks/{block_hash}
          */
         getBlockflowBlocksBlockHash: (blockHash: string, params?: RequestParams) => Promise<BlockEntry>;
+        /**
+         * No description
+         *
+         * @tags Blockflow
+         * @name GetBlockflowBlocksWithEventsBlockHash
+         * @summary Get a block and events with hash
+         * @request GET:/blockflow/blocks-with-events/{block_hash}
+         */
+        getBlockflowBlocksWithEventsBlockHash: (blockHash: string, params?: RequestParams) => Promise<BlockAndEvents>;
         /**
          * No description
          *
@@ -1282,6 +1366,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/transactions/decode-unsigned-tx
          */
         postTransactionsDecodeUnsignedTx: (data: DecodeUnsignedTx, params?: RequestParams) => Promise<DecodeUnsignedTxResult>;
+        /**
+         * No description
+         *
+         * @tags Transactions
+         * @name GetTransactionsDetailsTxid
+         * @summary Get transaction details
+         * @request GET:/transactions/details/{txId}
+         */
+        getTransactionsDetailsTxid: (txId: string, query?: {
+            fromGroup?: number;
+            toGroup?: number;
+        }, params?: RequestParams) => Promise<Transaction>;
         /**
          * No description
          *
@@ -1324,6 +1420,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/contracts/compile-contract
          */
         postContractsCompileContract: (data: Contract, params?: RequestParams) => Promise<CompileContractResult>;
+        /**
+         * No description
+         *
+         * @tags Contracts
+         * @name PostContractsCompileProject
+         * @summary Compile a project
+         * @request POST:/contracts/compile-project
+         */
+        postContractsCompileProject: (data: Project, params?: RequestParams) => Promise<CompileProjectResult>;
         /**
          * No description
          *
@@ -1424,6 +1529,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         postMinersCpuMining: (query: {
             action: string;
         }, params?: RequestParams) => Promise<boolean>;
+        /**
+         * No description
+         *
+         * @tags Miners
+         * @name PostMinersCpuMiningMineOneBlock
+         * @summary Mine a block on CPU miner. !!! for test only !!!
+         * @request POST:/miners/cpu-mining/mine-one-block
+         */
+        postMinersCpuMiningMineOneBlock: (query: {
+            fromGroup: number;
+            toGroup: number;
+        }, params?: RequestParams) => Promise<boolean>;
         /**
          * No description
          *
@@ -1454,7 +1571,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getEventsContractContractaddress: (contractAddress: string, query: {
             start: number;
-            end?: number;
+            limit?: number;
             group?: number;
         }, params?: RequestParams) => Promise<ContractEvents>;
         /**
@@ -1471,12 +1588,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          *
          * @tags Events
          * @name GetEventsTxIdTxid
-         * @summary Get events for a TxScript
+         * @summary Get contract events for a transaction
          * @request GET:/events/tx-id/{txId}
          */
         getEventsTxIdTxid: (txId: string, query?: {
-            group?: number | undefined;
-        } | undefined, params?: RequestParams) => Promise<ContractEventsByTxId>;
+            group?: number;
+        }, params?: RequestParams) => Promise<ContractEventsByTxId>;
+        /**
+         * No description
+         *
+         * @tags Events
+         * @name GetEventsBlockHashBlockhash
+         * @summary Get contract events for a block
+         * @request GET:/events/block-hash/{blockHash}
+         */
+        getEventsBlockHashBlockhash: (blockHash: string, query?: {
+            group?: number;
+        }, params?: RequestParams) => Promise<ContractEventsByBlockHash>;
     };
 }
 export {};