Added cardano connector plugin #1636
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1636 +/- ##
========================================
Coverage 99.95% 99.96%
========================================
Files 339 342 +3
Lines 29782 30457 +675
========================================
+ Hits 29770 30445 +675
Misses 8 8
Partials 4 4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
EnriqueL8
reviewed
Feb 11, 2025
| Address string `json:"address"` | ||
| } | ||
|
|
||
| var addressVerify = regexp.MustCompile("^addr1|^addr_test1|^stake1|^stake_test1") |
There was a problem hiding this comment.
This is just used for (extremely simple) address validation. Cardano uses bech32 addresses with a conventional set of HRPs, but I wanted to avoid pulling in a bech32 decoder, so I allowlisted the conventional HRPs instead.
Comment on lines
390
to
393
| func (c *Cardano) GenerateErrorSignature(ctx context.Context, event *fftypes.FFIErrorDefinition) string { | ||
| // TODO: impl | ||
| return "" | ||
| } |
There was a problem hiding this comment.
Would be interested to understand more how errors are reported in Cardano from smart contract
There was a problem hiding this comment.
The cardano smart contract doesn't report errors right now, only events. I don't understand the difference between errors and events, and I couldn't find any code in other plugins which streamed errors from the connector.
I've copied the "event signature" code into this function, but that's just a guess at what it's supposed to do. I'd want to see how consumers actually use events to be more confident about that.
Comment on lines
542
to
550
| if !isBatch { | ||
| var receipt common.BlockchainReceiptNotification | ||
| _ = json.Unmarshal(msgBytes, &receipt) | ||
|
|
||
| err := common.HandleReceipt(ctx, "", c, &receipt, c.callbacks) | ||
| if err != nil { | ||
| l.Errorf("Failed to process receipt: %+v", msgTyped) | ||
| } | ||
| } |
There was a problem hiding this comment.
I see that this is heavily inspired from FFTM and the evm plugin - I would recommend in the future moving to a durable event stream here where the receipts have to be ack'd back as part of a batch.
There was a problem hiding this comment.
I was using EVM, Tezos, and FFTM as references for how the eventstream is supposed to work (trying my best to make Cardano match the semantics of other connectors). It looked like other connectors assume that every message in a batch is an event, not a receipt.
I think it makes sense to use resilient ack-ing for everything, but I'm a little wary about inventing semantics for it in this plugin that nothing else is using.
There was a problem hiding this comment.
Agreed - probably as a follow up. I'm building a framework at moment to allow for resilient ack-ing and get confirmation from FireFly core it has processed things correctly
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
EnriqueL8
reviewed
Mar 12, 2025
Comment on lines
564
to
582
| switch msgJSON.GetString("type") { | ||
| case "ContractEvent": | ||
| signature := msgJSON.GetString("signature") | ||
|
|
||
| logger := log.L(ctx) | ||
| logger.Infof("[%d:%d/%d]: '%s'", batchID, i+1, count, signature) | ||
| logger.Tracef("Message: %+v", msgJSON) | ||
| c.processContractEvent(ctx, namespace, events, msgJSON) | ||
| case "Receipt": | ||
| var receipt common.BlockchainReceiptNotification | ||
| msgBytes, _ := json.Marshal(msgMap) | ||
| _ = json.Unmarshal(msgBytes, &receipt) | ||
|
|
||
| err := common.HandleReceipt(ctx, namespace, c, &receipt, c.callbacks) | ||
| if err != nil { | ||
| log.L(ctx).Errorf("Failed to process receipt: %+v", msgMap) | ||
| } | ||
| default: | ||
| log.L(ctx).Errorf("Unexpected message in batch: %+v", msgMap) |
There was a problem hiding this comment.
This is awesome, thanks!
|
Error from build - FYI @onelapahead I believe you added recently this DX callback. Feels like a race condition as sometimes fails and others passes |
9 tasks
|
Alright fixed above #1658 |
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
EnriqueL8
reviewed
Mar 13, 2025
There was a problem hiding this comment.
Was reminded yesterday of the key being mandatory today as part of deploying a contract and it doesn't make sense for Cardano as the connector has used that API to run a off-chain dApp that is responsible of building Cardano TX and indexing state. Raised a discussion on Discord https://discord.com/channels/905194001349627914/928377875827154984/1349704667524763689
|
|
||
| ## Create the stack | ||
|
|
||
| A Cardano stack can be run in two different ways; with a firefly |
There was a problem hiding this comment.
Suggested change
| A Cardano stack can be run in two different ways; with a firefly | |
| A Cardano stack can be run in two different ways with Hyperledger FireFly |
|
|
||
| > **NOTE**: The cardano-node communicates over a Unix socket, so this will not work on Windows. | ||
|
|
||
| Start a local cardano node. The fastest way to do this is to [use mithril](https://mithril.network/doc/manual/getting-started/bootstrap-cardano-node/) to bootstrap the node. |
There was a problem hiding this comment.
Suggested change
| Start a local cardano node. The fastest way to do this is to [use mithril](https://mithril.network/doc/manual/getting-started/bootstrap-cardano-node/) to bootstrap the node. | |
| Start a local Cardano node. The fastest way to do this is to [use mithril](https://mithril.network/doc/manual/getting-started/bootstrap-cardano-node/) to bootstrap the node. |
Comment on lines
+73
to
+90
| ## Get some ADA | ||
|
|
||
| Now that you have a stack, you need some seed funds to get started. Your stack was created with a wallet already (these are free to create in Cardano). To get the address, you can run | ||
| ```sh | ||
| ff accounts list dev | ||
| ``` | ||
|
|
||
| The response will look like | ||
| ```json | ||
| [ | ||
| { | ||
| "address": "addr_test1...", | ||
| "privateKey": "..." | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| If you're developing against a testnet such as preview, you can receive funds from the [testnet faucet](https://docs.cardano.org/cardano-testnets/tools/faucet). Pass the `address` from that response to the faucet. |
There was a problem hiding this comment.
Would recommend following this a Transaction either in this section or working with smart contracts section. I do see a gap of how do you create a simple transfer of ADA through the API
|
Sorry I tagged a comment in a linked PR as |
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
|
Timeout error in a Cardano unit test |
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Signed-off-by: Simon Gellis <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Adds a cardano connector plugin to firefly core. This connector interacts with the firefly-cardanoconnect service from firefly-cardano.
Types of changes
Please make sure to follow these points
< issue name >egAdded links in the documentation.Other Information
The Cardano connector and implementation is still a work in progress; in particular we need documentation and tests. However, it works well enough to demo, and I'd like to merge this relatively soon so that people can run it without building firefly-core from a branch, or downloading an image from a private repo.