Merge pull request #164 from Concordium/feature/sponsored-transactions

Feature/sponsored transactions

Author: drsk0

.github/workflows/ci.yaml

@@ -2,26 +2,10 @@ name: Build
 
 on:
   pull_request:
-    branches:
-      - main
-    paths:
-    - '.github/workflows/ci.yaml'
-    - '**.hs'
-    - 'stack*.yaml'
-    - 'package.yaml'
-    - 'fourmolu.yaml'
-    - 'deps/concordium-client'
 
   push:
     branches:
       - main
-    paths:
-    - '.github/workflows/ci.yaml'
-    - '**.hs'
-    - 'stack*.yaml'
-    - 'package.yaml'
-    - 'fourmolu.yaml'
-    - 'deps/concordium-client'
 
   workflow_dispatch: # allow manual trigger
 

ChangeLog.md

@@ -2,6 +2,8 @@
 
 ## [unreleased]
 
+- Support for sponsored transactions for `/v0/submitTransfer` and `v3/accTransactions`.
+
 ## [0.43.0] - 2025-11-21
 
 - `/v0/submissionStatus` now supports RegisterData transactions.

README.md

@@ -23,6 +23,7 @@ cooldowns and the available balance) and get the info if an account is on any al
   of a transfer or credential deployment
 * `PUT /v0/submitCredential`: deploy a credential/create an account
 * `PUT /v0/submitTransfer`: perform a simple transfer
+* `PUT /v0/submitExtended`: perform an extended transfer
 * `PUT /v0/submitRawTransaction`: perform a any raw transaction
 * `GET /v0/accTransactions/{account address}`: get the transactions affecting an account's ccd balance
 * `GET /v1/accTransactions/{account address}`: get the transactions affecting an account's ccd balance (including CCD transactions with memos)
@@ -586,6 +587,32 @@ The data that should be sent is as the one returned from the library provided as
 After submission of the transaction the responses are the same as for the submission of the credential. If successful
 a submission id is returned, which can be used to query the status of the transfer via the `/v0/submissionStatus` endpoint.
 
+## Submit extended transfer
+
+When submitting an extended transfer (e.g. when the transaction is sponsored)
+you should make a PUT request to `/v0/submitExtended` endpoint. The JSON encoded
+transaction has the form:
+
+```json
+{
+  "signatures": {
+    "sender": {
+      "0" : {
+        "0": "6f17c110965054b262ef0d6dee02f77dccb7bd031c2af324b544f5ee3e6e18b3fd1be8a95782e92a89dd40a1b69cad8a37e8b86fc9107c8528d8267212cf030b"
+      }
+    }
+    "sponsor": {
+      "0" : {
+        "0": "6f17c110965054b262ef0d6dee02f77dccb7bd031c2af324b544f5ee3e6e18b3fd1be8a95782e92a89dd40a1b69cad8a37e8b86fc9107c8528d8267212cf030b"
+      }
+      
+    }
+  },
+  "transaction": "<base 16 encoded extended transaction>"
+```
+
+If the submission was successful, a submission id is returned, which can be used to query the status
+of the transfer via the `/v0/submissionStatus` endpoint.
 
 ## Submit raw transaction
 
@@ -630,6 +657,9 @@ They support the following parameters.
   - `y`: only include shield, unshield, and transfer shielded transactions.
 - `includeRawRejectReason`: whether to include the raw rejection reason (the
   same JSON as returned by `GetTransactionStatus` gRPC endpoint).
+- `includeSponsoredTransactions`: whether to include sponsored transactions.
+  - `y`: include all sponsored transactions (The default).
+  - `n`: exclude sponsored transactions.
 
 The result is a JSON object with the following fields:
 - `order`: either `"ascending"` or `"descending"` indicating the ordering applied to the transactions.
@@ -788,6 +818,13 @@ It consists of the following fields:
 - The following field is present if the transaction is a register data transaction:
   - `registeredData`: hex encoding of the data that was registered
 
+#### `sponsor` (optional)
+A JSON object containing details about the sponsor of a transaction.
+It consists of the following fields:
+
+- `sponsor`: The account address of the sponsor.
+- `cost`: The transaction cost paid for by the sponsor.
+
 For the purposes of the above, a simple transfer is a transaction of type `"transfer"` which transfers funds from one account to another.
 A transactions of type `"transfer"` is not considered a simple transfer if the destination is a smart contract instance.
 ### Example
