Vesting

Changelog.md

@@ -1,3 +1,67 @@
+May 17th, Wednesday
+
+Before I understand, I need to understand what I need to understand
+- [ ] a lightweight outline of testable expectations.
+- [ ] organization and structure for the testing code.
+- [ ] look at testing example in a [production app](https://github.com/Zhengqbbb/cz-git)
+
+My code should be easy to understand.
+I use my code as a Lego, having a set of building blocks that work together. 
+
+let me write a test for compiling the validator.
+
+May 16th, Tuesday
+
+I have new goal(s); do I? Review README;
+
+May 13th, Saturday
+
+I have to discard three days of work, start anew. 
+My goal is a loan contract. To build it, I need a testing environemnt to play with.
+I have two examples of code that works sending and redeeming tokens from a validator address: vesting in Helios and matching keyhash in lucid.
+matching keyhash is simpler, I should start there. Maybe next step would be to rebuild owner-only from Helios in lucid?
+
+May 9th, Tuesday
+
+Feel better, last couple of days were hard;
+Merge helios emulator?
+
+May 5, Friday
+No wind. Eat, code, sleep, repeat. No life;
+
+
+May 4, Thursday
+Still apathy, but I am pressing forward;
+two parts: the contract, and the transactions that serve it, are inseparable; at least for now.
+For vesting contract, I have the script, but I need to find transactions; or translate them from the example. 
+`vesting/pages/index.tsx` imports components in its top,
+- [ ] index.tsx: how are components used?
+- [ ] loan: 
+
+I am pretty exhausted; apathy and sleepiness on Wednesday;
+Now my goal is to buid without a manual. So I will start with building with a manual and see where it gets me.
+
+May 2, Tuesday
+
+https://github.com/aleeusgr/potential-robot/issues/70
+
+May 1, Monday
+
+I am unstuck big time; now I have a nicer repo;
+9 tests are passing, out of which I know 5;
+
+Now I take a break.
+
+29 Apr, Sat
+
+I am stuck with both refactoring and using Helios nft minter contract to mint an nft in Lucid emulator.
+- [ ] look at tutorial Lucid smart contract interaction.
+
+25 April
+
+- [ ] refactor test
+- [ ] add nft to borrwer wallet
+
 13 April
 
 rethink

README.md

@@ -1,5 +1,64 @@
 # potential-robot
-[source](https://github.com/koralabs/handles-personalization/tree/master/simple_example_wth_tests)
+
+An option smart contract;
+lockAda (owner Pkh, nft, deadline);
+claimAda (nft): not after deadline? 
+
+I'll suggest starting a lightweight outline of testable expectations.
+
+Formatting test files using that kind of outline provides good organization and structure for the testing code.
+
+outline in test DSL:
+
+- [ ] 
+```javascript
+describe("vesting contract"), () => {
+  describe("contract initiation", () => {
+    it("holds assets for vesting", async() => {
+    })
+    it("lets the initiator take their own funds back, until the contract is claimed", async () => {})
+  })
+  describe("contract claim", async() => {
+     it("allows the recipient to mint a claim token they can hold in their wallet" async() => {
+})
+     it("doesn't let the initiator withdraw funds once claimed", async() => {
+})
+  })
+
+  describe("gradual maturation", () => {
+    ...
+  })
+
+  describe("reclaiming funds after long period of inactivity" () => {
+    ...
+  })
+})
+```
+
+- [ ]
+```javascript
+describe("vesting contract", () => {
+  let vestingProgram, initiatorWallet, recipientWallet;
+  beforeEach(() => { 
+    vestingProgram = new helios.Program( ... ); 
+     ...
+  })
+  it ("tests things while reusing provided `vestingProgram`", async () => {
+    ...
+  })
+})
+```
+- [ ] 
+```javascript
+it("works with datumHash and datum at spend time")
+it("works with inlineDatum and no special datum at spend time")
+```
+
+
 
 `npm install`
 `npm test`
+
+references:
+https://github.com/koralabs/handles-personalization/tree/master/simple_example_wth_tests
+https://github.com/lley154/helios-examples/tree/main/vitest

old-tests/basic.test.ts

@@ -0,0 +1,21 @@
+import { assert, expect, test } from 'vitest'
+
+// Edit an assertion and save to see HMR in action
+
+test('Math.sqrt()', () => {
+  expect(Math.sqrt(4)).toBe(2)
+  expect(Math.sqrt(144)).toBe(12)
+  expect(Math.sqrt(2)).toBe(Math.SQRT2)
+})
+
+test('JSON', () => {
+  const input = {
+    foo: 'hello',
+    bar: 'world',
+  }
+
+  const output = JSON.stringify(input)
+
+  expect(output).eq('{"foo":"hello","bar":"world"}')
+  assert.deepEqual(JSON.parse(output), input, 'matches original')
+})

old-tests/helios-int-emu-nft.test.ts

@@ -0,0 +1,144 @@
+import { describe, expect, it, vi } from 'vitest'
+import { promises as fs } from 'fs';
+import {
+  Assets, 
+  ConstrData, 
+  MintingPolicyHash,
+  NetworkEmulator,
+  NetworkParams,
+  Program, 
+  Value, 
+  textToBytes,
+  TxOutput,
+  Tx, 
+} from "@hyperionbt/helios";
+
+describe('Creates Helios Emulator and adds an nft to a wallet', () => {
+
+    const main = async () => {
+
+	let optimize = false;
+	const minAda = BigInt(2000000);  // minimum lovelace needed to send an NFT
+	try {
+	// Create an Instance of NetworkEmulator
+      const network = new NetworkEmulator();
+
+      // Create a Wallet - we add 10ADA to start
+      const alice = network.createWallet(BigInt(10000000));
+
+      // Add an additional lovelace only UTXO
+      network.createUtxo(alice, BigInt(5000000));
+
+      // Create a Test Asset
+      const testAsset = new Assets();
+      testAsset.addComponent(
+          MintingPolicyHash.fromHex(
+          '16aa5486dab6527c4697387736ae449411c03dcd20a3950453e6779c'
+          ),
+          Array.from(new TextEncoder().encode('Test Asset Name')),
+          BigInt(1)
+      );
+
+      // Add additional Token to the wallet
+      network.createUtxo(alice, BigInt(2000000), testAsset);
+
+      // Now lets tick the network on 10 slots,
+      // this will allow the UTxOs to be created from Genisis
+      network.tick(BigInt(10));
+
+      // Now we are able to get the UTxOs in Alices wallet
+      const utxos = await network.getUtxos(alice.address);
+      console.log("************ PRE-TEST ************");
+
+      console.log("Wallet UTXOs:");
+      for (const utxo of utxos) {
+        console.log("txId", utxo.txId.hex + "#" + utxo.utxoIdx);
+        console.log("value", utxo.value.dump());
+      }
+
+      // Pull in the NFT minting script, update params and compile
+      const nftScript = await fs.readFile('./src/nft.hl', 'utf8');
+      const nftProgram = Program.new(nftScript);
+      nftProgram.parameters = {["TX_ID"] : utxos[0].txId.hex};
+      nftProgram.parameters = {["TX_IDX"] : utxos[0].utxoIdx};
+      const nftCompiledProgram = nftProgram.compile(optimize);
+      const nftMPH = nftCompiledProgram.mintingPolicyHash;
+
+      // Start building the transaction
+      const tx = new Tx();
+
+      // Add the UTXO as inputs
+      tx.addInputs(utxos);
+
+      // Add the script as a witness to the transaction
+      tx.attachScript(nftCompiledProgram);
+
+      // Create an empty Redeemer because we must always send a Redeemer with
+      // a plutus script transaction even if we don't actually use it.
+      const nftRedeemer = new ConstrData(0, []);
+      const token = [[textToBytes("Thread Token"), BigInt(1)]];
+
+      // Add the mint to the tx
+      tx.mintTokens(
+          nftMPH,
+          token,
+          nftRedeemer
+      )
+
+      // Attach the output with the minted nft to the destination address
+      tx.addOutput(new TxOutput(
+          alice.address,
+          new Value(minAda, new Assets([[nftMPH, token]]))
+        ));
+
+        // Network Parameters
+      const networkParamsFile = await fs.readFile('./src/preprod.json', 'utf8');
+      const networkParams = new NetworkParams(JSON.parse(networkParamsFile.toString()));
+
+      console.log("");
+      console.log("************ EXECUTE SMART CONTRACT ************");
+      await tx.finalize(networkParams, alice.address, utxos);
+
+      console.log("");
+      console.log("************ SUBMIT TX ************");
+      // Submit Tx to the network
+      const txId = await network.submitTx(tx);
+      console.log("TxId", txId.dump());
+
+      // Tick the network on 10 more slots,
+      network.tick(BigInt(10));
+
+      const utxosFinal = await network.getUtxos(alice.address);
+      console.log("");
+      console.log("************ POST-TEST ************");
+      console.log("Wallet UTXOs:");
+      for (const utxo of utxosFinal) {
+        console.log("txId", utxo.txId.hex + "#" + utxo.utxoIdx);
+        console.log("value", utxo.value.dump());
+      }
+
+	return utxosFinal[2].value.dump().lovelace == '13676369'
+	} catch (err) {
+	    console.error("something failed:", err);
+	    return false;
+	}
+    }
+
+    it('adds logging', async () => {
+
+	const logMsgs = new Set();
+	const logSpy = vi.spyOn(global.console, 'log')
+			 .mockImplementation((msg) => { logMsgs.add(msg); });
+
+	let mainStatus = await main();
+	logSpy.mockRestore();
+	if (!mainStatus) {
+	    console.log("Smart Contract Messages: ", logMsgs);
+	}
+	expect(mainStatus).toBe(true);
+	console.log(logMsgs);
+
+    })
+
+})
+

old-tests/helios-int-emu-scr.test.ts

@@ -0,0 +1,69 @@
+import { describe, expect, it, vi } from 'vitest'
+import { promises as fs } from 'fs';
+import {
+  Assets, 
+  Address,
+  ConstrData, 
+  MintingPolicyHash,
+  NetworkEmulator,
+  NetworkParams,
+  Program, 
+  Value, 
+  textToBytes,
+  TxOutput,
+  Tx, 
+} from "@hyperionbt/helios";
+
+describe('Submits a transaction to a validator address', () => {
+
+    const main = async () => {
+
+	let optimize = false;
+	const minAda = BigInt(2000000);  // minimum lovelace needed to send an NFT
+	try {
+	const network = new NetworkEmulator();
+
+	const alice = network.createWallet(BigInt(10000000));
+
+	network.createUtxo(alice, BigInt(5000000));
+
+	network.tick(BigInt(10));
+
+      // Now we are able to get the UTxOs in Alices wallet
+
+	const script = await fs.readFile('./src/owner-only.hl', 'utf8'); 
+	const program = Program.new(script); 
+	const compiledProgram = program.compile(optimize); 
+
+	const validatorHash = compiledProgram.validatorHash;
+	// https://www.hyperion-bt.org/helios-book/lang/builtins/address.html#address
+	const validatorAddress = Address.fromValidatorHash(validatorHash); 
+
+	const utxosFinal = await network.getUtxos(alice.address);
+
+	return utxosFinal[1].value.dump().lovelace == '5000000' && validatorAddress.toBech32() == 'addr_test1wq8jn3u0ts654lp6ltvyju7nflcm5qegukqukuhc4jdxhag7ku5n4'
+
+	} catch (err) {
+	    console.error("something failed:", err);
+	    return false;
+	}
+    }
+
+    it('adds logging', async () => {
+
+	const logMsgs = new Set();
+	const logSpy = vi.spyOn(global.console, 'log')
+			 .mockImplementation((msg) => { logMsgs.add(msg); });
+
+	let mainStatus = await main();
+	logSpy.mockRestore();
+	if (!mainStatus) {
+	    console.log("Smart Contract Messages: ", logMsgs);
+	}
+	expect(mainStatus).toBe(true);
+	console.log(logMsgs);
+
+    })
+
+})
+