@alephium/web3 0.1.0-rc.1 → 0.1.0

package/src/api/api-alephium.ts

@@ -53,13 +53,14 @@ export interface AssetInput {
 }
 
 export interface AssetOutput {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
   key: string
 
   /** @format uint256 */
-  alphAmount: string
+  attoAlphAmount: string
 
   /** @format address */
   address: string
@@ -75,7 +76,7 @@ export interface AssetOutput {
 
 export interface AssetState {
   /** @format uint256 */
-  alphAmount: string
+  attoAlphAmount: string
   tokens?: Token[]
 }
 
@@ -95,6 +96,8 @@ export interface Balance {
 
   /** @format x.x ALPH */
   lockedBalanceHint: string
+
+  /** @format int32 */
   utxoNum: number
   warning?: string
 }
@@ -125,8 +128,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 +160,14 @@ export interface BlockHeaderEntry {
 
   /** @format int64 */
   timestamp: number
+
+  /** @format int32 */
   chainFrom: number
+
+  /** @format int32 */
   chainTo: number
+
+  /** @format int32 */
   height: number
   deps: string[]
 }
@@ -160,11 +175,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 {
@@ -175,7 +194,7 @@ export interface BuildDeployContractTx {
   bytecode: string
 
   /** @format uint256 */
-  initialAlphAmount?: string
+  initialAttoAlphAmount?: string
   initialTokenAmounts?: Token[]
 
   /** @format uint256 */
@@ -189,7 +208,10 @@ export interface BuildDeployContractTx {
 }
 
 export interface BuildDeployContractTxResult {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unsignedTx: string
 
@@ -214,7 +236,7 @@ export interface BuildExecuteScriptTx {
   bytecode: string
 
   /** @format uint256 */
-  alphAmount?: string
+  attoAlphAmount?: string
   tokens?: Token[]
 
   /** @format gas */
@@ -225,7 +247,10 @@ export interface BuildExecuteScriptTx {
 }
 
 export interface BuildExecuteScriptTxResult {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unsignedTx: string
 
@@ -259,6 +284,8 @@ export interface BuildMultisig {
 
 export interface BuildMultisigAddress {
   keys: string[]
+
+  /** @format int32 */
   mrequired: number
 }
 
@@ -286,7 +313,11 @@ export interface BuildSweepAddressTransactions {
 
 export interface BuildSweepAddressTransactionsResult {
   unsignedTxs: SweepAddressTransaction[]
+
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
 }
 
@@ -314,11 +345,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 +365,8 @@ export interface CallContract {
 
   /** @format address */
   address: string
+
+  /** @format int32 */
   methodIndex: number
   args?: Val[]
   existingContracts?: string[]
@@ -337,6 +375,8 @@ export interface CallContract {
 
 export interface CallContractResult {
   returns: Val[]
+
+  /** @format int32 */
   gasUsed: number
   contracts: ContractState[]
   txInputs: string[]
@@ -345,13 +385,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 +426,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 +451,8 @@ export interface ContractEvent {
 
   /** @format 32-byte-hash */
   txId: string
+
+  /** @format int32 */
   eventIndex: number
   fields: Val[]
 }
@@ -406,28 +463,35 @@ 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 */
   key: string
 
   /** @format uint256 */
-  alphAmount: string
+  attoAlphAmount: string
 
   /** @format address */
   address: string
@@ -456,7 +520,10 @@ export interface DecodeUnsignedTx {
 }
 
 export interface DecodeUnsignedTxResult {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unsignedTx: UnsignedTx
 }
@@ -466,7 +533,7 @@ export interface Destination {
   address: string
 
   /** @format uint256 */
-  alphAmount: string
+  attoAlphAmount: string
   tokens?: Token[]
 
   /** @format int64 */
@@ -496,13 +563,14 @@ export interface FieldsSig {
 }
 
 export interface FixedAssetOutput {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
   key: string
 
   /** @format uint256 */
-  alphAmount: string
+  attoAlphAmount: string
 
   /** @format address */
   address: string
@@ -524,6 +592,7 @@ export interface FunctionSig {
 }
 
 export interface Group {
+  /** @format int32 */
   group: number
 }
 
@@ -534,11 +603,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 +639,7 @@ export interface NodeInfo {
   upnp: boolean
 
   /** @format inet-socket-address */
-  externalAddress?: string
+  externalAddress?: { addr: string; port: number }
 }
 
 export interface NodeVersion {
@@ -581,6 +654,7 @@ export interface NotFound {
 export type Output = AssetOutput | ContractOutput
 
 export interface OutputRef {
+  /** @format int32 */
   hint: number
 
   /** @format 32-byte-hash */
@@ -590,8 +664,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 +684,7 @@ export interface PeerMisbehavior {
 export type PeerStatus = Banned | Penalty
 
 export interface Penalty {
+  /** @format int32 */
   value: number
   type: string
 }
@@ -614,8 +695,13 @@ export interface Reachable {
 }
 
 export interface ReleaseVersion {
+  /** @format int32 */
   major: number
+
+  /** @format int32 */
   minor: number
+
+  /** @format int32 */
   patch: number
 }
 
@@ -667,7 +753,11 @@ export interface SubmitTransaction {
 export interface SubmitTxResult {
   /** @format 32-byte-hash */
   txId: string
+
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
 }
 
@@ -683,6 +773,8 @@ export interface Sweep {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format int32 */
   utxosLimit?: number
 }
 
@@ -699,6 +791,7 @@ export interface SweepAddressTransaction {
 }
 
 export interface TestContract {
+  /** @format int32 */
   group?: number
 
   /** @format block-hash */
@@ -714,6 +807,8 @@ export interface TestContract {
   bytecode: string
   initialFields?: Val[]
   initialAsset?: AssetState
+
+  /** @format int32 */
   methodIndex?: number
   args?: Val[]
   existingContracts?: ContractState[]
@@ -727,6 +822,8 @@ export interface TestContractResult {
   /** @format 32-byte-hash */
   codeHash: string
   returns: Val[]
+
+  /** @format int32 */
   gasUsed: number
   contracts: ContractState[]
   txInputs: string[]
@@ -771,6 +868,8 @@ export interface Transfer {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format int32 */
   utxosLimit?: number
 }
 
@@ -824,7 +923,10 @@ export interface Unban {
 }
 
 export interface UnconfirmedTransactions {
+  /** @format int32 */
   fromGroup: number
+
+  /** @format int32 */
   toGroup: number
   unconfirmedTransactions: TransactionTemplate[]
 }
@@ -842,6 +944,8 @@ export interface UnsignedTx {
 
   /** @format script */
   scriptOpt?: string
+
+  /** @format int32 */
   gasAmount: number
 
   /** @format uint256 */
@@ -875,6 +979,7 @@ export interface ValByteVec {
 }
 
 export interface ValI256 {
+  /** @format bigint */
   value: string
   type: string
 }
@@ -1157,7 +1262,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 1.4.0
+ * @version 1.4.2
  * @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

package/src/contract/contract.ts

@@ -466,7 +466,7 @@ export class Contract extends Common {
     const signerParams: SignDeployContractTxParams = {
       signerAddress: params.signerAddress,
       bytecode: bytecode,
-      initialAlphAmount: extractOptionalNumber256(params.initialAlphAmount),
+      initialAttoAlphAmount: extractOptionalNumber256(params.initialAttoAlphAmount),
       issueTokenAmount: extractOptionalNumber256(params.issueTokenAmount),
       initialTokenAmounts: params.initialTokenAmounts?.map(toApiToken),
       gasAmount: params.gasAmount,
@@ -580,7 +580,7 @@ export class Script extends Common {
     const signerParams: SignExecuteScriptTxParams = {
       signerAddress: params.signerAddress,
       bytecode: this.buildByteCodeToDeploy(params.initialFields ? params.initialFields : {}),
-      alphAmount: extractOptionalNumber256(params.alphAmount),
+      attoAlphAmount: extractOptionalNumber256(params.attoAlphAmount),
       tokens: typeof params.tokens !== 'undefined' ? params.tokens.map(toApiToken) : undefined,
       gasAmount: params.gasAmount,
       gasPrice: extractOptionalNumber256(params.gasPrice)
@@ -825,14 +825,14 @@ function fromApiToken(token: node.Token): Token {
 
 function toApiAsset(asset: Asset): node.AssetState {
   return {
-    alphAmount: extractNumber256(asset.alphAmount),
+    attoAlphAmount: extractNumber256(asset.alphAmount),
     tokens: typeof asset.tokens !== 'undefined' ? asset.tokens.map(toApiToken) : []
   }
 }
 
 function fromApiAsset(asset: node.AssetState): Asset {
   return {
-    alphAmount: decodeNumber256(asset.alphAmount),
+    alphAmount: decodeNumber256(asset.attoAlphAmount),
     tokens: typeof asset.tokens !== 'undefined' ? asset.tokens.map(fromApiToken) : undefined
   }
 }
@@ -950,7 +950,7 @@ function fromApiOutput(output: node.Output): Output {
     return {
       type: 'AssetOutput',
       address: asset.address,
-      alphAmount: decodeNumber256(asset.alphAmount),
+      alphAmount: decodeNumber256(asset.attoAlphAmount),
       tokens: asset.tokens.map(fromApiToken),
       lockTime: asset.lockTime,
       message: asset.message
@@ -960,7 +960,7 @@ function fromApiOutput(output: node.Output): Output {
     return {
       type: 'ContractOutput',
       address: asset.address,
-      alphAmount: decodeNumber256(asset.alphAmount),
+      alphAmount: decodeNumber256(asset.attoAlphAmount),
       tokens: asset.tokens.map(fromApiToken)
     }
   } else {
@@ -986,7 +986,7 @@ type BuildTxParams<T> = Omit<T, 'bytecode'> & { initialFields?: Val[] }
 export interface BuildDeployContractTx {
   signerAddress: string
   initialFields?: Fields
-  initialAlphAmount?: string
+  initialAttoAlphAmount?: string
   initialTokenAmounts?: Token[]
   issueTokenAmount?: Number256
   gasAmount?: number
@@ -998,7 +998,7 @@ assertType<Eq<keyof BuildDeployContractTx, keyof BuildTxParams<SignDeployContrac
 export interface BuildExecuteScriptTx {
   signerAddress: string
   initialFields?: Fields
-  alphAmount?: Number256
+  attoAlphAmount?: Number256
   tokens?: Token[]
   gasAmount?: number
   gasPrice?: Number256