@@ -806,6 +843,10 @@ $ curl -XGET http://localhost:3000/v0/accTransactions/4KYJHs49FX7tPD2pFY2whbfZ8A
       },
       "energy": 59,
       "cost": 59,
+      "sponsor": {
+        "sponsor": "4KYJHs49FX7tPD2pFY2whbfZ8AjupEtX8yNSLwWMFQFUZgRobL",
+        "cost": 59
+      },
       "subtotal": 0,
       "transactionHash": "84bf1e2ef8d3af3063cdb681932990f71ddb3949655f55307a266e5d687b414f",
       "blockHash": "013c6d2dd67affd6f39b9a7b255d244055b53d68fe8b0add4839a20e911d04cb",

deps/concordium-client

@@ -26,8 +26,8 @@ instance Internationalizable TransactionSummaryType where
     i18n i (TSTCredentialDeploymentTransaction t) = i18nDeployCredential i t
     i18n i (TSTUpdateTransaction t) = i18nUpdateTransaction i t
 
-instance Internationalizable Event where
-    i18n = i18nEvent
+instance Internationalizable SupplementedEvent where
+    i18n = i18nSupplementedEvent
 
 instance Internationalizable SpecialTransactionOutcome where
     i18n = i18nSpecialEvent

src/Internationalization.hs

@@ -47,7 +47,7 @@ data I18n = I18n
       i18nTransactionType :: TransactionType -> Text,
       i18nMalformedTransaction :: Text,
       i18nDeployCredential :: CredentialType -> Text,
-      i18nEvent :: Event -> Text,
+      i18nSupplementedEvent :: SupplementedEvent -> Text,
       i18nUpdateTransaction :: UpdateType -> Text,
       i18nSpecialEvent :: SpecialTransactionOutcome -> Text,
       i18nSpecialOutcomeShort :: SpecialTransactionOutcome -> Text,

src/Internationalization/Base.hs

@@ -125,8 +125,8 @@ translation = I18n{..}
     i18nDeployCredential Initial = "Deploy initial account credential"
     i18nDeployCredential Normal = "Deploy account credential"
 
-    i18nEvent (ModuleDeployed mref) = "Deployed module " <> descrModule mref
-    i18nEvent ContractInitialized{..} =
+    i18nSupplementedEvent (ModuleDeployed mref) = "Deployed module " <> descrModule mref
+    i18nSupplementedEvent ContractInitialized{..} =
         "Initialized smart contract "
             <> initContractName ecInitName
             <> " at address "
@@ -136,7 +136,7 @@ translation = I18n{..}
             <> ". "
             <> Text.pack (show (length ecEvents))
             <> " events were logged"
-    i18nEvent Updated{..} =
+    i18nSupplementedEvent Updated{..} =
         let (cname, fname) = contractAndFunctionName euReceiveName
         in  "Invoked smart contract: source="
                 <> descrAddress euInstigator
@@ -150,53 +150,53 @@ translation = I18n{..}
                 <> descrAmount euAmount
                 <> ", message="
                 <> Text.pack (show euMessage)
