Class SimulatorTestbed

Simulator Testbed Class

Use this class to run scenarios against the simulator.

Example

const Scenario1: TransactionObj[] = [
  {
    blockheight: 1,
    amount: 6_0000_0000n,
    sender: 1n,
    recipient: 2n,
  },
  {
    blockheight: 3,
    amount: 5000_0000n,
    sender: 1n,
    recipient: 2n,
  },
  // ...
]

const ContractPath = join(__dirname + './contract.smart.c')

const Testbed = new SimulatorTestbed()
Testbed.loadContract(ContractPath)
       .runScenario(Scenario1);

 const bc = Testbed.Node.Blockchain;
 const tx = bc.transactions;
 const map = testbed.getContractMap().filter(({k1, k2, value}) => ...)
Copy

INITIALIZE CONTRACT

To initialize variables in the contract you can use the initializer parameter when loading the contract.

To apply initialization a code injection is needed and requires the developer to use defines pre-pended with TESTBED_ source code, i.e.

// initializable variables
// a good practice to have them declared as first variables in your contract
long var1, var2, var3;

// Define values if running on testbed
#ifdef TESTBED
 const var1 = TESTBED_var1;
 const var2 = TESTBED_var2;
 const var3 = TESTBED_var3;
#endif

// This way your variable can be tested with different values easily in testbed
Copy

You may load the contract into the testbed as follows:

const ContractPath = join(__dirname + './contract.smart.c')

const testbed = SimulatorTestbed
    .loadContract(ContractPath, {
          var1: "Text",
          var2: 1,
          var3: 100n
          } // initial values
    ).runScenario(Scenario1);
Copy

This testbed loads a SmartC Contract and a scenario (set of transactions) and forges all necessary blocks. It's possible to inspect all the results, i.e. transactions, kkv-maps, accounts, in-memory variables, and test them against expected result sets. This class is meant to be used with Test Runners like Vitest or Jest.