feat: new SignedData and method argument parser

.github/workflows/integration-test.yml

@@ -5,13 +5,17 @@ on:
       - master
       - release
       - release-candidate
+      - feat/nc-args-serialization
+      - feat/nc-args-class
     tags:
       - v*
   pull_request:
     branches:
       - release
       - release-candidate
       - master
+      - feat/nc-args-serialization
+      - feat/nc-args-class
 
 env:
   TEST_WALLET_START_TIMEOUT: '180000' # 3 minutes

.github/workflows/lint.yml

@@ -5,13 +5,17 @@ on:
     - master
     - release
     - release-candidate
+    - feat/nc-args-serialization
+    - feat/nc-args-class
     tags:
     - v*
   pull_request:
     branches:
     - release
     - release-candidate
     - master
+    - feat/nc-args-serialization
+    - feat/nc-args-class
 jobs:
   linter:
     runs-on: 'ubuntu-latest'

.github/workflows/unit-test.yml

@@ -5,13 +5,17 @@ on:
     - master
     - release
     - release-candidate
+    - feat/nc-args-serialization
+    - feat/nc-args-class
     tags:
     - v*
   pull_request:
     branches:
     - release
     - release-candidate
     - master
+    - feat/nc-args-serialization
+    - feat/nc-args-class
 jobs:
   test:
     runs-on: 'ubuntu-latest'

__tests__/integration/configuration/docker-compose.yml

@@ -17,6 +17,7 @@ services:
       "--unsafe-mode", "nano-testnet-alpha",
       "--data", "./tmp",
       "--nc-indices",
+      "--nc-exec-logs", "all",
     ]
     environment:
       HATHOR_CONFIG_YAML: privnet/conf/privnet.yml

__tests__/integration/nanocontracts/bet.test.ts

@@ -29,6 +29,7 @@ import {
 } from '../../../src/errors';
 import { OutputType } from '../../../src/wallet/types';
 import NanoContractTransactionParser from '../../../src/nano_contracts/parser';
+import { NanoContractSignedData } from '../../../src/nano_contracts/types';
 
 let fundsTx;
 const builtInBlueprintId = '3cb032600bdf7db784800e4ea911b10676fa2f67591f82bb62628c234e771595';
