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

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,11 +177,15 @@ export interface BlockHeaderEntry {
 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 {
@@ -186,10 +207,16 @@ export interface BuildDeployContractTx {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format block-hash */
+  targetBlockHash?: string
 }
 
 export interface BuildDeployContractTxResult {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unsignedTx: string
 
@@ -222,10 +249,16 @@ export interface BuildExecuteScriptTx {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format block-hash */
+  targetBlockHash?: string
 }
 
 export interface BuildExecuteScriptTxResult {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unsignedTx: string
 
@@ -259,6 +292,8 @@ export interface BuildMultisig {
 
 export interface BuildMultisigAddress {
   keys: string[]
+
+  /** @format int32 */
   mrequired: number
 }
 
@@ -282,11 +317,18 @@ export interface BuildSweepAddressTransactions {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format block-hash */
+  targetBlockHash?: string
 }
 
 export interface BuildSweepAddressTransactionsResult {
   unsignedTxs: SweepAddressTransaction[]
+
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
 }
 
@@ -301,6 +343,9 @@ export interface BuildTransaction {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format block-hash */
+  targetBlockHash?: string
 }
 
 export interface BuildTransactionResult {
@@ -314,11 +359,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 +379,8 @@ export interface CallContract {
 
   /** @format address */
   address: string
+
+  /** @format int32 */
   methodIndex: number
   args?: Val[]
   existingContracts?: string[]
@@ -337,6 +389,8 @@ export interface CallContract {
 
 export interface CallContractResult {
   returns: Val[]
+
+  /** @format int32 */
   gasUsed: number
   contracts: ContractState[]
   txInputs: string[]
@@ -345,13 +399,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 +440,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 +465,8 @@ export interface ContractEvent {
 
   /** @format 32-byte-hash */
   txId: string
+
+  /** @format int32 */
   eventIndex: number
   fields: Val[]
 }
@@ -406,21 +477,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 +534,10 @@ export interface DecodeUnsignedTx {
 }
 
 export interface DecodeUnsignedTxResult {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unsignedTx: UnsignedTx
 }
@@ -496,6 +577,7 @@ export interface FieldsSig {
 }
 
 export interface FixedAssetOutput {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
@@ -524,6 +606,7 @@ export interface FunctionSig {
 }
 
 export interface Group {
+  /** @format int32 */
   group: number
 }
 
@@ -534,11 +617,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
 }
@@ -566,7 +653,7 @@ export interface NodeInfo {
   upnp: boolean
 
   /** @format inet-socket-address */
-  externalAddress?: string
+  externalAddress?: { addr: string; port: number }
 }
 
 export interface NodeVersion {
@@ -581,6 +668,7 @@ export interface NotFound {
 export type Output = AssetOutput | ContractOutput
 
 export interface OutputRef {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
@@ -590,8 +678,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 +698,7 @@ export interface PeerMisbehavior {
 export type PeerStatus = Banned | Penalty
 
 export interface Penalty {
+  /** @format int32 */
   value: number
   type: string
 }
@@ -614,8 +709,13 @@ export interface Reachable {
 }
 
 export interface ReleaseVersion {
+  /** @format int32 */
   major: number
+
+  /** @format int32 */
   minor: number
+
+  /** @format int32 */
   patch: number
 }
 
@@ -667,7 +767,11 @@ export interface SubmitTransaction {
 export interface SubmitTxResult {
   /** @format 32-byte-hash */
   txId: string
+
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
 }
 
@@ -683,7 +787,12 @@ export interface Sweep {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format int32 */
   utxosLimit?: number
+
+  /** @format block-hash */
+  targetBlockHash?: string
 }
 
 export interface SweepAddressTransaction {
@@ -699,6 +808,7 @@ export interface SweepAddressTransaction {
 }
 
 export interface TestContract {
+  /** @format int32 */
   group?: number
 
   /** @format block-hash */
@@ -714,6 +824,8 @@ export interface TestContract {
   bytecode: string
   initialFields?: Val[]
   initialAsset?: AssetState
+
+  /** @format int32 */
   methodIndex?: number
   args?: Val[]
   existingContracts?: ContractState[]
@@ -727,6 +839,8 @@ export interface TestContractResult {
   /** @format 32-byte-hash */
   codeHash: string
   returns: Val[]
+
+  /** @format int32 */
   gasUsed: number
   contracts: ContractState[]
   txInputs: string[]
@@ -771,6 +885,8 @@ export interface Transfer {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format int32 */
   utxosLimit?: number
 }
 
@@ -824,7 +940,10 @@ export interface Unban {
 }
 
 export interface UnconfirmedTransactions {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unconfirmedTransactions: TransactionTemplate[]
 }
@@ -842,6 +961,8 @@ export interface UnsignedTx {
 
   /** @format script */
   scriptOpt?: string
+
+  /** @format int32 */
   gasAmount: number
 
   /** @format uint256 */
@@ -875,6 +996,7 @@ export interface ValByteVec {
 }
 
 export interface ValI256 {
+  /** @format bigint */
   value: string
   type: string
 }
@@ -1157,7 +1279,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 1.4.0
+ * @version 1.5.0-rc0
  * @baseUrl {protocol}://{host}:{port}
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {

package/src/api/api-explorer.ts

@@ -23,6 +23,8 @@ export interface AddressInfo {
 
   /** @format uint256 */
   lockedBalance: string
+
+  /** @format int32 */
   txNumber: number
 }
 
@@ -31,13 +33,22 @@ export interface BadRequest {
 }
 
 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
 
@@ -46,13 +57,18 @@ export interface BlockEntryLite {
 }
 
 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 */
@@ -68,13 +84,15 @@ 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
 
@@ -87,6 +105,7 @@ export interface InternalServerError {
 }
 
 export interface ListBlocks {
+  /** @format int32 */
   total: number
   blocks?: BlockEntryLite[]
 }
@@ -97,6 +116,7 @@ export interface NotFound {
 }
 
 export interface Output {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
@@ -108,10 +128,13 @@ export interface Output {
 
   /** @format int64 */
   lockTime?: number
+
+  /** @format 32-byte-hash */
   spent?: string
 }
 
 export interface OutputRef {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
@@ -119,7 +142,10 @@ export interface OutputRef {
 }
 
 export interface PerChainCount {
+  /** @format int32 */
   chainFrom: number
+
+  /** @format int32 */
   chainTo: number
 
   /** @format int64 */
@@ -127,7 +153,10 @@ export interface PerChainCount {
 }
 
 export interface PerChainDuration {
+  /** @format int32 */
   chainFrom: number
+
+  /** @format int32 */
   chainTo: number
 
   /** @format int64 */
@@ -138,7 +167,10 @@ export interface PerChainDuration {
 }
 
 export interface PerChainHeight {
+  /** @format int32 */
   chainFrom: number
+
+  /** @format int32 */
   chainTo: number
 
   /** @format int64 */
@@ -187,13 +219,18 @@ export interface TokenSupply {
 }
 
 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 */
@@ -221,11 +258,18 @@ export interface Unauthorized {
 }
 
 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 */
@@ -647,7 +691,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request GET:/infos/supply/total-alph
      */
     getInfosSupplyTotalAlph: (params: RequestParams = {}) =>
-      this.request<string, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+      this.request<number, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
         path: `/infos/supply/total-alph`,
         method: 'GET',
         ...params
@@ -661,7 +705,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request GET:/infos/supply/circulating-alph
      */
     getInfosSupplyCirculatingAlph: (params: RequestParams = {}) =>
-      this.request<string, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+      this.request<number, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
         path: `/infos/supply/circulating-alph`,
         method: 'GET',
         ...params
@@ -675,7 +719,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request GET:/infos/supply/reserved-alph
      */
     getInfosSupplyReservedAlph: (params: RequestParams = {}) =>
-      this.request<string, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+      this.request<number, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
         path: `/infos/supply/reserved-alph`,
         method: 'GET',
         ...params
@@ -689,7 +733,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request GET:/infos/supply/locked-alph
      */
     getInfosSupplyLockedAlph: (params: RequestParams = {}) =>
-      this.request<string, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+      this.request<number, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
         path: `/infos/supply/locked-alph`,
         method: 'GET',
         ...params