@alephium/web3 0.2.0-rc.2 → 0.2.0-rc.21

package/dist/src/utils/utils.js

@@ -20,7 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertType = exports.timeout = exports.hexToString = exports.stringToHex = exports.subContractId = exports.contractIdFromTx = exports.addressFromContractId = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.isHexString = exports.signatureDecode = exports.signatureEncode = exports.convertHttpResponse = void 0;
+exports.assertType = exports.timeout = exports.hexToString = exports.stringToHex = exports.subContractId = exports.contractIdFromTx = exports.addressFromContractId = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.groupOfPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.isHexString = exports.xorByte = exports.signatureDecode = exports.signatureEncode = void 0;
 const elliptic_1 = require("elliptic");
 const bn_js_1 = __importDefault(require("bn.js"));
 const blakejs_1 = __importDefault(require("blakejs"));
@@ -29,15 +29,6 @@ const buffer_1 = require("buffer/");
 const constants_1 = require("../constants");
 const djb2_1 = __importDefault(require("./djb2"));
 const ec = new elliptic_1.ec('secp256k1');
-function convertHttpResponse(response) {
-    if (response.error) {
-        throw new Error(response.error.detail);
-    }
-    else {
-        return response.data;
-    }
-}
-exports.convertHttpResponse = convertHttpResponse;
 function signatureEncode(signature) {
     let sNormalized = signature.s;
     if (ec.n && signature.s.cmp(ec.nh) === 1) {
@@ -49,7 +40,7 @@ function signatureEncode(signature) {
 }
 exports.signatureEncode = signatureEncode;
 // the signature should be in hex string format for 64 bytes
-const signatureDecode = (ec, signature) => {
+function signatureDecode(ec, signature) {
     if (signature.length !== 128) {
         throw new Error('Invalid signature length');
     }
@@ -62,15 +53,16 @@ const signatureDecode = (ec, signature) => {
     else {
         throw new Error('The signature is not normalized');
     }
-};
+}
 exports.signatureDecode = signatureDecode;
-const xorByte = (intValue) => {
+function xorByte(intValue) {
     const byte0 = (intValue >> 24) & 0xff;
     const byte1 = (intValue >> 16) & 0xff;
     const byte2 = (intValue >> 8) & 0xff;
     const byte3 = intValue & 0xff;
     return (byte0 ^ byte1 ^ byte2 ^ byte3) & 0xff;
-};
+}
+exports.xorByte = xorByte;
 function isHexString(input) {
     return input.length % 2 === 0 && /[0-9a-f]*$/.test(input);
 }
@@ -82,7 +74,7 @@ var AddressType;
     AddressType[AddressType["P2SH"] = 2] = "P2SH";
     AddressType[AddressType["P2C"] = 3] = "P2C";
 })(AddressType || (AddressType = {}));
-const groupOfAddress = (address) => {
+function groupOfAddress(address) {
     const decoded = bs58_1.default.decode(address);
     if (decoded.length == 0)
         throw new Error('Address string is empty');
@@ -100,32 +92,32 @@ const groupOfAddress = (address) => {
     else {
         throw new Error(`Invalid asset address type: ${addressType}`);
     }
-};
+}
 exports.groupOfAddress = groupOfAddress;
-const groupOfAddressBytes = (bytes) => {
+function groupOfAddressBytes(bytes) {
     const hint = (0, djb2_1.default)(bytes) | 1;
     const hash = xorByte(hint);
     const group = hash % constants_1.TOTAL_NUMBER_OF_GROUPS;
     return group;
-};
+}
 // Pay to public key hash address
-const groupOfP2pkhAddress = (address) => {
+function groupOfP2pkhAddress(address) {
     if (address.length != 32) {
         throw new Error(`Invalid p2pkh address length: ${address.length}`);
     }
     return groupOfAddressBytes(address);
-};
+}
 // Pay to multiple public key hash address
-const groupOfP2mpkhAddress = (address) => {
+function groupOfP2mpkhAddress(address) {
     if ((address.length - 2) % 32 != 0) {
         throw new Error(`Invalid p2mpkh address length: ${address.length}`);
     }
     return groupOfAddressBytes(address.slice(1, 33));
-};
+}
 // Pay to script hash address
-const groupOfP2shAddress = (address) => {
+function groupOfP2shAddress(address) {
     return groupOfAddressBytes(address);
-};
+}
 function contractIdFromAddress(address) {
     return idFromAddress(address);
 }
@@ -155,6 +147,10 @@ function binToHex(bin) {
     return buffer_1.Buffer.from(bin).toString('hex');
 }
 exports.binToHex = binToHex;
+function groupOfPrivateKey(privateKey) {
+    return groupOfAddress(addressFromPublicKey(publicKeyFromPrivateKey(privateKey)));
+}
+exports.groupOfPrivateKey = groupOfPrivateKey;
 function publicKeyFromPrivateKey(privateKey) {
     const key = ec.keyFromPrivate(privateKey);
     return key.getPublic(true, 'hex');
@@ -195,7 +191,7 @@ function stringToHex(str) {
 }
 exports.stringToHex = stringToHex;
 function hexToString(str) {
-    return buffer_1.Buffer.from(str.toString(), 'hex').toString();
+    return buffer_1.Buffer.from(str, 'hex').toString();
 }
 exports.hexToString = hexToString;
 function timeout(ms) {

package/jest-config.json

@@ -0,0 +1,11 @@
+{
+  "testPathIgnorePatterns": [".*/node_modules/"],
+  "transform": {
+    "^.+\\.(t|j)sx?$": "ts-jest"
+  },
+  "testMatch": ["**/*.test.ts"],
+  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
+  "collectCoverage": true,
+  "coverageDirectory": "./coverage/",
+  "collectCoverageFrom": ["src/**/*.ts"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.2.0-rc.2",
+  "version": "0.2.0-rc.21",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -27,52 +27,28 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "1.5.0-rc2",
-    "explorer_backend_version": "1.7.1"
+    "alephium_version": "1.5.0-rc10",
+    "explorer_backend_version": "1.9.0-rc0"
   },
   "scripts": {
     "build": "rm -rf dist/* && npx tsc --build . && webpack",
-    "bundle": "webpack",
+    "test": "jest -i --config ./jest-config.json",
     "update-schemas": "npm run update-schema:alephium && npm run update-schema:explorer",
-    "update-schema:alephium": "npx swagger-typescript-api -t ./configs -o ./src/api -n api-alephium.ts -p https://raw.githubusercontent.com/alephium/alephium/v${npm_package_config_alephium_version}/api/src/main/resources/openapi.json",
-    "update-schema:explorer": "npx swagger-typescript-api -t ./configs -o ./src/api -n api-explorer.ts -p https://raw.githubusercontent.com/alephium/explorer-backend/v${npm_package_config_explorer_backend_version}/app/src/main/resources/explorer-backend-openapi.json",
-    "check-versions": "node scripts/check-versions.js ${npm_package_config_alephium_version} ${npm_package_config_explorer_backend_version}",
-    "dev": "tsnd --respawn lib/index.ts",
-    "lint": "eslint . --ext ts",
-    "lint:fix": "eslint . --fix --ext ts",
-    "test": "jest -i --config ./configs/jest.config.ts",
-    "test:client": "jest -i --config ./configs/jest-client.config.ts",
-    "test:unit": "jest -i --config ./configs/jest-unit.config.ts",
-    "test:watch": "npm run test -- --watch --coverage=false",
-    "test:watch:unit": "npm run test:unit -- --watch --coverage=false",
-    "test:watch:client": "npm run test:client -- --watch --coverage=false",
-    "prepublishOnly": "npm run build",
-    "prepack": "node scripts/rename-gitignore.js .gitignore gitignore",
-    "postpack": "node scripts/rename-gitignore.js gitignore .gitignore",
-    "prettier": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
-    "start-devnet": "node scripts/start-devnet.js ${npm_package_config_alephium_version}",
-    "restart-devnet": "npm run start-devnet",
-    "stop-devnet": "node scripts/stop-devnet.js"
+    "update-schema:alephium": "npx swagger-typescript-api --disable-throw-on-error -t ./configs -o ./src/api -n api-alephium.ts -p https://raw.githubusercontent.com/alephium/alephium/v${npm_package_config_alephium_version}/api/src/main/resources/openapi.json",
+    "update-schema:explorer": "npx swagger-typescript-api --disable-throw-on-error -t ./configs -o ./src/api -n api-explorer.ts -p https://raw.githubusercontent.com/alephium/explorer-backend/v${npm_package_config_explorer_backend_version}/app/src/main/resources/explorer-backend-openapi.json",
+    "check-versions": "node scripts/check-versions.js ${npm_package_config_alephium_version} ${npm_package_config_explorer_backend_version}"
   },
   "type": "commonjs",
-  "bin": {
-    "alephium": "dist/scripts/create-project.js"
-  },
   "dependencies": {
     "base-x": "4.0.0",
     "blakejs": "1.2.1",
     "buffer": "^6.0.3",
-    "commander": "^9.1.0",
     "cross-fetch": "^3.1.5",
-    "crypto-js": "4.1.1",
     "elliptic": "6.5.4",
-    "eventemitter3": "^4.0.7",
-    "find-up": "^2.1.0",
-    "fs-extra": "^10.0.1"
+    "eventemitter3": "^4.0.7"
   },
   "devDependencies": {
-    "@types/crypto-js": "^4.1.1",
-    "@types/elliptic": "^6.4.13",
+    "@babel/eslint-parser": "^7.18.9",
     "@types/find-up": "^2.1.0",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.5.1",
@@ -81,14 +57,12 @@
     "@types/rewire": "^2.5.28",
     "@typescript-eslint/eslint-plugin": "^4.30.0",
     "@typescript-eslint/parser": "^4.30.0",
-    "babel-eslint": "^10.1.0",
     "clean-webpack-plugin": "4.0.0",
     "crypto-browserify": "^3.12.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-react": "^7.29.4",
     "eslint-plugin-security": "1.4.0",
     "html-webpack-plugin": "5.5.0",
     "jest": "^28.1.0",
@@ -98,7 +72,6 @@
     "mock-socket": "^9.0.8",
     "prettier": "^2.3.2",
     "process": "^0.11.10",
-    "react-app-rewired": "^2.2.1",
     "rewire": "^6.0.0",
     "shelljs": "^0.8.5",
     "stream-browserify": "^3.0.0",
@@ -107,21 +80,12 @@
     "ts-jest": "^28.0.2",
     "ts-node": "^10.7.0",
     "tslib": "^2.3.1",
-    "typescript": "^4.4.2",
+    "typescript": "4.7.4",
     "webpack": "^5.72.0",
     "webpack-cli": "^4.9.2"
   },
   "engines": {
-    "node": ">=14.0.0",
+    "node": ">=16.0.0",
     "npm": ">=7.0.0"
-  },
-  "prettier": {
-    "printWidth": 120,
-    "tabWidth": 2,
-    "useTabs": false,
-    "semi": false,
-    "singleQuote": true,
-    "bracketSameLine": false,
-    "trailingComma": "none"
   }
 }

package/src/api/api-alephium.ts

@@ -124,6 +124,11 @@ export interface Banned {
   type: string
 }
 
+export interface BlockAndEvents {
+  block: BlockEntry
+  events: ContractEventByBlockHash[]
+}
+
 export interface BlockEntry {
   /** @format block-hash */
   hash: string
@@ -174,6 +179,14 @@ export interface BlockHeaderEntry {
   deps: string[]
 }
 
+export interface BlocksAndEventsPerTimeStampRange {
+  blocksAndEvents: BlockAndEvents[][]
+}
+
+export interface BlocksPerTimeStampRange {
+  blocks: BlockEntry[][]
+}
+
 export interface BrokerInfo {
   /** @format clique-id */
   cliqueId: string
@@ -422,19 +435,42 @@ export interface ChangeActiveAddress {
 }
 
 export interface CompileContractResult {
+  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 {
+  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 {
@@ -457,6 +493,7 @@ export interface Confirmed {
 
 export interface Contract {
   code: string
+  compilerOptions?: CompilerOptions
 }
 
 export interface ContractEvent {
@@ -471,6 +508,18 @@ export interface ContractEvent {
   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
@@ -490,11 +539,12 @@ export interface ContractEvents {
   nextStart: number
 }
 
+export interface ContractEventsByBlockHash {
+  events: ContractEventByBlockHash[]
+}
+
 export interface ContractEventsByTxId {
   events: ContractEventByTxId[]
-
-  /** @format int32 */
-  nextStart: number
 }
 
 export interface ContractOutput {
@@ -529,6 +579,12 @@ export interface ContractState {
   asset: AssetState
 }
 
+export interface DebugMessage {
+  /** @format address */
+  contractAddress: string
+  message: string
+}
+
 export interface DecodeUnsignedTx {
   unsignedTx: string
 }
@@ -561,19 +617,14 @@ export 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 {
@@ -599,9 +650,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[]
 }
 
@@ -703,6 +757,11 @@ export interface Penalty {
   type: string
 }
 
+export interface Project {
+  code: string
+  compilerOptions?: CompilerOptions
+}
+
 export interface Reachable {
   peers: string[]
   type: string
@@ -729,6 +788,7 @@ export interface RevealMnemonicResult {
 
 export interface Script {
   code: string
+  compilerOptions?: CompilerOptions
 }
 
 export interface SelfClique {
@@ -846,6 +906,7 @@ export interface TestContractResult {
   txInputs: string[]
   txOutputs: Output[]
   events: ContractEventByTxId[]
+  debugMessages: DebugMessage[]
 }
 
 export interface TestInputAsset {
@@ -1058,16 +1119,7 @@ export interface WalletUnlock {
 }
 
 import 'cross-fetch/polyfill'
-
-function convertHttpResponse<T>(
-  response: HttpResponse<T, { detail: string }> | HttpResponse<T, { detail: string }>
-): T {
-  if (response.error) {
-    throw new Error(response.error.detail)
-  } else {
-    return response.data
-  }
-}
+import { convertHttpResponse } from './utils'
 
 export type QueryParamsType = Record<string | number, any>
 export type ResponseFormat = keyof Omit<Body, 'body' | 'bodyUsed'>
@@ -1271,7 +1323,6 @@ export class HttpClient<SecurityDataType = unknown> {
         this.abortControllers.delete(cancelToken)
       }
 
-      if (!response.ok) throw data
       return data
     })
   }
@@ -1830,13 +1881,36 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * No description
      *
      * @tags Blockflow
-     * @name GetBlockflow
+     * @name GetBlockflowBlocks
      * @summary List blocks on the given time interval
-     * @request GET:/blockflow
+     * @request GET:/blockflow/blocks
+     */
+    getBlockflowBlocks: (query: { fromTs: number; toTs?: number }, params: RequestParams = {}) =>
+      this.request<
+        BlocksPerTimeStampRange,
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/blockflow/blocks`,
+        method: 'GET',
+        query: query,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * No description
+     *
+     * @tags Blockflow
+     * @name GetBlockflowBlocksWithEvents
+     * @summary List blocks with events on the given time interval
+     * @request GET:/blockflow/blocks-with-events
      */
-    getBlockflow: (query: { fromTs: number; toTs?: number }, params: RequestParams = {}) =>
-      this.request<FetchResponse, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
-        path: `/blockflow`,
+    getBlockflowBlocksWithEvents: (query: { fromTs: number; toTs?: number }, params: RequestParams = {}) =>
+      this.request<
+        BlocksAndEventsPerTimeStampRange,
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/blockflow/blocks-with-events`,
         method: 'GET',
         query: query,
         format: 'json',
@@ -1859,6 +1933,22 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params
       }).then(convertHttpResponse),
 
+    /**
+     * 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 = {}) =>
+      this.request<BlockAndEvents, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/blockflow/blocks-with-events/${blockHash}`,
+        method: 'GET',
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
     /**
      * No description
      *
@@ -2160,6 +2250,27 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params
       }).then(convertHttpResponse),
 
+    /**
+     * No description
+     *
+     * @tags Contracts
+     * @name PostContractsCompileProject
+     * @summary Compile a project
+     * @request POST:/contracts/compile-project
+     */
+    postContractsCompileProject: (data: Project, params: RequestParams = {}) =>
+      this.request<
+        CompileProjectResult,
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/contracts/compile-project`,
+        method: 'POST',
+        body: data,
+        type: ContentType.Json,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
     /**
      * No description
      *
@@ -2351,6 +2462,23 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params
       }).then(convertHttpResponse),
 
+    /**
+     * 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 = {}) =>
+      this.request<boolean, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/miners/cpu-mining/mine-one-block`,
+        method: 'POST',
+        query: query,
+        format: 'json',
+        ...params
+      }).then(convertHttpResponse),
+
     /**
      * No description
      *
@@ -2395,7 +2523,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      */
     getEventsContractContractaddress: (
       contractAddress: string,
-      query: { start: number; end?: number; group?: number },
+      query: { start: number; limit?: number; group?: number },
       params: RequestParams = {}
     ) =>
       this.request<ContractEvents, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
@@ -2427,7 +2555,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      *
      * @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 }, params: RequestParams = {}) =>
@@ -2440,6 +2568,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         query: query,
         format: 'json',
         ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * 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 = {}) =>
+      this.request<
+        ContractEventsByBlockHash,
+        BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable
+      >({
+        path: `/events/block-hash/${blockHash}`,
+        method: 'GET',
+        query: query,
+        format: 'json',
+        ...params
       }).then(convertHttpResponse)
   }
 }