Merge pull request #2 from logicalmechanism/v3-review-2

Name changes and adding back in the yml workspace file

Author: logicalmechanism

.github/workflows/continuous-integration.yml

@@ -0,0 +1,64 @@
+name: Continuous Integration
+
+on:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+    tags: ["*.*.*"]
+  pull_request:
+    branches: ["main"]
+
+env:
+  CARGO_TERM_COLOR: always
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📥 Checkout repository
+        uses: actions/checkout@v3
+
+      - name: 🧰 Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: 🧰 Install Aiken
+        uses: aiken-lang/setup-aiken@v0.1.0
+        with:
+          version: v1.0.18-alpha
+
+      - name: 📝 Run fmt
+        run: aiken fmt --check
+
+      - name: 🔬 Run tests
+        run: aiken check
+
+      - name: 📘 Generate documentation
+        shell: bash
+        working-directory: .
+        run: aiken docs -o docs
+
+      - name: 📦 Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: "docs/"
+
+  deploy:
+    if: ${{ startsWith(github.ref, 'refs/tags') }}
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: 🚀 Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -1,4 +1,3 @@
 build/
 docs/
-.DS_Store
-.github/workflows/
+.DS_Store

lib/aiken/transaction.ak

@@ -7,8 +7,8 @@ use aiken/option
 use aiken/time.{PosixTime}
 use aiken/transaction/certificate.{Certificate}
 use aiken/transaction/credential.{
-  Address, Credential, DatumHashDigest, PubKeyHash, ScriptCredential, ScriptHash,
-  VerificationKeyCredential,
+  Address, Credential, DatumHashDigest, ScriptCredential, ScriptHash,
+  VerificationKeyCredential, VerificationKeyHash,
 }
 use aiken/transaction/governance.{
   GovernanceActionId, ProposalProcedure, Vote, Voter,
@@ -46,7 +46,7 @@ pub type ScriptPurpose {
   /// stake credentials.
   ///
   /// The Int is a 0-based index of the given `TxCert` in `certificates`.
-  Publish(Int, Certificate)
+  Publish { certificate_index: Int, certificate: Certificate }
   /// Voting for a type of voter using a governance action id to vote 
   /// yes / no / abstain inside a transaction.
   ///
@@ -55,7 +55,7 @@ pub type ScriptPurpose {
   /// Used to propose a governance action.
   ///
   /// A 0-based index of the given `ProposalProcedure` in `proposal_procedures`.
-  Proposing(Int, ProposalProcedure)
+  Proposing { proposal_index: Int, proposal: ProposalProcedure }
 }
 
 /// A Cardano `Transaction`, as seen by Plutus scripts.
@@ -75,7 +75,7 @@ pub type Transaction {
   certificates: List<Certificate>,
   withdrawals: Dict<Credential, Lovelace>,
   validity_range: ValidityRange,
-  extra_signatories: List<PubKeyHash>,
+  extra_signatories: List<VerificationKeyHash>,
   redeemers: Dict<ScriptPurpose, Redeemer>,
   datums: Dict<DatumHashDigest, Data>,
   id: TransactionId,

lib/aiken/transaction/certificate.ak

@@ -1,6 +1,6 @@
 use aiken/transaction/credential.{
   ColdCommitteeCredential, Credential, DRepCredential, HotCommitteeCredential,
-  PubKeyHash,
+  PoolId, VerificationKeyHash,
 }
 use aiken/transaction/governance.{Delegatee}
 use aiken/transaction/value.{Lovelace}
@@ -23,16 +23,16 @@ pub type Certificate {
   // Update a DRep. The optional anchor is omitted.
   UpdateDRep(DRepCredential)
   // UnRegister a DRep with mandatory refund value
-  UnRegisterDRep(DRepCredential, Lovelace)
+  UnregisterDRep(DRepCredential, Lovelace)
   // A digest of the PoolParams
   PoolRegister(
     // poolId
-    PubKeyHash,
+    PoolId,
     // pool VFR
-    PubKeyHash,
+    VerificationKeyHash,
   )
   // The retirement certificate and the Epoch in which the retirement will take place
-  PoolRetire(PubKeyHash, Int)
+  PoolRetire(VerificationKeyHash, Int)
   // Authorize a Hot credential for a specific Committee member's cold credential
   AuthorizeHotCommittee(ColdCommitteeCredential, HotCommitteeCredential)
   ResignColdCommittee(ColdCommitteeCredential)

lib/aiken/transaction/credential.ak

@@ -107,16 +107,16 @@ pub type StakeCredential =
 pub type PaymentCredential =
   Credential
 
-/// A unique stake pool identifier, as a hash of its owner verification key.
 pub type PoolId =
   Hash<Blake2b_224, VerificationKey>
 
-pub type PubKeyHash =
+pub type VerificationKeyHash =
   Hash<Blake2b_224, VerificationKey>
 
 pub type ScriptHash =
   Hash<Blake2b_224, Script>
 
+// DatumHash is taken as a Datum type so this may just need to change.
 pub type DatumHashDigest =
   Hash<Blake2b_256, Data>
 

lib/aiken/transaction/governance.ak

@@ -2,7 +2,7 @@ use aiken/dict.{Dict}
 use aiken/math/rational.{Rational}
 use aiken/transaction/credential.{
   ColdCommitteeCredential, Credential, DRepCredential, HotCommitteeCredential,
-  PubKeyHash, ScriptHash,
+  ScriptHash, VerificationKeyHash,
 }
 use aiken/transaction/value.{Lovelace}
 
@@ -13,9 +13,9 @@ pub type DRep {
 }
 
 pub type Delegatee {
-  DelegateStake(PubKeyHash)
+  DelegateStake(VerificationKeyHash)
   DelegateVote(DRep)
-  DelegateBoth(PubKeyHash, DRep)
+  DelegateBoth(VerificationKeyHash, DRep)
 }
 
 pub type Vote {
@@ -29,7 +29,7 @@ pub type GovernanceActionId {
   index: Int,
 }
 
-pub type ChangedParameters {
+pub type ChangedProtocolParameters {
   new_parameters: Data,
 }
 
@@ -85,5 +85,5 @@ pub type ProposalProcedure {
 pub type Voter {
   CommitteeVoter(HotCommitteeCredential)
   DRepVoter(DRepCredential)
-  StakePoolVoter(PubKeyHash)
+  StakePoolVoter(VerificationKeyHash)
 }