@alephium/web3 0.44.0 → 1.0.0

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

@@ -1,3 +1,4 @@
+/** AddressBalance */
 export interface AddressBalance {
     /** @format address */
     address: string;
@@ -11,6 +12,7 @@ export interface AddressBalance {
     lockedBalanceHint: string;
     warning?: string;
 }
+/** AddressInfo */
 export interface AddressInfo {
     /** @format address */
     address: string;
@@ -20,16 +22,19 @@ export interface AddressInfo {
     group: number;
     path: string;
 }
+/** Addresses */
 export interface Addresses {
     /** @format address */
     activeAddress: string;
     addresses: AddressInfo[];
 }
+/** AssetInput */
 export interface AssetInput {
     outputRef: OutputRef;
     /** @format hex-string */
     unlockScript: string;
 }
+/** AssetOutput */
 export interface AssetOutput {
     /** @format int32 */
     hint: number;
@@ -46,14 +51,17 @@ export interface AssetOutput {
     message: string;
     type: string;
 }
+/** AssetState */
 export interface AssetState {
     /** @format uint256 */
     attoAlphAmount: string;
     tokens?: Token[];
 }
+/** BadRequest */
 export interface BadRequest {
     detail: string;
 }
+/** Balance */
 export interface Balance {
     /** @format uint256 */
     balance: string;
@@ -69,6 +77,7 @@ export interface Balance {
     utxoNum: number;
     warning?: string;
 }
+/** Balances */
 export interface Balances {
     /** @format uint256 */
     totalBalance: string;
@@ -76,19 +85,23 @@ export interface Balances {
     totalBalanceHint: string;
     balances: AddressBalance[];
 }
+/** Ban */
 export interface Ban {
     peers: string[];
     type: string;
 }
+/** Banned */
 export interface Banned {
     /** @format int64 */
     until: number;
     type: string;
 }
+/** BlockAndEvents */
 export interface BlockAndEvents {
     block: BlockEntry;
     events: ContractEventByBlockHash[];
 }
+/** BlockEntry */
 export interface BlockEntry {
     /** @format block-hash */
     hash: string;
@@ -111,7 +124,9 @@ export interface BlockEntry {
     txsHash: string;
     /** @format hex-string */
     target: string;
+    ghostUncles: GhostUncleBlockEntry[];
 }
+/** BlockHeaderEntry */
 export interface BlockHeaderEntry {
     /** @format block-hash */
     hash: string;
@@ -125,12 +140,15 @@ export interface BlockHeaderEntry {
     height: number;
     deps: string[];
 }
+/** BlocksAndEventsPerTimeStampRange */
 export interface BlocksAndEventsPerTimeStampRange {
     blocksAndEvents: BlockAndEvents[][];
 }
+/** BlocksPerTimeStampRange */
 export interface BlocksPerTimeStampRange {
     blocks: BlockEntry[][];
 }
+/** BrokerInfo */
 export interface BrokerInfo {
     /** @format clique-id */
     cliqueId: string;
@@ -145,6 +163,7 @@ export interface BrokerInfo {
         port: number;
     };
 }
+/** BuildDeployContractTx */
 export interface BuildDeployContractTx {
     /** @format hex-string */
     fromPublicKey: string;
@@ -166,6 +185,7 @@ export interface BuildDeployContractTx {
     /** @format block-hash */
     targetBlockHash?: string;
 }
+/** BuildDeployContractTxResult */
 export interface BuildDeployContractTxResult {
     /** @format int32 */
     fromGroup: number;
@@ -181,6 +201,7 @@ export interface BuildDeployContractTxResult {
     /** @format address */
     contractAddress: string;
 }
+/** BuildExecuteScriptTx */
 export interface BuildExecuteScriptTx {
     /** @format hex-string */
     fromPublicKey: string;
@@ -198,6 +219,7 @@ export interface BuildExecuteScriptTx {
     /** @format block-hash */
     targetBlockHash?: string;
 }
+/** BuildExecuteScriptTxResult */
 export interface BuildExecuteScriptTxResult {
     /** @format int32 */
     fromGroup: number;
@@ -211,10 +233,12 @@ export interface BuildExecuteScriptTxResult {
     /** @format 32-byte-hash */
     txId: string;
 }
+/** BuildInfo */
 export interface BuildInfo {
     releaseVersion: string;
     commit: string;
 }
+/** BuildMultiAddressesTransaction */
 export interface BuildMultiAddressesTransaction {
     from: Source[];
     /** @format uint256 */
@@ -222,6 +246,7 @@ export interface BuildMultiAddressesTransaction {
     /** @format block-hash */
     targetBlockHash?: string;
 }
+/** BuildMultisig */
 export interface BuildMultisig {
     /** @format address */
     fromAddress: string;
@@ -232,15 +257,18 @@ export interface BuildMultisig {
     /** @format uint256 */
     gasPrice?: string;
 }
+/** BuildMultisigAddress */
 export interface BuildMultisigAddress {
     keys: string[];
     /** @format int32 */
     mrequired: number;
 }
+/** BuildMultisigAddressResult */
 export interface BuildMultisigAddressResult {
     /** @format address */
     address: string;
 }
+/** BuildSweepAddressTransactions */
 export interface BuildSweepAddressTransactions {
     /** @format public-key */
     fromPublicKey: string;
@@ -257,6 +285,7 @@ export interface BuildSweepAddressTransactions {
     /** @format block-hash */
     targetBlockHash?: string;
 }
+/** BuildSweepAddressTransactionsResult */
 export interface BuildSweepAddressTransactionsResult {
     unsignedTxs: SweepAddressTransaction[];
     /** @format int32 */
@@ -264,6 +293,7 @@ export interface BuildSweepAddressTransactionsResult {
     /** @format int32 */
     toGroup: number;
 }
+/** BuildSweepMultisig */
 export interface BuildSweepMultisig {
     /** @format address */
     fromAddress: string;
@@ -283,6 +313,7 @@ export interface BuildSweepMultisig {
     /** @format block-hash */
     targetBlockHash?: string;
 }
+/** BuildTransaction */
 export interface BuildTransaction {
     /** @format hex-string */
     fromPublicKey: string;
@@ -297,6 +328,7 @@ export interface BuildTransaction {
     /** @format block-hash */
     targetBlockHash?: string;
 }
+/** BuildTransactionResult */
 export interface BuildTransactionResult {
     unsignedTx: string;
     /** @format gas */
@@ -310,6 +342,7 @@ export interface BuildTransactionResult {
     /** @format int32 */
     toGroup: number;
 }
+/** CallContract */
 export interface CallContract {
     /** @format int32 */
     group: number;
@@ -327,11 +360,14 @@ export interface CallContract {
     existingContracts?: string[];
     inputAssets?: TestInputAsset[];
 }
+/** CallContractFailed */
 export interface CallContractFailed {
     error: string;
     type: string;
 }
+/** CallContractResult */
 export type CallContractResult = CallContractFailed | CallContractSucceeded;
+/** CallContractSucceeded */
 export interface CallContractSucceeded {
     returns: Val[];
     /** @format int32 */
@@ -343,10 +379,12 @@ export interface CallContractSucceeded {
     debugMessages: DebugMessage[];
     type: string;
 }
+/** ChainInfo */
 export interface ChainInfo {
     /** @format int32 */
     currentHeight: number;
 }
+/** ChainParams */
 export interface ChainParams {
     networkId: number;
     /** @format int32 */
@@ -356,10 +394,12 @@ export interface ChainParams {
     /** @format int32 */
     groups: number;
 }
+/** ChangeActiveAddress */
 export interface ChangeActiveAddress {
     /** @format address */
     address: string;
 }
+/** CompileContractResult */
 export interface CompileContractResult {
     version: string;
     name: string;
@@ -378,11 +418,13 @@ export interface CompileContractResult {
     maps?: MapsSig;
     stdInterfaceId?: string;
 }
+/** CompileProjectResult */
 export interface CompileProjectResult {
     contracts: CompileContractResult[];
     scripts: CompileScriptResult[];
     structs?: StructSig[];
 }
+/** CompileScriptResult */
 export interface CompileScriptResult {
     version: string;
     name: string;
@@ -392,6 +434,7 @@ export interface CompileScriptResult {
     functions: FunctionSig[];
     warnings: string[];
 }
+/** CompilerOptions */
 export interface CompilerOptions {
     ignoreUnusedConstantsWarnings?: boolean;
     ignoreUnusedVariablesWarnings?: boolean;
@@ -400,6 +443,7 @@ export interface CompilerOptions {
     ignoreUpdateFieldsCheckWarnings?: boolean;
     ignoreCheckExternalCallerWarnings?: boolean;
 }
+/** Confirmed */
 export interface Confirmed {
     /** @format block-hash */
     blockHash: string;
@@ -413,14 +457,17 @@ export interface Confirmed {
     toGroupConfirmations: number;
     type: string;
 }
+/** Constant */
 export interface Constant {
     name: string;
     value: Val;
 }
+/** Contract */
 export interface Contract {
     code: string;
     compilerOptions?: CompilerOptions;
 }
+/** ContractEvent */
 export interface ContractEvent {
     /** @format block-hash */
     blockHash: string;
@@ -430,6 +477,7 @@ export interface ContractEvent {
     eventIndex: number;
     fields: Val[];
 }
+/** ContractEventByBlockHash */
 export interface ContractEventByBlockHash {
     /** @format 32-byte-hash */
     txId: string;
@@ -439,6 +487,7 @@ export interface ContractEventByBlockHash {
     eventIndex: number;
     fields: Val[];
 }
+/** ContractEventByTxId */
 export interface ContractEventByTxId {
     /** @format block-hash */
     blockHash: string;
@@ -448,17 +497,21 @@ export interface ContractEventByTxId {
     eventIndex: number;
     fields: Val[];
 }
+/** ContractEvents */
 export interface ContractEvents {
     events: ContractEvent[];
     /** @format int32 */
     nextStart: number;
 }
+/** ContractEventsByBlockHash */
 export interface ContractEventsByBlockHash {
     events: ContractEventByBlockHash[];
 }
+/** ContractEventsByTxId */
 export interface ContractEventsByTxId {
     events: ContractEventByTxId[];
 }
+/** ContractOutput */
 export interface ContractOutput {
     /** @format int32 */
     hint: number;
@@ -471,6 +524,7 @@ export interface ContractOutput {
     tokens: Token[];
     type: string;
 }
+/** ContractState */
 export interface ContractState {
     /** @format address */
     address: string;
@@ -484,14 +538,17 @@ export interface ContractState {
     mutFields: Val[];
     asset: AssetState;
 }
+/** DebugMessage */
 export interface DebugMessage {
     /** @format address */
     contractAddress: string;
     message: string;
 }
+/** DecodeUnsignedTx */
 export interface DecodeUnsignedTx {
     unsignedTx: string;
 }
+/** DecodeUnsignedTxResult */
 export interface DecodeUnsignedTxResult {
     /** @format int32 */
     fromGroup: number;
@@ -499,6 +556,7 @@ export interface DecodeUnsignedTxResult {
     toGroup: number;
     unsignedTx: UnsignedTx;
 }
+/** Destination */
 export interface Destination {
     /** @format address */
     address: string;
@@ -510,25 +568,31 @@ export interface Destination {
     /** @format hex-string */
     message?: string;
 }
+/** DiscoveryAction */
 export type DiscoveryAction = Reachable | Unreachable;
+/** Enum */
 export interface Enum {
     name: string;
     fields: EnumField[];
 }
+/** EnumField */
 export interface EnumField {
     name: string;
     value: Val;
 }
+/** EventSig */
 export interface EventSig {
     name: string;
     fieldNames: string[];
     fieldTypes: string[];
 }
+/** FieldsSig */
 export interface FieldsSig {
     names: string[];
     types: string[];
     isMutable: boolean[];
 }
+/** FixedAssetOutput */
 export interface FixedAssetOutput {
     /** @format int32 */
     hint: number;
@@ -544,6 +608,7 @@ export interface FixedAssetOutput {
     /** @format hex-string */
     message: string;
 }
+/** FunctionSig */
 export interface FunctionSig {
     name: string;
     usePreapprovedAssets: boolean;
@@ -554,13 +619,23 @@ export interface FunctionSig {
     paramIsMutable: boolean[];
     returnTypes: string[];
 }
+/** GhostUncleBlockEntry */
+export interface GhostUncleBlockEntry {
+    /** @format block-hash */
+    blockHash: string;
+    /** @format address */
+    miner: string;
+}
+/** Group */
 export interface Group {
     /** @format int32 */
     group: number;
 }
+/** HashesAtHeight */
 export interface HashesAtHeight {
     headers: string[];
 }
+/** InterCliquePeerInfo */
 export interface InterCliquePeerInfo {
     /** @format clique-id */
     cliqueId: string;
@@ -577,16 +652,20 @@ export interface InterCliquePeerInfo {
     isSynced: boolean;
     clientVersion: string;
 }
+/** InternalServerError */
 export interface InternalServerError {
     detail: string;
 }
+/** MapsSig */
 export interface MapsSig {
     names: string[];
     types: string[];
 }
+/** MemPooled */
 export interface MemPooled {
     type: string;
 }
+/** MempoolTransactions */
 export interface MempoolTransactions {
     /** @format int32 */
     fromGroup: number;
@@ -594,19 +673,25 @@ export interface MempoolTransactions {
     toGroup: number;
     transactions: TransactionTemplate[];
 }
+/** MinerAddresses */
 export interface MinerAddresses {
     addresses: string[];
 }
+/** MinerAddressesInfo */
 export interface MinerAddressesInfo {
     addresses: AddressInfo[];
 }
+/** MisbehaviorAction */
 export type MisbehaviorAction = Ban | Unban;
+/** MultipleCallContract */
 export interface MultipleCallContract {
     calls: CallContract[];
 }
+/** MultipleCallContractResult */
 export interface MultipleCallContractResult {
     results: CallContractResult[];
 }
+/** NodeInfo */
 export interface NodeInfo {
     buildInfo: BuildInfo;
     upnp: boolean;
@@ -617,21 +702,26 @@ export interface NodeInfo {
         port: number;
     };
 }
+/** NodeVersion */
 export interface NodeVersion {
     /** @format semver */
     version: string;
 }
+/** NotFound */
 export interface NotFound {
     detail: string;
     resource: string;
 }
+/** Output */
 export type Output = AssetOutput | ContractOutput;
+/** OutputRef */
 export interface OutputRef {
     /** @format int32 */
     hint: number;
     /** @format 32-byte-hash */
     key: string;
 }
+/** PeerAddress */
 export interface PeerAddress {
     /** @format inet-address */
     address: string;
@@ -642,39 +732,49 @@ export interface PeerAddress {
     /** @format int32 */
     minerApiPort: number;
 }
+/** PeerMisbehavior */
 export interface PeerMisbehavior {
     /** @format inet-address */
     peer: string;
     status: PeerStatus;
 }
+/** PeerStatus */
 export type PeerStatus = Banned | Penalty;
+/** Penalty */
 export interface Penalty {
     /** @format int32 */
     value: number;
     type: string;
 }
+/** Project */
 export interface Project {
     code: string;
     compilerOptions?: CompilerOptions;
 }
+/** Reachable */
 export interface Reachable {
     peers: string[];
     type: string;
 }
+/** Result */
 export interface Result {
     /** @format bigint */
     hashrate: string;
 }
+/** RevealMnemonic */
 export interface RevealMnemonic {
     password: string;
 }
+/** RevealMnemonicResult */
 export interface RevealMnemonicResult {
     mnemonic: string;
 }
+/** Script */
 export interface Script {
     code: string;
     compilerOptions?: CompilerOptions;
 }
+/** SelfClique */
 export interface SelfClique {
     /** @format clique-id */
     cliqueId: string;
@@ -682,16 +782,21 @@ export interface SelfClique {
     selfReady: boolean;
     synced: boolean;
 }
+/** ServiceUnavailable */
 export interface ServiceUnavailable {
     detail: string;
 }
+/** Sign */
 export interface Sign {
+    /** @format 32-byte-hash */
     data: string;
 }
+/** SignResult */
 export interface SignResult {
     /** @format signature */
     signature: string;
 }
+/** Source */
 export interface Source {
     /** @format hex-string */
     fromPublicKey: string;
@@ -702,21 +807,25 @@ export interface Source {
     gasAmount?: number;
     utxos?: OutputRef[];
 }
+/** StructSig */
 export interface StructSig {
     name: string;
     fieldNames: string[];
     fieldTypes: string[];
     isMutable: boolean[];
 }
+/** SubmitMultisig */
 export interface SubmitMultisig {
     unsignedTx: string;
     signatures: string[];
 }
+/** SubmitTransaction */
 export interface SubmitTransaction {
     unsignedTx: string;
     /** @format signature */
     signature: string;
 }
+/** SubmitTxResult */
 export interface SubmitTxResult {
     /** @format 32-byte-hash */
     txId: string;
@@ -725,6 +834,7 @@ export interface SubmitTxResult {
     /** @format int32 */
     toGroup: number;
 }
+/** Sweep */
 export interface Sweep {
     /** @format address */
     toAddress: string;
@@ -739,6 +849,7 @@ export interface Sweep {
     /** @format block-hash */
     targetBlockHash?: string;
 }
+/** SweepAddressTransaction */
 export interface SweepAddressTransaction {
     /** @format 32-byte-hash */
     txId: string;
@@ -748,10 +859,12 @@ export interface SweepAddressTransaction {
     /** @format uint256 */
     gasPrice: string;
 }
+/** TargetToHashrate */
 export interface TargetToHashrate {
     /** @format hex-string */
     target: string;
 }
+/** TestContract */
 export interface TestContract {
     /** @format int32 */
     group?: number;
@@ -776,6 +889,7 @@ export interface TestContract {
     existingContracts?: ContractState[];
     inputAssets?: TestInputAsset[];
 }
+/** TestContractResult */
 export interface TestContractResult {
     /** @format address */
     address: string;
@@ -790,17 +904,20 @@ export interface TestContractResult {
     events: ContractEventByTxId[];
     debugMessages: DebugMessage[];
 }
+/** TestInputAsset */
 export interface TestInputAsset {
     /** @format address */
     address: string;
     asset: AssetState;
 }
+/** Token */
 export interface Token {
     /** @format 32-byte-hash */
     id: string;
     /** @format uint256 */
     amount: string;
 }
+/** Transaction */
 export interface Transaction {
     unsigned: UnsignedTx;
     scriptExecutionOk: boolean;
@@ -809,11 +926,13 @@ export interface Transaction {
     inputSignatures: string[];
     scriptSignatures: string[];
 }
+/** TransactionTemplate */
 export interface TransactionTemplate {
     unsigned: UnsignedTx;
     inputSignatures: string[];
     scriptSignatures: string[];
 }
+/** Transfer */
 export interface Transfer {
     destinations: Destination[];
     /** @format gas */
@@ -823,6 +942,7 @@ export interface Transfer {
     /** @format int32 */
     utxosLimit?: number;
 }
+/** TransferResult */
 export interface TransferResult {
     /** @format 32-byte-hash */
     txId: string;
@@ -831,13 +951,17 @@ export interface TransferResult {
     /** @format group-index */
     toGroup: number;
 }
+/** TransferResults */
 export interface TransferResults {
     results: TransferResult[];
 }
+/** TxNotFound */
 export interface TxNotFound {
     type: string;
 }
+/** TxStatus */
 export type TxStatus = Confirmed | MemPooled | TxNotFound;
+/** UTXO */
 export interface UTXO {
     ref: OutputRef;
     /** @format uint256 */
@@ -848,21 +972,26 @@ export interface UTXO {
     /** @format hex-string */
     additionalData?: string;
 }
+/** UTXOs */
 export interface UTXOs {
     utxos: UTXO[];
     warning?: string;
 }
+/** Unauthorized */
 export interface Unauthorized {
     detail: string;
 }
+/** Unban */
 export interface Unban {
     peers: string[];
     type: string;
 }
+/** Unreachable */
 export interface Unreachable {
     peers: string[];
     type: string;
 }
+/** UnsignedTx */
 export interface UnsignedTx {
     /** @format 32-byte-hash */
     txId: string;
@@ -877,35 +1006,43 @@ export interface UnsignedTx {
     inputs: AssetInput[];
     fixedOutputs: FixedAssetOutput[];
 }
+/** Val */
 export type Val = ValAddress | ValArray | ValBool | ValByteVec | ValI256 | ValU256;
+/** ValAddress */
 export interface ValAddress {
     /** @format address */
     value: string;
     type: string;
 }
+/** ValArray */
 export interface ValArray {
     value: Val[];
     type: string;
 }
+/** ValBool */
 export interface ValBool {
     value: boolean;
     type: string;
 }
+/** ValByteVec */
 export interface ValByteVec {
     /** @format hex-string */
     value: string;
     type: string;
 }
+/** ValI256 */
 export interface ValI256 {
     /** @format bigint */
     value: string;
     type: string;
 }
+/** ValU256 */
 export interface ValU256 {
     /** @format uint256 */
     value: string;
     type: string;
 }
+/** VerifySignature */
 export interface VerifySignature {
     /** @format hex-string */
     data: string;
@@ -914,6 +1051,7 @@ export interface VerifySignature {
     /** @format public-key */
     publicKey: string;
 }
+/** WalletCreation */
 export interface WalletCreation {
     password: string;
     walletName: string;
@@ -921,13 +1059,16 @@ export interface WalletCreation {
     mnemonicPassphrase?: string;
     mnemonicSize?: number;
 }
+/** WalletCreationResult */
 export interface WalletCreationResult {
     walletName: string;
     mnemonic: string;
 }
+/** WalletDeletion */
 export interface WalletDeletion {
     password: string;
 }
+/** WalletRestore */
 export interface WalletRestore {
     password: string;
     mnemonic: string;
@@ -935,13 +1076,16 @@ export interface WalletRestore {
     isMiner?: boolean;
     mnemonicPassphrase?: string;
 }
+/** WalletRestoreResult */
 export interface WalletRestoreResult {
     walletName: string;
 }
+/** WalletStatus */
 export interface WalletStatus {
     walletName: string;
     locked: boolean;
 }
+/** WalletUnlock */
 export interface WalletUnlock {
     password: string;
     mnemonicPassphrase?: string;
@@ -1007,7 +1151,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Alephium API
- * @version 2.14.0
+ * @version 3.1.0
  * @baseUrl ../
  */
 export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
@@ -1373,6 +1517,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 GetBlockflowMainChainBlockByGhostUncleGhostUncleHash
+         * @summary Get a mainchain block by ghost uncle hash
+         * @request GET:/blockflow/main-chain-block-by-ghost-uncle/{ghost_uncle_hash}
+         */
+        getBlockflowMainChainBlockByGhostUncleGhostUncleHash: (ghostUncleHash: string, params?: RequestParams) => Promise<BlockEntry>;
         /**
          * No description
          *