@odatano/core 0.3.17 → 0.3.18

package/srv/cardano-tx-service.cds

@@ -1,4 +1,6 @@
 using {odatano.cardano as db} from '../db/schema';
+using {Bech32, Lovelace} from '../db/types';
+
 
 /**
  * Cardano Transaction Service
@@ -7,7 +9,7 @@ using {odatano.cardano as db} from '../db/schema';
  * Separate from the read-only CardanoODataService to provide
  * clear separation between general query and command operations.
  */
-service CardanoTransactionService @(impl: 'srv/cardano-tx-service') {
+service CardanoTransactionService @(impl: './cardano-tx-service') {
     // ---------------------------------------------------------------------------
     // Entity Projections - Transaction Building & Submission
     // ---------------------------------------------------------------------------
@@ -32,18 +34,32 @@ service CardanoTransactionService @(impl: 'srv/cardano-tx-service') {
     @description: 'Projection for Transaction Build Output Assets'
     entity TransactionBuildOutputAssets as projection on db.TransactionBuildOutputAssets;
 
-    @title      : 'Transaction Submissions'
-    @description: 'Projection for Transaction Submissions'
-    entity TransactionSubmissions       as projection on db.TransactionSubmissions actions {
-        @title      : 'Check Submission Status'
-        @description: 'Check the status of a submitted transaction by querying the blockchain for confirmation'
-        action CheckSubmissionStatus() returns TransactionSubmissions;
+            @title      : 'Transaction Submissions'
+            @description: 'Projection for Transaction Submissions'
+    entity TransactionSubmissions       as projection on db.TransactionSubmissions
+        actions {
+            @title      : 'Check Submission Status'
+            @description: 'Check the status of a submitted transaction by querying the blockchain for confirmation'
+            action CheckSubmissionStatus() returns TransactionSubmissions;
+        };
+    /**
+     * TransactionSubmissions status flow:
+     *   pending ──[submit to chain]──→ submitted  (internal, in SubmitTransaction handler)
+     *   submitted ──[CheckSubmissionStatus]──→ confirmed | stays submitted  (conditional)
+     *   pending | submitted ──→ failed  (blockchain error)
+     */
+    annotate CardanoTransactionService.TransactionSubmissions with @flow.status: status actions {
+        CheckSubmissionStatus                                      @from       : [ #submitted];
     };
 
     @title      : 'Transaction Submission Errors'
     @description: 'Projection for Transaction Submission Errors'
     entity TransactionSubmissionErrors  as projection on db.TransactionSubmissionErrors;
 
+    @title      : 'Address Transaction Builds'
+    @description: 'Projection for retrieving transaction builds by address'
+    entity AddressTransactionBuilds     as projection on db.AddressTransactionBuilds;
+
     // ---------------------------------------------------------------------------
     // Transaction Building Actions
     // ---------------------------------------------------------------------------
@@ -53,76 +69,76 @@ service CardanoTransactionService @(impl: 'srv/cardano-tx-service') {
     action BuildSimpleAdaTransaction(
                                      @title: 'Sender Address'
                                      @description: 'The Bech32 encoded address of the sender'
-                                     senderAddress: db.Bech32,
+                                     senderAddress: Bech32,
                                      @title: 'Recipient Address'
                                      @description: 'The Bech32 encoded address of the recipient'
-                                     recipientAddress: db.Bech32,
+                                     recipientAddress: Bech32,
                                      @title: 'Lovelace Amount'
                                      @description: 'The amount of ADA to send in lovelace'
-                                     lovelaceAmount: db.Lovelace,
+                                     lovelaceAmount: Lovelace,
                                      @title: 'Change Address'
                                      @description: 'The Bech32 encoded address for returning change - defaults to sender address if not specified'
-                                     changeAddress: db.Bech32,
+                                     changeAddress: Bech32,
                                      @title: 'Output Datum JSON'
                                      @description: 'Optional inline datum to attach to the recipient output (JSON, cardano-cli DetailedSchema format). Required when sending to a script address.'
                                      outputDatumJson: String,
                                      @title: 'Assets JSON'
                                      @description: 'Optional JSON array of native assets to include in the output ([{"unit":"policyId+assetName","quantity":"amount"}]). Use when locking tokens at a script address.'
-                                     assetsJson: String) returns TransactionBuilds;
+                                     assetsJson: String)       returns TransactionBuilds;
 
-    @title : 'Build Transaction with Metadata'
+    @title      : 'Build Transaction with Metadata'
     @description: 'Build a transaction with custom metadata from sender to recipient with specified amount and change address'
     action BuildTransactionWithMetadata(
-                                            @title: 'Sender Address'
-                                            @description: 'The Bech32 encoded address of the sender'
-                                            senderAddress: db.Bech32,
-                                            @title: 'Recipient Address'
-                                            @description: 'The Bech32 encoded address of the recipient'
-                                            recipientAddress: db.Bech32,
-                                            @title: 'Lovelace Amount'
-                                            @description: 'The amount of ADA to send in lovelace'
-                                            lovelaceAmount: db.Lovelace,
-                                            @title: 'Change Address'
-                                            @description: 'The Bech32 encoded address for returning change -defaults to sender address if not specified'
-                                            changeAddress: db.Bech32,
-                                            @title: 'Metadata JSON'
-                                            @description: 'The JSON representation of the transaction metadata as string'
-                                            metadataJson: String) returns TransactionBuilds;
-
-    @title : 'Build Multi-Asset Transaction'
-    @description: 'Build a transaction to send native assets (tokens) along with ADA'
-    action BuildMultiAssetTransaction(
                                         @title: 'Sender Address'
                                         @description: 'The Bech32 encoded address of the sender'
-                                        senderAddress: db.Bech32,
+                                        senderAddress: Bech32,
                                         @title: 'Recipient Address'
                                         @description: 'The Bech32 encoded address of the recipient'
-                                        recipientAddress: db.Bech32,
+                                        recipientAddress: Bech32,
                                         @title: 'Lovelace Amount'
                                         @description: 'The amount of ADA to send in lovelace'
-                                        lovelaceAmount: db.Lovelace,
-                                        @title: 'Assets JSON'
-                                        @description: 'JSON array of assets to send (format: [{"unit":"policyId+assetName","quantity":"amount"}])'
-                                        assetsJson: String,
+                                        lovelaceAmount: Lovelace,
                                         @title: 'Change Address'
                                         @description: 'The Bech32 encoded address for returning change -defaults to sender address if not specified'
-                                        changeAddress: db.Bech32,
-                                        @title: 'Output Datum JSON'
-                                        @description: 'Optional inline datum to attach to the recipient output (JSON, DetailedSchema). Required when sending to a script address.'
-                                        outputDatumJson: String) returns TransactionBuilds;
+                                        changeAddress: Bech32,
+                                        @title: 'Metadata JSON'
+                                        @description: 'The JSON representation of the transaction metadata as string'
+                                        metadataJson: String)  returns TransactionBuilds;
 
-    @title : 'Build Minting Transaction'
+    @title      : 'Build Multi-Asset Transaction'
+    @description: 'Build a transaction to send native assets (tokens) along with ADA'
+    action BuildMultiAssetTransaction(
+                                      @title: 'Sender Address'
+                                      @description: 'The Bech32 encoded address of the sender'
+                                      senderAddress: Bech32,
+                                      @title: 'Recipient Address'
+                                      @description: 'The Bech32 encoded address of the recipient'
+                                      recipientAddress: Bech32,
+                                      @title: 'Lovelace Amount'
+                                      @description: 'The amount of ADA to send in lovelace'
+                                      lovelaceAmount: Lovelace,
+                                      @title: 'Assets JSON'
+                                      @description: 'JSON array of assets to send (format: [{"unit":"policyId+assetName","quantity":"amount"}])'
+                                      assetsJson: String,
+                                      @title: 'Change Address'
+                                      @description: 'The Bech32 encoded address for returning change -defaults to sender address if not specified'
+                                      changeAddress: Bech32,
+                                      @title: 'Output Datum JSON'
+                                      @description: 'Optional inline datum to attach to the recipient output (JSON, DetailedSchema). Required when sending to a script address.'
+                                      outputDatumJson: String) returns TransactionBuilds;
+
+    @title      : 'Build Minting Transaction'
     @description: 'Build a transaction to mint or burn native assets'
     action BuildMintTransaction(
                                 @title: 'Sender Address'
                                 @description: 'The Bech32 encoded address of the sender (pays fees)'
-                                senderAddress: db.Bech32,
+                                senderAddress: Bech32,
                                 @title: 'Recipient Address'
                                 @description: 'The Bech32 encoded address to receive minted assets'
-                                recipientAddress: db.Bech32,
+                                recipientAddress: Bech32,
                                 @title: 'Lovelace Amount'
                                 @description: 'The amount of ADA to send with minted assets in lovelace'
-                                lovelaceAmount: db.Lovelace,
+                                lovelaceAmount: Lovelace,
                                 @title: 'Mint Actions JSON'
                                 @description: 'JSON array of mint/burn actions (format: [{"assetUnit":"policyId+assetName","quantity":"amount"}])'
                                 mintActionsJson: String,
@@ -131,7 +147,7 @@ service CardanoTransactionService @(impl: 'srv/cardano-tx-service') {
                                 mintingPolicyScript: String,
                                 @title: 'Change Address'
                                 @description: 'The Bech32 encoded address for returning change -defaults to sender address if not specified'
-                                changeAddress: db.Bech32,
+                                changeAddress: Bech32,
                                 @title: 'Required Signers JSON'
                                 @description: 'Optional JSON array of Ed25519 key hashes (hex, 28 bytes each) that must sign the transaction. Required for Plutus validators checking extra_signatories.'
                                 requiredSignersJson: String,
@@ -146,57 +162,7 @@ service CardanoTransactionService @(impl: 'srv/cardano-tx-service') {
                                 mintRedeemerJson: String,
                                 @title: 'Lock on Script Address'
                                 @description: 'When true and scriptParamsJson is provided, routes the output to the enterprise script address derived from the applied script hash instead of recipientAddress. Returns scriptAddress in the response.'
-                                lockOnScript: Boolean) returns TransactionBuilds;
-
-    @title : 'Build Plutus Spend Transaction'
-    @description: 'Build a transaction to spend a UTxO locked at a Plutus script address'
-    action BuildPlutusSpendTransaction(
-                                @title: 'Sender Address'
-                                @description: 'The Bech32 encoded address of the sender (pays fees)'
-                                senderAddress: db.Bech32,
-                                @title: 'Recipient Address'
-                                @description: 'The Bech32 encoded address to receive the unlocked funds'
-                                recipientAddress: db.Bech32,
-                                @title: 'Lovelace Amount'
-                                @description: 'The amount of ADA to send to the recipient in lovelace'
-                                lovelaceAmount: db.Lovelace,
-                                @title: 'Validator Script'
-                                @description: 'The Plutus validator script in CBOR hex format'
-                                validatorScript: String,
-                                @title: 'Script UTxO Transaction Hash'
-                                @description: 'The transaction hash of the UTxO locked at the script address (64-char hex)'
-                                scriptTxHash: String,
-                                @title: 'Script UTxO Output Index'
-                                @description: 'The output index of the UTxO locked at the script address'
-                                scriptOutputIndex: Integer,
-                                @title: 'Redeemer JSON'
-                                @description: 'The redeemer data as JSON string (will be converted to PlutusData)'
-                                redeemerJson: String,
-                                @title: 'Datum JSON'
-                                @description: 'The datum data as JSON string (optional, for hash-based datums)'
-                                datumJson: String,
-                                @title: 'Change Address'
-                                @description: 'The Bech32 encoded address for returning change - defaults to sender address if not specified'
-                                changeAddress: db.Bech32,
-                                @title: 'Required Signers JSON'
-                                @description: 'Optional JSON array of Ed25519 key hashes (hex, 28 bytes each) that must sign the transaction. Required for Plutus validators checking extra_signatories.'
-                                requiredSignersJson: String,
-                                @title: 'Script Parameters JSON'
-                                @description: 'Optional JSON array of PlutusData parameters to apply to the validator script before building. For parameterized validators.'
-                                scriptParamsJson: String,
-                                @title: 'Output Inline Datum JSON'
-                                @description: 'Optional PlutusData JSON to attach as inline datum on the recipient output. Used for state-machine validators that require continuing output datum.'
-                                inlineDatumJson: String,
-                                @title: 'Lock on Script Address'
-                                @description: 'When true and scriptParamsJson is provided, routes the output to the enterprise script address derived from the applied script hash instead of recipientAddress. Returns scriptAddress in the response.'
-                                lockOnScript: Boolean) returns TransactionBuilds;
-
-    @title : 'Set Collateral'
-    @description: 'Ensure a dedicated ADA-only collateral UTxO exists for Plutus transactions. Checks if the address has at least 2 UTxOs with >= 5 ADA each. If not, builds a self-send transaction to create a 5 ADA collateral UTxO.'
-    action SetCollateral(
-                          @title: 'Address'
-                          @description: 'The Bech32 encoded address to check and set up collateral for'
-                          address: db.Bech32) returns TransactionBuilds;
+                                lockOnScript: Boolean)         returns TransactionBuilds;
 
     @title      : 'Get Build Details'
     @description: 'Retrieve transaction build details using the Build Id'
@@ -225,107 +191,61 @@ service CardanoTransactionService @(impl: 'srv/cardano-tx-service') {
                                    @description: 'The Cardano network to submit the transaction to (e.g., mainnet, testnet)'
                                    network: String(10))        returns TransactionSubmissions;
 
-    // ---------------------------------------------------------------------------
-    // M3 - External Signing Workflow Entities & Actions
-    // ---------------------------------------------------------------------------
-
-    @title      : 'Signing Requests'
-    @description: 'Projection for Signing Requests - tracks external signing workflow'
-    entity SigningRequests              as projection on db.SigningRequests actions {
-        @title      : 'Verify Signature'
-        @description: 'Verify the signature of a signed transaction. Stores the verification result for audit trail.'
-        action VerifySignature(
-            @title: 'Signed Transaction CBOR'
-            @description: 'The signed transaction CBOR to verify'
-            signedTxCbor: String,
-            @title: 'Signer Type'
-            @description: 'Type of signer used (cardano-cli | browser-wallet | hardware-wallet | custom)'
-            signerType: String(20),
-            @title: 'Signer Info'
-            @description: 'Additional signer information (wallet name, etc.)'
-            signerInfo: String(100)
-        ) returns SignatureVerifications;
-
-        @title      : 'Submit Verified Transaction'
-        @description: 'Verify and submit a signed transaction in one step. Updates the signing request status and creates submission record.'
-        action SubmitVerifiedTransaction(
-            @title: 'Signed Transaction CBOR'
-            @description: 'The signed transaction CBOR'
-            signedTxCbor: String,
-            @title: 'Signer Type'
-            @description: 'Type of signer used'
-            signerType: String(20),
-            @title: 'Signer Info'
-            @description: 'Additional signer information'
-            signerInfo: String(100)
-        ) returns TransactionSubmissions;
-    };
-
-    @title      : 'Signature Verifications'
-    @description: 'Projection for Signature Verifications - stores verification results'
-    entity SignatureVerifications       as projection on db.SignatureVerifications;
-
-    @title      : 'Address Signing Requests'
-    @description: 'Projection for retrieving signing requests by address'
-    entity AddressSigningRequests       as projection on db.AddressSigningRequests;
-
+    @title      : 'Build Plutus Spend Transaction'
+    @description: 'Build a transaction to spend a UTxO locked at a Plutus script address'
+    action BuildPlutusSpendTransaction(
+                                       @title: 'Sender Address'
+                                       @description: 'The Bech32 encoded address of the sender (pays fees)'
+                                       senderAddress: Bech32,
+                                       @title: 'Recipient Address'
+                                       @description: 'The Bech32 encoded address to receive the unlocked funds'
+                                       recipientAddress: Bech32,
+                                       @title: 'Lovelace Amount'
+                                       @description: 'The amount of ADA to send to the recipient in lovelace'
+                                       lovelaceAmount: Lovelace,
+                                       @title: 'Validator Script'
+                                       @description: 'The Plutus validator script in CBOR hex format'
+                                       validatorScript: String,
+                                       @title: 'Script UTxO Transaction Hash'
+                                       @description: 'The transaction hash of the UTxO locked at the script address (64-char hex)'
+                                       scriptTxHash: String,
+                                       @title: 'Script UTxO Output Index'
+                                       @description: 'The output index of the UTxO locked at the script address'
+                                       scriptOutputIndex: Integer,
+                                       @title: 'Redeemer JSON'
+                                       @description: 'The redeemer data as JSON string (will be converted to PlutusData)'
+                                       redeemerJson: String,
+                                       @title: 'Datum JSON'
+                                       @description: 'The datum data as JSON string (optional, for hash-based datums)'
+                                       datumJson: String,
+                                       @title: 'Change Address'
+                                       @description: 'The Bech32 encoded address for returning change - defaults to sender address if not specified'
+                                       changeAddress: Bech32,
+                                       @title: 'Required Signers JSON'
+                                       @description: 'Optional JSON array of Ed25519 key hashes (hex, 28 bytes each) that must sign the transaction. Required for Plutus validators checking extra_signatories.'
+                                       requiredSignersJson: String,
+                                       @title: 'Script Parameters JSON'
+                                       @description: 'Optional JSON array of PlutusData parameters to apply to the validator script before building. For parameterized validators.'
+                                       scriptParamsJson: String,
+                                       @title: 'Output Inline Datum JSON'
+                                       @description: 'Optional PlutusData JSON to attach as inline datum on the recipient output. Used for state-machine validators that require continuing output datum.'
+                                       inlineDatumJson: String,
+                                       @title: 'Lock on Script Address'
+                                       @description: 'When true and scriptParamsJson is provided, routes the output to the enterprise script address derived from the applied script hash instead of recipientAddress. Returns scriptAddress in the response.'
+                                       lockOnScript: Boolean)  returns TransactionBuilds;
+
+    @title      : 'Set Collateral'
+    @description: 'Ensure a dedicated ADA-only collateral UTxO exists for Plutus transactions. Checks if the address has at least 2 UTxOs with >= 5 ADA each. If not, builds a self-send transaction to create a 5 ADA collateral UTxO.'
+    action SetCollateral(
+                         @title: 'Address'
+                         @description: 'The Bech32 encoded address to check and set up collateral for'
+                         address: Bech32)                   returns TransactionBuilds;
     @title      : 'Address Transaction Builds'
     @description: 'Projection for retrieving transaction builds by address'
-    entity AddressTransactionBuilds     as projection on db.AddressTransactionBuilds;
-
-    @title      : 'Create Signing Request'
-    @description: 'Create a signing request for external signing. Returns transaction details, signing instructions, and CLI commands. The request is persisted for audit trail.'
-    action CreateSigningRequest(
-                                @title: 'Build ID'
-                                @description: 'The unique identifier of the transaction build'
-                                buildId: UUID,
-                                @title: 'Message to Signer'
-                                @description: 'A message to include for the signer'
-                                message: String)             returns SigningRequests;
-
-    @title      : 'Get Signing Request'
-    @description: 'Retrieve an existing signing request by ID'
-    action GetSigningRequest(
-                             @title: 'Signing Request ID'
-                             @description: 'The unique identifier of the signing request'
-                             signingRequestId: UUID)         returns SigningRequests;
-
-    @title: 'Address Signing Requests'
-    @description: 'Projection for retrieving signing requests by address'
-    action GetSigningRequestsByAddress(
-                                        @title: 'Bech32 Address'
-                                        @description: 'The Bech32 encoded address to retrieve signing requests for'
-                                        address: db.Bech32)        returns array of AddressSigningRequests;
-    @title: 'Address Transaction Builds'
-    @description: 'Projection for retrieving transaction builds by address'
     action GetTransactionBuildsByAddress(
-                                          @title: 'Bech32 Address'
-                                          @description: 'The Bech32 encoded address to retrieve transaction builds for'
-                                          address: db.Bech32)    returns array of AddressTransactionBuilds;
-
+                                         @title: 'Bech32 Address'
+                                         @description: 'The Bech32 encoded address to retrieve transaction builds for'
+                                         address: Bech32)   returns array of AddressTransactionBuilds;
 }
 
-// ---------------------------------------------------------------------------
-// Status-Transition Flows (CAP @flow.status — Gamma)
-// ---------------------------------------------------------------------------
-
-/**
- * SigningRequests status flow:
- *   pending ──[VerifySignature]──→ verified | failed  (conditional in handler)
- *   pending | verified ──[SubmitVerifiedTransaction]──→ submitted
- *   pending ──[checkExpire]──→ expired  (custom time-based logic in handler)
- */
-annotate CardanoTransactionService.SigningRequests with @flow.status: status actions {
-    VerifySignature           @from: [#pending];
-    SubmitVerifiedTransaction @from: [#pending, #verified] @to: #submitted;
-};
 
-/**
- * TransactionSubmissions status flow:
- *   pending ──[submit to chain]──→ submitted  (internal, in SubmitTransaction handler)
- *   submitted ──[CheckSubmissionStatus]──→ confirmed | stays submitted  (conditional)
- *   pending | submitted ──→ failed  (on blockchain error)
- */
-annotate CardanoTransactionService.TransactionSubmissions with @flow.status: status actions {
-    CheckSubmissionStatus @from: [#submitted];
-};