Read only call

.eslintignore

@@ -13,6 +13,7 @@ packages/massa-web3/src/web3
 packages/massa-web3/src/index.ts
 packages/massa-web3/test
 
+**/open_rpc/**
 **/generated/**
 **/dist/**
 **/docs/**

package.json

@@ -51,6 +51,7 @@
   "dependencies": {
     "@types/pbkdf2": "^3.1.2",
     "big-varint": "^0.1.3",
+    "decimal.js": "^10.4.3",
     "pbkdf2": "^3.1.2"
   }
 }

packages/massa-web3/open_rpc/massa.api.json

@@ -3114,7 +3114,7 @@
                                 "type": "null"
                             },
                             {
-                                "type": "number"
+                                "type": "string"
                             }
                         ]
                     },
@@ -3125,7 +3125,7 @@
                                 "type": "null"
                             },
                             {
-                                "type": "number"
+                                "type": "string"
                             }
                         ]
                     }

packages/massa-web3/src/experimental/basicElements/index.ts

@@ -5,5 +5,6 @@ export * from './operationManager'
 export * from './operation'
 export * from './storage'
 export * from './args'
+export * from './serializers'
 export * as Mas from './mas'
 export * from './serializers'

packages/massa-web3/src/experimental/basicElements/mas.ts

@@ -1,7 +1,9 @@
+import Decimal from 'decimal.js'
 import { FIRST, ONE } from '../utils'
 import { U64, fromNumber } from './serializers/number/u64'
 
-const NB_DECIMALS = 9
+export const NB_DECIMALS = 9
+export const SIZE_U256_BIT = 256
 const POWER_TEN = 10
 
 export const ERROR_NOT_SAFE_INTEGER = 'value is not a safe integer.'
@@ -98,16 +100,26 @@
 
   return fromNumber(mas)
 }
-
 /**
- * Converts a value in the smallest unit of the Massa currency to a decimal value.
+ * Converts a Mas value to a string with rounding approximation.
+ *
+ * @param value - The Mas value.
+ * @param decimalPlaces - The number of decimal places to include in the string.
+ * @returns The value as a string.
  *
- * @param value - The value in the smallest unit of the Massa currency.
- * @returns The decimal value.
+ * @throws An error if the value is too large to be represented by a U256.
  */
