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/lock-ada.test.ts

@@ -0,0 +1,104 @@
+// basic.spec.ts
+// organizing tests
+// https://vitest.dev/api/#test
+// `it` is alias for `test`
+// test suite;
+// test;
+
+import { describe, expect, it, vi } from 'vitest'
+import { promises as fs } from 'fs';
+import {
+  Assets, 
+  Address,
+  ByteArrayData,
+  ConstrData, 
+  Datum,
+  ListData,
+  MintingPolicyHash,
+  NetworkEmulator,
+  NetworkParams,
+  Program, 
+  Value, 
+  textToBytes,
+  TxOutput,
+  Tx, 
+} from "@hyperionbt/helios";
+
+const person = {
+  isActive: true,
+  age: 32,
+}
+
+let optimize = false;
+const minAda = BigInt(2000000);  // minimum lovelace needed to send an NFT
+const network = new NetworkEmulator();
+const networkParamsFile = await fs.readFile('./src/preprod.json', 'utf8');
+const networkParams = new NetworkParams(JSON.parse(networkParamsFile.toString()));
+const alice = network.createWallet(BigInt(10000000)); // should this be a property?
+network.tick(BigInt(10));
+
+describe('state of the emulator', () => {
+  it('shows that a wallet has been created', () => {
+	  // ahh, ok. Properties;
+    expect(alice.address).toBeDefined()
+  })
+})
+const script = await fs.readFile('./src/owner-only.hl', 'utf8'); 
+const program = Program.new(script); 
+//space here, maybe I need to modify program using .parameters?
+const compiledProgram = program.compile(optimize); 
+
+const validatorHash = compiledProgram.validatorHash;
+const validatorAddress = Address.fromValidatorHash(validatorHash); 
+
+describe('validator properties?', () => {
+
+  it('shows that a validator has been created', () => {
+	  // what checks should I can have?
+	  // assert type
+	  // internal checks
+    expect(person.isActive).toBeTruthy()
+  })
+})
+const lock = new Tx()
+const ownerPkh = alice.pubKeyHash ;
+const datum = new ListData([new ByteArrayData(ownerPkh.bytes),
+			]);
+
+const inlineDatum = Datum.inline(datum);        
+const hashedDatum = Datum.hashed(datum);        
+
+const lockIn = await network.getUtxos(alice.address)
+
+lock.addInput(lockIn[0]);
+
+const lockTxOutput = new TxOutput(
+    validatorAddress,
+    new Value(1000000n), // 1 tAda == 1 million lovelace
+    inlineDatum
+)
+lock.addOutput(lockTxOutput)
+
+await lock.finalize(networkParams, alice.address);
+
+const lockTxId = await network.submitTx(lock);
+network.tick(BigInt(10));
+
+describe('state of the emulator after the transaction', () => {
+  it('a utxo at validator address contains correct Datum:', () => {
+    // const uxto = network.getUtxos();
+	  // tx.dump.body()
+	  //
+    expect(alice.address).toBeDefined()
+  })
+  it('checks validatorAddress', () => {
+    expect(person.isActive).toBeTruthy()
+  })
+
+  it('is active', () => {
+    expect(person.isActive).toBeTruthy()
+  })
+  it('age limit', () => {
+    expect(person.age).toBeLessThanOrEqual(32)
+  })
+})