@@ -94,6 +95,7 @@ describe('full cycle of bet nano contract', () => {
 
     // Create NC
     const oracleData = getOracleBuffer(address1, network);
+    console.debug('Call to initialize');
     const tx1 = await wallet.createAndSendNanoContractTransaction(
       NANO_CONTRACTS_INITIALIZE_METHOD,
       address0,
@@ -120,11 +122,25 @@ describe('full cycle of bet nano contract', () => {
     tx1Parser.parseAddress();
     await tx1Parser.parseArguments();
     expect(tx1Parser.address?.base58).toBe(address0);
-    expect(tx1Parser.parsedArgs).toStrictEqual([
-      { name: 'oracle_script', type: 'TxOutputScript', parsed: oracleData },
-      { name: 'token_uid', type: 'TokenUid', parsed: Buffer.from(NATIVE_TOKEN_UID, 'hex') },
-      { name: 'date_last_bet', type: 'Timestamp', parsed: dateLastBet },
-    ]);
+    expect(tx1Parser.parsedArgs).not.toBeNull();
+    if (tx1Parser.parsedArgs === null) {
+      throw new Error('Could not parse args');
+    }
+    expect(tx1Parser.parsedArgs).toHaveLength(3);
+    expect(tx1Parser.parsedArgs[0]).toMatchObject({
+      name: 'oracle_script',
+      type: 'TxOutputScript',
+    });
+    // @ts-expect-error toMatchBuffer is defined in setupTests.js
+    expect(tx1Parser.parsedArgs[0].value).toMatchBuffer(oracleData);
+    expect(tx1Parser.parsedArgs[1]).toMatchObject({ name: 'token_uid', type: 'TokenUid' });
+    // @ts-expect-error toMatchBuffer is defined in setupTests.js
+    expect(tx1Parser.parsedArgs[1].value).toMatchBuffer(Buffer.from(NATIVE_TOKEN_UID, 'hex'));
+    expect(tx1Parser.parsedArgs[2]).toMatchObject({
+      name: 'date_last_bet',
+      type: 'Timestamp',
+      value: dateLastBet,
+    });
 
     // First validate some bet arguments error handling
     const address2 = await wallet.getAddressAtIndex(2);
@@ -162,6 +178,7 @@ describe('full cycle of bet nano contract', () => {
     ).rejects.toThrow(NanoContractTransactionError);
 
     // Bet 100 to address 2
+    console.debug('First call to bet');
     const txBet = await wallet.createAndSendNanoContractTransaction('bet', address2, {
       ncId: tx1.hash,
       args: [address2, '1x0'],
@@ -196,10 +213,17 @@ describe('full cycle of bet nano contract', () => {
     txBetParser.parseAddress();
     await txBetParser.parseArguments();
     expect(txBetParser.address?.base58).toBe(address2);
-    expect(txBetParser.parsedArgs).toStrictEqual([
-      { name: 'address', type: 'Address', parsed: address2 },
-      { name: 'score', type: 'str', parsed: '1x0' },
-    ]);
+    expect(txBetParser.parsedArgs).not.toBeNull();
+    if (txBetParser.parsedArgs === null) {
+      throw new Error('Could not parse args');
+    }
+    expect(txBetParser.parsedArgs).toHaveLength(2);
+    expect(txBetParser.parsedArgs[0]).toMatchObject({
+      name: 'address',
+      type: 'Address',
+      value: address2,
+    });
+    expect(txBetParser.parsedArgs[1]).toMatchObject({ name: 'score', type: 'str', value: '1x0' });
 
     const utxos2 = await wallet.getUtxos();
     // We must have one utxo in the address 0 of 900 HTR
@@ -210,6 +234,7 @@ describe('full cycle of bet nano contract', () => {
 
     // Bet 200 to address 3
     const address3 = await wallet.getAddressAtIndex(3);
+    console.debug('Second call to bet');
     const txBet2 = await wallet.createAndSendNanoContractTransaction('bet', address3, {
       ncId: tx1.hash,
       args: [address3, '2x0'],
@@ -244,10 +269,17 @@ describe('full cycle of bet nano contract', () => {
     txBet2Parser.parseAddress();
     await txBet2Parser.parseArguments();
     expect(txBet2Parser.address?.base58).toBe(address3);
-    expect(txBet2Parser.parsedArgs).toStrictEqual([
-      { name: 'address', type: 'Address', parsed: address3 },
-      { name: 'score', type: 'str', parsed: '2x0' },
-    ]);
+    expect(txBet2Parser.parsedArgs).not.toBeNull();
+    if (txBet2Parser.parsedArgs === null) {
+      throw new Error('Could not parse args');
+    }
+    expect(txBet2Parser.parsedArgs).toHaveLength(2);
+    expect(txBet2Parser.parsedArgs[0]).toMatchObject({
+      name: 'address',
+      type: 'Address',
+      value: address3,
+    });
+    expect(txBet2Parser.parsedArgs[1]).toMatchObject({ name: 'score', type: 'str', value: '2x0' });
 
     // Get nc history
     const txIds = [tx1.hash, txBet.hash, txBet2.hash];
@@ -295,7 +327,8 @@ describe('full cycle of bet nano contract', () => {
     const nanoSerializer = new Serializer(network);
     const result = '1x0';
     const resultSerialized = nanoSerializer.serializeFromType(result, 'str');
-    const inputData = await getOracleInputData(oracleData, resultSerialized, wallet);
+    const inputData = await getOracleInputData(oracleData, tx1.hash, resultSerialized, wallet);
+    console.debug('Call to set_result');
     const txSetResult = await wallet.createAndSendNanoContractTransaction('set_result', address1, {
       ncId: tx1.hash,
       args: [`${bufferToHex(inputData)},${result},str`],
@@ -316,18 +349,27 @@ describe('full cycle of bet nano contract', () => {
       network,
       txSetResultData.tx.nc_args
     );
-    txSetResultParser.parseAddress(network);
+    txSetResultParser.parseAddress();
     await txSetResultParser.parseArguments();
-    expect(txSetResultParser.address.base58).toBe(address1);
-    expect(txSetResultParser.parsedArgs).toStrictEqual([
-      {
-        name: 'result',
-        type: 'SignedData[str]',
-        parsed: `${bufferToHex(inputData)},${result},str`,
-      },
-    ]);
+    expect(txSetResultParser.address?.base58).toBe(address1);
+    expect(txSetResultParser.parsedArgs).not.toBeNull();
+    if (txSetResultParser.parsedArgs === null) {
+      throw new Error('Could not parse args');
+    }
+    expect(txSetResultParser.parsedArgs).toHaveLength(1);
+    expect(txSetResultParser.parsedArgs[0]).toMatchObject({
+      name: 'result',
+      type: 'SignedData[str]',
+    });
+    expect((txSetResultParser.parsedArgs[0].value as NanoContractSignedData).type).toEqual('str');
+    expect(
+      (txSetResultParser.parsedArgs[0].value as NanoContractSignedData).signature
+    // @ts-expect-error toMatchBuffer is defined in setupTests.js
+    ).toMatchBuffer(inputData);
+    expect((txSetResultParser.parsedArgs[0].value as NanoContractSignedData).value).toEqual(result);
 
     // Try to withdraw to address 2, success
+    console.debug('Call to withdraw');
     const txWithdrawal = await wallet.createAndSendNanoContractTransaction('withdraw', address2, {
       ncId: tx1.hash,
       actions: [
@@ -351,14 +393,14 @@ describe('full cycle of bet nano contract', () => {
 
     const txWithdrawalParser = new NanoContractTransactionParser(
       blueprintId,
-      'set_result',
+      'withdraw',
       txWithdrawalData.tx.nc_pubkey,
       network,
       txWithdrawalData.tx.nc_args
     );
-    txWithdrawalParser.parseAddress(network);
+    txWithdrawalParser.parseAddress();
     await txWithdrawalParser.parseArguments();
-    expect(txWithdrawalParser.address.base58).toBe(address2);
+    expect(txWithdrawalParser.address?.base58).toBe(address2);
     expect(txWithdrawalParser.parsedArgs).toBe(null);
 
     // Get state again
@@ -486,7 +528,7 @@ describe('full cycle of bet nano contract', () => {
 
     jest.spyOn(wallet.storage, 'processHistory');
     expect(wallet.storage.processHistory.mock.calls.length).toBe(0);
-    await waitTxConfirmed(wallet, txWithdrawal2.hash);
+    await waitTxConfirmed(wallet, txWithdrawal2.hash, null);
     const txWithdrawal2Data = await wallet.getFullTxById(txWithdrawal2.hash);
 
     // The tx became voided after the block because of the nano execution
@@ -519,16 +561,16 @@ describe('full cycle of bet nano contract', () => {
     // Add funds and validate address meta
     await GenesisWalletHelper.injectFunds(ocbWallet, address0, 1000n);
     const address0Meta = await ocbWallet.storage.store.getAddressMeta(address0);
-    expect(address0Meta.numTransactions).toBe(1);
+    expect(address0Meta?.numTransactions).toBe(1);
 
     // Use the bet blueprint code
     const code = fs.readFileSync('./__tests__/integration/configuration/bet.py', 'utf8');
     const tx = await ocbWallet.createAndSendOnChainBlueprintTransaction(code, address10);
     // Wait for the tx to be confirmed, so we can use the on chain blueprint
-    await waitTxConfirmed(ocbWallet, tx.hash);
+    await waitTxConfirmed(ocbWallet, tx.hash!, null);
     // We must have one transaction in the address10 now
     const newAddress10Meta = await ocbWallet.storage.store.getAddressMeta(address10);
-    expect(newAddress10Meta.numTransactions).toBe(1);
+    expect(newAddress10Meta?.numTransactions).toBe(1);
     // Execute the bet blueprint tests
     await executeTests(ocbWallet, tx.hash);
   });