-export function toString(value: Mas): string {
-  const valueString = value.toString()
-  const integerPart = valueString.slice(FIRST, -NB_DECIMALS) || '0'
-  const decimalPart = valueString.slice(-NB_DECIMALS).replace(/0+$/, '')
-  return `${integerPart}${decimalPart.length ? '.' + decimalPart : ''}`
+export function toString(
+  value: Mas,
+  decimalPlaces: number | null = null
+): string {
+  if (BigInt(value) >= BigInt(ONE) << BigInt(SIZE_U256_BIT)) {
+    throw new Error(ERROR_VALUE_TOO_LARGE)
+  }
+
+  const scaledValue = new Decimal(value.toString()).div(`1e+${NB_DECIMALS}`)
+
+  return decimalPlaces !== null
+    ? scaledValue.toFixed(decimalPlaces, Decimal.ROUND_HALF_UP)
+    : scaledValue.toString()
 }

packages/massa-web3/src/experimental/basicElements/operationManager.ts

@@ -101,7 +101,6 @@ export class OperationManager {
    * @returns A byte array representing the serialized operation.
    */
   static serialize(operation: OperationDetails): Uint8Array {
-    // TODO: check that unsigned.encode is equivalent to varint.encode
     const components = [
       unsigned.encode(operation.fee),
       varint.encode(operation.expirePeriod),

packages/massa-web3/src/experimental/client/interfaces.ts

@@ -1,4 +1,4 @@
-import { OperationStatus } from '../basicElements'
+import { Address, OperationStatus } from '../basicElements'
 import { Mas } from '../basicElements/mas'
 import { U64 } from '../basicElements/serializers/number/u64'
 import { NodeStatus, Slot } from '../generated/client'
@@ -23,6 +23,33 @@ export type EventFilter = {
   isError?: boolean
 }
 
+export type ReadOnlyCallParams = {
+  func: string
+  target: Address
+  caller: Address
+  parameter?: Uint8Array
+  coins?: Mas
+  fee?: Mas
+  maxGas?: U64
+}
+
+export type ReadOnlyCallResult = {
+  value: Uint8Array
+  info: {
+    gasCost: number
+    error?: string
+    events: SCOutputEvent[]
+    stateChanges: {
+      ledgerChanges: Record<string, unknown>
+      asyncPoolChanges: Record<string, unknown>[]
+      posChanges: Record<string, unknown>
+      executedOpsChanges: Record<string, unknown>
+      executedDenunciationsChanges: Record<string, unknown>
+      executionTrailHashChange: string
+    }
+  }
+}
+
 /*
  * Blockchain client functions needed by the Operation class to send operations to the blockchain.
  */
@@ -35,6 +62,7 @@ export interface BlockchainClient {
   getEvents(filter: EventFilter): Promise<SCOutputEvent[]>
   getChainId(): Promise<U64>
   getMinimalFee(): Promise<Mas>
+  executeReadOnlyCall(params: ReadOnlyCallParams): Promise<ReadOnlyCallResult>
   // TODO: change for a getter instead
   status: NodeStatus
 }

packages/massa-web3/src/experimental/client/publicAPI.ts

@@ -1,5 +1,10 @@
 import { Mas, OperationStatus } from '../basicElements'
-import { SendOperationInput, EventFilter as EvtFilter } from '.'
+import {
+  SendOperationInput,
+  EventFilter as EvtFilter,
+  ReadOnlyCallParams,
+  ReadOnlyCallResult,
+} from '.'
 import {
   OperationInput,
   Pagination,
@@ -40,6 +45,7 @@ type JSONAPIOptions = {
   path?: string
   protocol?: string
 }
+
 export class PublicAPI {
   connector: MassaOpenRPCSpecification
   status: NodeStatus
@@ -78,11 +84,42 @@ export class PublicAPI {
   }
 
   async executeReadOnlyCall(
-    readOnlyCall: ReadOnlyCall
-  ): Promise<ExecuteReadOnlyResponse> {
-    return this.connector
-      .execute_read_only_call([readOnlyCall])
-      .then((r) => r[FIRST])
+    params: ReadOnlyCallParams
+  ): Promise<ReadOnlyCallResult> {
+    const [res] = await this.connector.execute_read_only_call([
+      {
+        max_gas: Number(params.maxGas),
+        target_address: params.target.toString(),
+        target_function: params.func,
+        parameter: params.parameter ? Array.from(params.parameter) : [],
+        caller_address: params.caller.toString(),
+        coins: params.coins ? Mas.toString(params.coins) : null,
+        fee: params.fee ? Mas.toString(params.fee) : null,
+      },
+    ])
+
+    if (!res) {
+      throw new Error('No result returned from execute_read_only_call')
+    }
+
+    return {
+      value: (res.result.Ok as unknown as Uint8Array) ?? null,
+      info: {
+        gasCost: res.gas_cost,
+        error: res.result.Error,
+        events: res.output_events,
+        stateChanges: {
+          ledgerChanges: res.state_changes.ledger_changes,
+          asyncPoolChanges: res.state_changes.async_pool_changes,
+          posChanges: res.state_changes.pos_changes,
+          executedOpsChanges: res.state_changes.executed_ops_changes,
+          executedDenunciationsChanges:
+            res.state_changes.executed_denunciations_changes,
+          executionTrailHashChange:
+            res.state_changes.execution_trail_hash_change,
+        },
+      },
+    }
   }
 
   async executeMultipleReadOnlyCall(