-    i18nEvent (Transferred sender amt recv) = "Transferred " <> descrAmount amt <> " from " <> descrAddress sender <> " to " <> descrAddress recv
-    i18nEvent (AccountCreated addr) = "Created account with address " <> descrAccount addr
-    i18nEvent (CredentialDeployed _ addr) = "Deployed a credential to account " <> descrAccount addr
-    i18nEvent BakerAdded{..} = "Added validator " <> descrBaker ebaBakerId ebaAccount <> " and initial stake " <> descrAmount ebaStake
-    i18nEvent BakerRemoved{..} = "Removed validator " <> descrBaker ebrBakerId ebrAccount
-    i18nEvent BakerStakeIncreased{..} = "Stake of validator " <> descrBaker ebsiBakerId ebsiAccount <> " increased to " <> descrAmount ebsiNewStake
-    i18nEvent BakerStakeDecreased{..} = "Stake of validator " <> descrBaker ebsiBakerId ebsiAccount <> " decreased to " <> descrAmount ebsiNewStake
-    i18nEvent BakerSetRestakeEarnings{..} = "Validator " <> descrBaker ebsreBakerId ebsreAccount <> if ebsreRestakeEarnings then " set to restake earnings." else " unset restaking of earnings."
-    i18nEvent BakerKeysUpdated{..} = "Validator " <> descrBaker ebkuBakerId ebkuAccount <> " keys updated."
-    i18nEvent CredentialKeysUpdated{..} = "Updated keys of credential with ID " <> Text.pack (show ckuCredId)
-    i18nEvent NewEncryptedAmount{..} = "New encrypted amount added to account " <> descrAccount neaAccount
-    i18nEvent EncryptedAmountsRemoved{..} = "Consumed encrypted amounts on account " <> descrAccount earAccount
-    i18nEvent EncryptedSelfAmountAdded{..} = "Updated shielded balance of account " <> descrAccount eaaAccount
-    i18nEvent AmountAddedByDecryption{..} = "Unshielded " <> descrAmount aabdAmount <> " on account " <> descrAccount aabdAccount
-    i18nEvent UpdateEnqueued{} = "Chain update event enqueued."
-    i18nEvent TransferredWithSchedule{..} = "Transferred with schedule from " <> descrAccount etwsFrom <> " to " <> descrAccount etwsTo
-    i18nEvent CredentialsUpdated{..} = "Credentials on account " <> descrAccount cuAccount <> " updated."
-    i18nEvent DataRegistered{} = "Data registered on the chain."
-    i18nEvent TransferMemo{..} = "Memo '" <> Text.pack (show tmMemo) <> "' included in a transfer." -- TODO: This would ideally try to render the Memo in a readable way, if it is a valid string or integer, say.
-    i18nEvent Interrupted{..} = "Execution of " <> descrInstance iAddress <> " triggered an operation."
-    i18nEvent Resumed{..} | rSuccess = "Operation succeeded and execution of " <> descrInstance rAddress <> " resumed."
-    i18nEvent Resumed{..} | otherwise = "Operation failed and execution of " <> descrInstance rAddress <> " resumed."
-    i18nEvent Upgraded{..} = "Smart contract instance at " <> descrInstance euAddress <> " was upgraded from " <> descrModule euFrom <> " to " <> descrModule euTo <> "."
-    i18nEvent BakerSetOpenStatus{..} = "Open status of validator " <> descrBaker ebsosBakerId ebsosAccount <> " set to " <> descrOpenStatus ebsosOpenStatus
-    i18nEvent BakerSetMetadataURL{..} = "Metadata URL of validator " <> descrBaker ebsmuBakerId ebsmuAccount <> " set to " <> descrMetadataURL ebsmuMetadataURL
-    i18nEvent BakerSetTransactionFeeCommission{..} = "Transaction fee commission of validator " <> descrBaker ebstfcBakerId ebstfcAccount <> " set to " <> descrAmountFraction ebstfcTransactionFeeCommission
-    i18nEvent BakerSetBakingRewardCommission{..} = "Block reward commission of validator " <> descrBaker ebsbrcBakerId ebsbrcAccount <> " set to " <> descrAmountFraction ebsbrcBakingRewardCommission
-    i18nEvent BakerSetFinalizationRewardCommission{..} = "Finalization reward commission of validator " <> descrBaker ebsfrcBakerId ebsfrcAccount <> " set to " <> descrAmountFraction ebsfrcFinalizationRewardCommission
-    i18nEvent DelegationStakeIncreased{..} = "Stake of delegator " <> descrDelegator edsiDelegatorId edsiAccount <> " increased to " <> descrAmount edsiNewStake
-    i18nEvent DelegationStakeDecreased{..} = "Stake of delegator " <> descrDelegator edsdDelegatorId edsdAccount <> " decreased to " <> descrAmount edsdNewStake
-    i18nEvent DelegationSetRestakeEarnings{..} = "Delegator " <> descrDelegator edsreDelegatorId edsreAccount <> if edsreRestakeEarnings then " set to restake earnings." else " unset restaking of earnings."
-    i18nEvent DelegationSetDelegationTarget{..} =
+    i18nSupplementedEvent (Transferred sender amt recv) = "Transferred " <> descrAmount amt <> " from " <> descrAddress sender <> " to " <> descrAddress recv
+    i18nSupplementedEvent (AccountCreated addr) = "Created account with address " <> descrAccount addr
+    i18nSupplementedEvent (CredentialDeployed _ addr) = "Deployed a credential to account " <> descrAccount addr
+    i18nSupplementedEvent BakerAdded{..} = "Added validator " <> descrBaker ebaBakerId ebaAccount <> " and initial stake " <> descrAmount ebaStake
+    i18nSupplementedEvent BakerRemoved{..} = "Removed validator " <> descrBaker ebrBakerId ebrAccount
+    i18nSupplementedEvent BakerStakeIncreased{..} = "Stake of validator " <> descrBaker ebsiBakerId ebsiAccount <> " increased to " <> descrAmount ebsiNewStake
+    i18nSupplementedEvent BakerStakeDecreased{..} = "Stake of validator " <> descrBaker ebsiBakerId ebsiAccount <> " decreased to " <> descrAmount ebsiNewStake
+    i18nSupplementedEvent BakerSetRestakeEarnings{..} = "Validator " <> descrBaker ebsreBakerId ebsreAccount <> if ebsreRestakeEarnings then " set to restake earnings." else " unset restaking of earnings."
+    i18nSupplementedEvent BakerKeysUpdated{..} = "Validator " <> descrBaker ebkuBakerId ebkuAccount <> " keys updated."
+    i18nSupplementedEvent CredentialKeysUpdated{..} = "Updated keys of credential with ID " <> Text.pack (show ckuCredId)
+    i18nSupplementedEvent NewEncryptedAmount{..} = "New encrypted amount added to account " <> descrAccount neaAccount
+    i18nSupplementedEvent EncryptedAmountsRemoved{..} = "Consumed encrypted amounts on account " <> descrAccount earAccount
+    i18nSupplementedEvent EncryptedSelfAmountAdded{..} = "Updated shielded balance of account " <> descrAccount eaaAccount
+    i18nSupplementedEvent AmountAddedByDecryption{..} = "Unshielded " <> descrAmount aabdAmount <> " on account " <> descrAccount aabdAccount
+    i18nSupplementedEvent UpdateEnqueued{} = "Chain update event enqueued."
+    i18nSupplementedEvent TransferredWithSchedule{..} = "Transferred with schedule from " <> descrAccount etwsFrom <> " to " <> descrAccount etwsTo
+    i18nSupplementedEvent CredentialsUpdated{..} = "Credentials on account " <> descrAccount cuAccount <> " updated."
+    i18nSupplementedEvent DataRegistered{} = "Data registered on the chain."
+    i18nSupplementedEvent TransferMemo{..} = "Memo '" <> Text.pack (show tmMemo) <> "' included in a transfer." -- TODO: This would ideally try to render the Memo in a readable way, if it is a valid string or integer, say.
+    i18nSupplementedEvent Interrupted{..} = "Execution of " <> descrInstance iAddress <> " triggered an operation."
+    i18nSupplementedEvent Resumed{..} | rSuccess = "Operation succeeded and execution of " <> descrInstance rAddress <> " resumed."
+    i18nSupplementedEvent Resumed{..} | otherwise = "Operation failed and execution of " <> descrInstance rAddress <> " resumed."
+    i18nSupplementedEvent Upgraded{..} = "Smart contract instance at " <> descrInstance euAddress <> " was upgraded from " <> descrModule euFrom <> " to " <> descrModule euTo <> "."
+    i18nSupplementedEvent BakerSetOpenStatus{..} = "Open status of validator " <> descrBaker ebsosBakerId ebsosAccount <> " set to " <> descrOpenStatus ebsosOpenStatus
+    i18nSupplementedEvent BakerSetMetadataURL{..} = "Metadata URL of validator " <> descrBaker ebsmuBakerId ebsmuAccount <> " set to " <> descrMetadataURL ebsmuMetadataURL
+    i18nSupplementedEvent BakerSetTransactionFeeCommission{..} = "Transaction fee commission of validator " <> descrBaker ebstfcBakerId ebstfcAccount <> " set to " <> descrAmountFraction ebstfcTransactionFeeCommission
+    i18nSupplementedEvent BakerSetBakingRewardCommission{..} = "Block reward commission of validator " <> descrBaker ebsbrcBakerId ebsbrcAccount <> " set to " <> descrAmountFraction ebsbrcBakingRewardCommission
+    i18nSupplementedEvent BakerSetFinalizationRewardCommission{..} = "Finalization reward commission of validator " <> descrBaker ebsfrcBakerId ebsfrcAccount <> " set to " <> descrAmountFraction ebsfrcFinalizationRewardCommission
+    i18nSupplementedEvent DelegationStakeIncreased{..} = "Stake of delegator " <> descrDelegator edsiDelegatorId edsiAccount <> " increased to " <> descrAmount edsiNewStake
+    i18nSupplementedEvent DelegationStakeDecreased{..} = "Stake of delegator " <> descrDelegator edsdDelegatorId edsdAccount <> " decreased to " <> descrAmount edsdNewStake
+    i18nSupplementedEvent DelegationSetRestakeEarnings{..} = "Delegator " <> descrDelegator edsreDelegatorId edsreAccount <> if edsreRestakeEarnings then " set to restake earnings." else " unset restaking of earnings."
+    i18nSupplementedEvent DelegationSetDelegationTarget{..} =
         "Delegator "
             <> descrDelegator edsdtDelegatorId edsdtAccount
             <> " set delegation target to "
             <> case edsdtDelegationTarget of
                 DelegatePassive -> "passive delegation"
                 DelegateToBaker bid -> "staking pool " <> Text.pack (show bid)
