[xp] handle node minimal fee

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

@@ -2765,6 +2765,10 @@
                     "chain_id": {
                         "description": "Chain id",
                         "type": "number"
+                    },
+                    "minimal_fees": {
+                        "description": "Minimal fee",
+                        "type": "string"
                     }
                 },
                 "additionalProperties": false

packages/massa-web3/src/experimental/accountOperation.ts

@@ -33,8 +33,7 @@ export class AccountOperation {
     }
     const operation = new OperationManager(this.account.privateKey, this.client)
     const details: RollOperation = {
-      // Todo: change with fetchMinimalFees once ready
-      fee: opts?.fee ?? 0n,
+      fee: opts?.fee ?? (await this.client.getMinimalFee()),
       expirePeriod: await calculateExpirePeriod(
         this.client,
         opts?.periodToLive
@@ -97,8 +96,7 @@ export class AccountOperation {
 
     const operation = new OperationManager(this.account.privateKey, this.client)
     const details: TransferOperation = {
-      // Todo: change with fetchMinimalFees once ready
-      fee: opts?.fee ?? 0n,
+      fee: opts?.fee ?? (await this.client.getMinimalFee()),
       expirePeriod: await calculateExpirePeriod(
         this.client,
         opts?.periodToLive

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

@@ -26,7 +26,7 @@ export enum OperationType {
  * Period to live is the number of periods the operation is valid for.
  * This value must be positive and if it's too big, the node will (sliently?) reject the operation.
  *
- * If no fee is provided, 0 is used.
+ * If no fee is provided, minimal fee of connected node is used.
  * If no periodToLive is provided, the DefaultPeriodToLive is used.
  */
 export type OptOpDetails = {
@@ -245,8 +245,8 @@ export class OperationManager {
       throw new Error('blockchainClient is mandatory to send operations')
     }
 
-    const networkId = await this.blockchainClient.fetchChainId()
-    const signature = await this.sign(networkId, operation)
+    const chainId = await this.blockchainClient.getChainId()
+    const signature = await this.sign(chainId, operation)
     const data = OperationManager.serialize(operation)
     const publicKey = await this.privateKey.getPublicKey()
 

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

@@ -1,4 +1,4 @@
-import { fromMAS } from '@massalabs/web3-utils'
+import { toNanoMas } from '../utils'
 
 /**
  * Calculates the cost of deploying a smart contract.
@@ -12,7 +12,7 @@ export class StorageCost {
    * @returns The cost in the smallest unit of the Massa currency.
    */
   static bytes(numberOfBytes: number): bigint {
-    return BigInt(numberOfBytes) * fromMAS(0.0001)
+    return BigInt(numberOfBytes) * toNanoMas(0.0001)
   }
 
   /**
@@ -21,7 +21,7 @@ export class StorageCost {
    * @returns The cost in the smallest unit of the Massa currency.
    */
   static account(): bigint {
-    return fromMAS(0.001)
+    return toNanoMas(0.001)
   }
 
   /**

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

@@ -1,5 +1,5 @@
 import { OperationStatus } from '../basicElements'
-import { Slot } from '../generated/client'
+import { NodeStatus, Slot } from '../generated/client'
 
 export interface SendOperationInput {
   data: Uint8Array
@@ -26,9 +26,11 @@ export interface EventFilter {
  */
 export interface BlockchainClient {
   sendOperation(data: SendOperationInput): Promise<string>
-  fetchChainId(): Promise<bigint>
   fetchPeriod(): Promise<number>
   getOperationStatus(operationId: string): Promise<OperationStatus>
   getBalance(address: string, speculative?: boolean): Promise<bigint>
   getEvents(filter: EventFilter): Promise<SCOutputEvent[]>
+  getChainId(): Promise<bigint>
+  getMinimalFee(): Promise<bigint>
+  status: NodeStatus
 }

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

@@ -26,6 +26,7 @@ import {
   OperationId,
   AddressFilter,
 } from './generated/client'
+import { toNanoMas } from './utils'
 
 export enum Transport {
   webSocket = 'websocket',
@@ -236,15 +237,22 @@ export class PublicAPI {
   }
 
   async getStatus(): Promise<NodeStatus> {
-    return this.connector.get_status()
+    this.status = await this.connector.get_status()
+    return this.status
   }
 
-  async fetchChainId(): Promise<bigint> {
-    if (this.status) {
-      return BigInt(this.status.chain_id)
+  async getMinimalFee(): Promise<bigint> {
+    if (!this.status) {
+      await this.getStatus()
     }
+    return toNanoMas(this.status.minimal_fees)
+  }
 
-    return this.getStatus().then((r) => BigInt(r.chain_id))
+  async getChainId(): Promise<bigint> {
+    if (!this.status) {
+      await this.getStatus()
+    }
+    return BigInt(this.status.chain_id)
   }
 
   async fetchPeriod(): Promise<number> {

packages/massa-web3/src/experimental/smartContract.ts

@@ -56,7 +56,7 @@ export class ByteCode {
   ): Promise<Operation> {
     const operation = new OperationManager(privateKey, client)
     const details: ExecuteOperation = {
-      fee: opts?.fee ?? 0n,
+      fee: opts?.fee ?? (await client.getMinimalFee()),
       expirePeriod: await calculateExpirePeriod(client, opts?.periodToLive),
       type: OperationType.ExecuteSmartContractBytecode,
       coins: opts?.coins ?? 0n,
@@ -200,7 +200,7 @@ export class SmartContract {
       account.privateKey,
       byteCode,
       {
-        fee: opts?.fee,
+        fee: opts?.fee ?? (await client.getMinimalFee()),
         periodToLive: opts?.periodToLive,
         coins: opts?.coins,
         maxGas: opts?.maxGas,

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

@@ -0,0 +1 @@
+export * from './numbers'

packages/massa-web3/src/experimental/utils/numbers.ts

@@ -0,0 +1,16 @@
+export const MAS_DECIMALS = 9
+
+/**
+ * Convert Mas float amount to 9 decimals bigint
+ *
+ * @param amount MAS amount in floating point representation
+ * @returns amount in nanoMAS
+ */
+export const toNanoMas = (amount: string | number): bigint => {
+  if (typeof amount === 'number') {
+    amount = amount.toString()
+  }
+  let [integerPart, decimalPart] = amount.split('.')
+  decimalPart = decimalPart ?? ''
+  return BigInt(integerPart + decimalPart.padEnd(MAS_DECIMALS, '0'))
+}

packages/massa-web3/test/experimental/integration/accountOperation.spec.ts

@@ -4,17 +4,34 @@ import { OperationStatus } from '../../../src/experimental/basicElements'
 import { JsonRPCClient } from '../../../src/experimental/jsonRPCClient'
 import 'dotenv/config'
 
-describe('Basic use cases', () => {
-  test('AccountOperation - transfer', async () => {
-    const account = await Account.fromEnv()
+describe('AccountOperation tests', () => {
+  let client: JsonRPCClient
+  let account: Account
+  let accountOperation: AccountOperation
 
-    const client = new JsonRPCClient('https://buildnet.massa.net/api/v2')
+  beforeAll(async () => {
+    client = new JsonRPCClient('https://buildnet.massa.net/api/v2')
+    account = await Account.fromEnv()
+    accountOperation = new AccountOperation(account, client)
+  })
 
-    const accountOperation = new AccountOperation(account, client)
+  test('transfer', async () => {
     const transfer = await accountOperation.transfer(
       'AU1wN8rn4SkwYSTDF3dHFY4U28KtsqKL1NnEjDZhHnHEy6cEQm53',
       1n
     )
     expect(await transfer.getStatus()).toBe(OperationStatus.NotFound)
   })
+
+  test('not enough fee', async () => {
+    expect(
+      accountOperation.transfer(
+        'AU1wN8rn4SkwYSTDF3dHFY4U28KtsqKL1NnEjDZhHnHEy6cEQm53',
+        1n,
+        { fee: 1n }
+      )
+    ).rejects.toThrow(
+      'Bad request: fee is too low provided: 0.000000001 , minimal_fees required: 0.01'
+    )
+  })
 })

packages/massa-web3/test/experimental/integration/smartContract.spec.ts

@@ -3,15 +3,18 @@ import { ByteCode } from '../../../src/experimental/smartContract'
 import 'dotenv/config'
 import { JsonRPCClient } from '../../../src/experimental/jsonRPCClient'
 
-describe('Basic use cases', () => {
-  test('Smart Contract - execute', async () => {
-    const account = await Account.fromEnv()
+describe('Smart Contract', () => {
+  let client: JsonRPCClient
+  let account: Account
 
-    const client = new JsonRPCClient('https://buildnet.massa.net/api/v2')
+  beforeAll(async () => {
+    client = new JsonRPCClient('https://buildnet.massa.net/api/v2')
+    account = await Account.fromEnv()
+  })
 
+  test('execute', async () => {
     const byteCode = new Uint8Array([1, 2, 3, 4])
     const opts = {
-      fee: 1n,
       periodToLive: 2,
       coins: 3n,
       maxGas: 4n,
@@ -24,4 +27,20 @@ describe('Basic use cases', () => {
     )
     expect(await contract.getSpeculativeEvents()).toHaveLength(1)
   }, 61000)
+
+  test('not enough fee', async () => {
+    const byteCode = new Uint8Array([1, 2, 3, 4])
+    const opts = {
+      fee: 1n,
+      periodToLive: 2,
+      coins: 3n,
+      maxGas: 4n,
+    }
+
+    expect(
+      ByteCode.execute(client, account.privateKey, byteCode, opts)
+    ).rejects.toThrow(
+      'Bad request: fee is too low provided: 0.000000001 , minimal_fees required: 0.01'
+    )
+  })
 })

packages/massa-web3/test/experimental/unit/numbers.spec.ts

@@ -0,0 +1,39 @@
+import { toNanoMas } from '../../../src/experimental/utils'
+
+describe('amount format conversion tests', () => {
+  it('MAS(string) => nMAS', () => {
+    let amount = '0'
+    expect(toNanoMas(amount)).toStrictEqual(BigInt(0))
+
+    amount = '1.5234'
+    expect(toNanoMas(amount)).toStrictEqual(BigInt('1523400000'))
+
+    amount = '0.123456789'
+    expect(toNanoMas(amount)).toStrictEqual(BigInt('123456789'))
+
+    amount = '123456789'
+    expect(toNanoMas(amount)).toStrictEqual(BigInt('123456789000000000'))
+
+    amount = '123456789.123456789'
+    expect(toNanoMas(amount)).toStrictEqual(BigInt('123456789123456789'))
+  })
+
+  it('MAS(number) => nMAS', () => {
+    let amount = 0
+    expect(toNanoMas(amount)).toStrictEqual(BigInt(0))
+
+    amount = 1.5234
+    expect(toNanoMas(amount)).toStrictEqual(BigInt('1523400000'))
+
+    amount = 0.123456789
+    expect(toNanoMas(amount)).toStrictEqual(BigInt('123456789'))
+
+    amount = 123456789
+    expect(toNanoMas(amount)).toStrictEqual(BigInt('123456789000000000'))
+
+    // max safe floating point number
+    // see https://stackoverflow.com/questions/45929493/node-js-maximum-safe-floating-point-number
+    amount = 8388607.123456789
+    expect(toNanoMas(amount)).toStrictEqual(BigInt('8388607123456789'))
+  })
+})