@alephium/web3 0.1.0 → 0.2.0-rc.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.1.0",
+  "version": "0.2.0-rc.10",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -27,29 +27,16 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "1.4.2",
-    "explorer_backend_version": "1.7.0"
+    "alephium_version": "1.5.0-rc7",
+    "explorer_backend_version": "1.7.1"
   },
   "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"
@@ -64,15 +51,12 @@
     "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"
   },
   "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 +65,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 +80,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 +88,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/scripts/create-project.ts

@@ -73,7 +73,7 @@ function prepareShared(packageRoot: string, projectRoot: string) {
   console.log('...')
 
   fsExtra.copySync(path.join(packageRoot, 'templates/shared'), projectRoot)
-  copy('', ['.editorconfig', '.eslintignore', '.gitattributes', 'LICENSE'])
+  copy('', ['.editorconfig', '.eslintignore', '.gitattributes'])
   copy('dev', ['user.conf'])
   copy('scripts', ['start-devnet.js', 'stop-devnet.js'])
   if (fsExtra.existsSync(path.join(packageRoot, 'gitignore'))) {
@@ -87,7 +87,8 @@ function prepareShared(packageRoot: string, projectRoot: string) {
 
 function prepareBase(packageRoot: string, projectRoot: string) {
   prepareShared(packageRoot, projectRoot)
-  copy('contracts', ['greeter.ral', 'greeter_interface.ral', 'greeter_main.ral'])
+  copy('contracts', ['greeter_main.ral'])
+  copy('contracts/greeter', ['greeter.ral', 'greeter_interface.ral'])
   fsExtra.copySync(path.join(packageRoot, 'templates/base'), projectRoot)
 }
 

package/src/api/api-alephium.ts

@@ -96,6 +96,8 @@ export interface Balance {
 
   /** @format x.x ALPH */
   lockedBalanceHint: string
+  tokenBalances?: Token[]
+  lockedTokenBalances?: Token[]
 
   /** @format int32 */
   utxoNum: number
@@ -205,6 +207,9 @@ export interface BuildDeployContractTx {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format block-hash */
+  targetBlockHash?: string
 }
 
 export interface BuildDeployContractTxResult {
@@ -244,6 +249,9 @@ export interface BuildExecuteScriptTx {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format block-hash */
+  targetBlockHash?: string
 }
 
 export interface BuildExecuteScriptTxResult {
@@ -309,6 +317,9 @@ export interface BuildSweepAddressTransactions {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format block-hash */
+  targetBlockHash?: string
 }
 
 export interface BuildSweepAddressTransactionsResult {
@@ -332,6 +343,9 @@ export interface BuildTransaction {
 
   /** @format uint256 */
   gasPrice?: string
+
+  /** @format block-hash */
+  targetBlockHash?: string
 }
 
 export interface BuildTransactionResult {
@@ -408,6 +422,7 @@ export interface ChangeActiveAddress {
 }
 
 export interface CompileContractResult {
+  name: string
   bytecode: string
 
   /** @format 32-byte-hash */
@@ -415,12 +430,29 @@ export interface CompileContractResult {
   fields: FieldsSig
   functions: FunctionSig[]
   events: EventSig[]
+  warnings: string[]
+}
+
+export interface CompileProjectResult {
+  contracts: CompileContractResult[]
+  scripts: CompileScriptResult[]
 }
 
 export interface CompileScriptResult {
+  name: string
   bytecodeTemplate: 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 {
@@ -443,6 +475,7 @@ export interface Confirmed {
 
 export interface Contract {
   code: string
+  compilerOptions?: CompilerOptions
 }
 
 export interface ContractEvent {
@@ -547,7 +580,6 @@ export type DiscoveryAction = Reachable | Unreachable
 
 export interface EventSig {
   name: string
-  signature: string
   fieldNames: string[]
   fieldTypes: string[]
 }
@@ -557,9 +589,9 @@ export interface FetchResponse {
 }
 
 export interface FieldsSig {
-  signature: string
   names: string[]
   types: string[]
+  isMutable: boolean[]
 }
 
 export interface FixedAssetOutput {
@@ -585,9 +617,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[]
 }
 
@@ -689,6 +724,11 @@ export interface Penalty {
   type: string
 }
 
+export interface Project {
+  code: string
+  compilerOptions?: CompilerOptions
+}
+
 export interface Reachable {
   peers: string[]
   type: string
@@ -715,6 +755,7 @@ export interface RevealMnemonicResult {
 
 export interface Script {
   code: string
+  compilerOptions?: CompilerOptions
 }
 
 export interface SelfClique {
@@ -776,6 +817,9 @@ export interface Sweep {
 
   /** @format int32 */
   utxosLimit?: number
+
+  /** @format block-hash */
+  targetBlockHash?: string
 }
 
 export interface SweepAddressTransaction {
@@ -1097,7 +1141,7 @@ export enum ContentType {
 }
 
 export class HttpClient<SecurityDataType = unknown> {
-  public baseUrl: string = '{protocol}://{host}:{port}'
+  public baseUrl: string = '../'
   private securityData: SecurityDataType | null = null
   private securityWorker?: ApiConfig<SecurityDataType>['securityWorker']
   private abortControllers = new Map<CancelToken, AbortController>()
@@ -1262,8 +1306,8 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Alephium API
- * @version 1.4.2
- * @baseUrl {protocol}://{host}:{port}
+ * @version 1.5.0
+ * @baseUrl ../
  */
 export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
   wallets = {
@@ -2143,6 +2187,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
      *

package/src/api/api-explorer.ts

@@ -847,6 +847,36 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         path: `/utils/sanity-check`,
         method: 'PUT',
         ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * @description Update global log level, accepted: TRACE, DEBUG, INFO, WARN, ERROR
+     *
+     * @tags Utils
+     * @name PutUtilsUpdateGlobalLoglevel
+     * @request PUT:/utils/update-global-loglevel
+     */
+    putUtilsUpdateGlobalLoglevel: (data: 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR', params: RequestParams = {}) =>
+      this.request<void, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/utils/update-global-loglevel`,
+        method: 'PUT',
+        body: data,
+        ...params
+      }).then(convertHttpResponse),
+
+    /**
+     * @description Update logging file, only logback.xml is accepted
+     *
+     * @tags Utils
+     * @name PutUtilsUpdateLogConfig
+     * @request PUT:/utils/update-log-config
+     */
+    putUtilsUpdateLogConfig: (data: string, params: RequestParams = {}) =>
+      this.request<void, BadRequest | Unauthorized | NotFound | InternalServerError | ServiceUnavailable>({
+        path: `/utils/update-log-config`,
+        method: 'PUT',
+        body: data,
+        ...params
       }).then(convertHttpResponse)
   }
 }

package/src/api/index.ts

@@ -19,9 +19,19 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 import { Api as NodeApi } from './api-alephium'
 import { Api as ExplorerApi } from './api-explorer'
 
-export class NodeProvider extends NodeApi<null> {
-  constructor(baseUrl: string) {
-    super({ baseUrl: baseUrl })
+export class NodeProvider extends NodeApi<string> {
+  constructor(baseUrl: string, apiKey?: string) {
+    // eslint-disable-next-line security/detect-possible-timing-attacks
+    if (apiKey === undefined) {
+      super({ baseUrl: baseUrl })
+    } else {
+      super({
+        baseUrl: baseUrl,
+        baseApiParams: { secure: true },
+        securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {})
+      })
+      this.setSecurityData(apiKey)
+    }
   }
 }