-    i18nEvent DelegationAdded{..} = "Added delegator " <> descrDelegator edaDelegatorId edaAccount
-    i18nEvent DelegationRemoved{..} = "Removed delegator " <> descrDelegator edrDelegatorId edrAccount
-    i18nEvent BakerSuspended{..} = "Validator " <> descrBaker ebsBakerId ebsAccount <> " was suspended."
-    i18nEvent BakerResumed{..} = "Validator " <> descrBaker ebrBakerId ebrAccount <> " was resumed."
-    i18nEvent (TokenModuleEvent tokenId type' _) = Text.pack (show tokenId) <> " token module event occurred of type " <> Text.pack (show type') <> "." -- TODO: It would be ideally to render the `details` in a readable way in the wallets.
-    i18nEvent (TokenTransfer tokenId from to amount memo) = Text.pack (tokenAmountToString amount) <> " " <> Text.pack (show tokenId) <> " transferred from " <> Text.pack (show from) <> " to " <> Text.pack (show to) <> maybe "" (\m -> " with memo " <> Text.pack (show m)) memo <> "." -- TODO: It would be ideally to render the `memo` in a readable way in the wallets.
-    i18nEvent TokenMint{..} = Text.pack (tokenAmountToString etmAmount) <> " " <> Text.pack (show etmTokenId) <> " minted to " <> Text.pack (show etmTarget) <> "."
-    i18nEvent TokenBurn{..} = Text.pack (tokenAmountToString etbAmount) <> " " <> Text.pack (show etbTokenId) <> " burned from " <> Text.pack (show etbTarget) <> "."
-    i18nEvent TokenCreated{..} = "Token created: " <> Text.pack (showPrettyJSON etcPayload)
+    i18nSupplementedEvent DelegationAdded{..} = "Added delegator " <> descrDelegator edaDelegatorId edaAccount
+    i18nSupplementedEvent DelegationRemoved{..} = "Removed delegator " <> descrDelegator edrDelegatorId edrAccount
+    i18nSupplementedEvent BakerSuspended{..} = "Validator " <> descrBaker ebsBakerId ebsAccount <> " was suspended."
+    i18nSupplementedEvent BakerResumed{..} = "Validator " <> descrBaker ebrBakerId ebrAccount <> " was resumed."
+    i18nSupplementedEvent (TokenModuleEvent tokenId type' _) = Text.pack (show tokenId) <> " token module event occurred of type " <> Text.pack (show type') <> "." -- TODO: It would be ideally to render the `details` in a readable way in the wallets.
+    i18nSupplementedEvent (TokenTransfer tokenId from to amount memo) = Text.pack (tokenAmountToString amount) <> " " <> Text.pack (show tokenId) <> " transferred from " <> Text.pack (show from) <> " to " <> Text.pack (show to) <> maybe "" (\m -> " with memo " <> Text.pack (show m)) memo <> "." -- TODO: It would be ideally to render the `memo` in a readable way in the wallets.
+    i18nSupplementedEvent TokenMint{..} = Text.pack (tokenAmountToString etmAmount) <> " " <> Text.pack (show etmTokenId) <> " minted to " <> Text.pack (show etmTarget) <> "."
+    i18nSupplementedEvent TokenBurn{..} = Text.pack (tokenAmountToString etbAmount) <> " " <> Text.pack (show etbTokenId) <> " burned from " <> Text.pack (show etbTarget) <> "."
+    i18nSupplementedEvent TokenCreated{..} = "Token created: " <> Text.pack (showPrettyJSON etcPayload)
     i18nSpecialEvent BakingRewards{..} =
         "Block rewards\n"
             <> Text.unlines (map (\(addr, amnt) -> "  - account " <> descrAccount addr <> " awarded " <> descrAmount amnt) . Map.toAscList . accountAmounts $ stoBakerRewards)