Added cardano connector plugin

doc-site/docs/reference/config.md

@@ -636,6 +636,82 @@ title: Configuration Reference
 |name|The name of the configured Blockchain plugin|`string`|`<nil>`
 |type|The type of the configured Blockchain Connector plugin|`string`|`<nil>`
 
+## plugins.blockchain[].cardano.cardanoconnect
+
+|Key|Description|Type|Default Value|
+|---|-----------|----|-------------|
+|batchSize|The number of events Cardanoconnect should batch together for delivery to FireFly core. Only applies when automatically creating a new event stream|`int`|`50`
+|batchTimeout|How long Cardanoconnect should wait for new events to arrive and fill a batch, before sending the batch to FireFly core. Only applies when automatically creating a new event stream|[`time.Duration`](https://pkg.go.dev/time#Duration)|`500`
+|connectionTimeout|The maximum amount of time that a connection is allowed to remain with no data transmitted|[`time.Duration`](https://pkg.go.dev/time#Duration)|`30s`
+|expectContinueTimeout|See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport)|[`time.Duration`](https://pkg.go.dev/time#Duration)|`1s`
+|headers|Adds custom headers to HTTP requests|`map[string]string`|`<nil>`
+|idleTimeout|The max duration to hold a HTTP keepalive connection between calls|[`time.Duration`](https://pkg.go.dev/time#Duration)|`475ms`
+|maxConnsPerHost|The max number of connections, per unique hostname. Zero means no limit|`int`|`0`
+|maxIdleConns|The max number of idle connections to hold pooled|`int`|`100`
+|maxIdleConnsPerHost|The max number of idle connections, per unique hostname. Zero means net/http uses the default of only 2.|`int`|`100`
+|passthroughHeadersEnabled|Enable passing through the set of allowed HTTP request headers|`boolean`|`false`
+|requestTimeout|The maximum amount of time that a request is allowed to remain open|[`time.Duration`](https://pkg.go.dev/time#Duration)|`30s`
+|tlsHandshakeTimeout|The maximum amount of time to wait for a successful TLS handshake|[`time.Duration`](https://pkg.go.dev/time#Duration)|`10s`
+|topic|The websocket listen topic that the node should register on, which is important if there are multiple nodes using a single cardanoconnect|`string`|`<nil>`
+|url|The URL of the Cardanoconnect instance|URL `string`|`<nil>`
+
+## plugins.blockchain[].cardano.cardanoconnect.auth
+
+|Key|Description|Type|Default Value|
+|---|-----------|----|-------------|
+|password|Password|`string`|`<nil>`
+|username|Username|`string`|`<nil>`
+
+## plugins.blockchain[].cardano.cardanoconnect.proxy
+
+|Key|Description|Type|Default Value|
+|---|-----------|----|-------------|
+|url|Optional HTTP proxy server to connect through|`string`|`<nil>`
+
+## plugins.blockchain[].cardano.cardanoconnect.retry
+
+|Key|Description|Type|Default Value|
+|---|-----------|----|-------------|
+|count|The maximum number of times to retry|`int`|`5`
+|enabled|Enables retries|`boolean`|`false`
+|errorStatusCodeRegex|The regex that the error response status code must match to trigger retry|`string`|`<nil>`
+|initWaitTime|The initial retry delay|[`time.Duration`](https://pkg.go.dev/time#Duration)|`250ms`
+|maxWaitTime|The maximum retry delay|[`time.Duration`](https://pkg.go.dev/time#Duration)|`30s`
+
+## plugins.blockchain[].cardano.cardanoconnect.throttle
+
+|Key|Description|Type|Default Value|
+|---|-----------|----|-------------|
+|burst|The maximum number of requests that can be made in a short period of time before the throttling kicks in.|`int`|`<nil>`
+|requestsPerSecond|The average rate at which requests are allowed to pass through over time.|`int`|`<nil>`
+
+## plugins.blockchain[].cardano.cardanoconnect.tls
+
+|Key|Description|Type|Default Value|
+|---|-----------|----|-------------|
+|ca|The TLS certificate authority in PEM format (this option is ignored if caFile is also set)|`string`|`<nil>`
+|caFile|The path to the CA file for TLS on this API|`string`|`<nil>`
+|cert|The TLS certificate in PEM format (this option is ignored if certFile is also set)|`string`|`<nil>`
+|certFile|The path to the certificate file for TLS on this API|`string`|`<nil>`
+|clientAuth|Enables or disables client auth for TLS on this API|`string`|`<nil>`
+|enabled|Enables or disables TLS on this API|`boolean`|`false`
+|insecureSkipHostVerify|When to true in unit test development environments to disable TLS verification. Use with extreme caution|`boolean`|`<nil>`
+|key|The TLS certificate key in PEM format (this option is ignored if keyFile is also set)|`string`|`<nil>`
+|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
+|requiredDNAttributes|A set of required subject DN attributes. Each entry is a regular expression, and the subject certificate must have a matching attribute of the specified type (CN, C, O, OU, ST, L, STREET, POSTALCODE, SERIALNUMBER are valid attributes)|`map[string]string`|`<nil>`
+
+## plugins.blockchain[].cardano.cardanoconnect.ws
+
+|Key|Description|Type|Default Value|
+|---|-----------|----|-------------|
+|connectionTimeout|The amount of time to wait while establishing a connection (or auto-reconnection)|[`time.Duration`](https://pkg.go.dev/time#Duration)|`45s`
+|heartbeatInterval|The amount of time to wait between heartbeat signals on the WebSocket connection|[`time.Duration`](https://pkg.go.dev/time#Duration)|`30s`
+|initialConnectAttempts|The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing|`int`|`5`
+|path|The WebSocket sever URL to which FireFly should connect|WebSocket URL `string`|`<nil>`
+|readBufferSize|The size in bytes of the read buffer for the WebSocket connection|[`BytesSize`](https://pkg.go.dev/github.com/docker/go-units#BytesSize)|`16Kb`
+|url|URL to use for WebSocket - overrides url one level up (in the HTTP config)|`string`|`<nil>`
+|writeBufferSize|The size in bytes of the write buffer for the WebSocket connection|[`BytesSize`](https://pkg.go.dev/github.com/docker/go-units#BytesSize)|`16Kb`
+
 ## plugins.blockchain[].ethereum.addressResolver
 
 |Key|Description|Type|Default Value|

doc-site/docs/reference/types/verifier.md

@@ -22,7 +22,7 @@ title: Verifier
 | `hash` | Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network | `Bytes32` |
 | `identity` | The UUID of the parent identity that has claimed this verifier | [`UUID`](simpletypes.md#uuid) |
 | `namespace` | The namespace of the verifier | `string` |
-| `type` | The type of the verifier | `FFEnum`:<br/>`"ethereum_address"`<br/>`"tezos_address"`<br/>`"fabric_msp_id"`<br/>`"dx_peer_id"` |
+| `type` | The type of the verifier | `FFEnum`:<br/>`"cardano_address"`<br/>`"ethereum_address"`<br/>`"tezos_address"`<br/>`"fabric_msp_id"`<br/>`"dx_peer_id"` |
 | `value` | The verifier string, such as an Ethereum address, or Fabric MSP identifier | `string` |
 | `created` | The time this verifier was created on this node | [`FFTime`](simpletypes.md#fftime) |
 

doc-site/docs/swagger/swagger.yaml

@@ -9396,6 +9396,7 @@ paths:
                           type:
                             description: The type of the verifier
                             enum:
+                            - cardano_address
                             - ethereum_address
                             - tezos_address
                             - fabric_msp_id
@@ -10098,6 +10099,7 @@ paths:
                     type:
                       description: The type of the verifier
                       enum:
+                      - cardano_address
                       - ethereum_address
                       - tezos_address
                       - fabric_msp_id
@@ -22859,6 +22861,7 @@ paths:
                           type:
                             description: The type of the verifier
                             enum:
+                            - cardano_address
                             - ethereum_address
                             - tezos_address
                             - fabric_msp_id
@@ -23596,6 +23599,7 @@ paths:
                     type:
                       description: The type of the verifier
                       enum:
+                      - cardano_address
                       - ethereum_address
                       - tezos_address
                       - fabric_msp_id
@@ -26379,6 +26383,7 @@ paths:
                           type:
                             description: The type of the verifier
                             enum:
+                            - cardano_address
                             - ethereum_address
                             - tezos_address
                             - fabric_msp_id
@@ -26514,6 +26519,7 @@ paths:
                         type:
                           description: The type of the verifier
                           enum:
+                          - cardano_address
                           - ethereum_address
                           - tezos_address
                           - fabric_msp_id
@@ -28617,6 +28623,7 @@ paths:
                             type:
                               description: The type of the verifier
                               enum:
+                              - cardano_address
                               - ethereum_address
                               - tezos_address
                               - fabric_msp_id
@@ -35325,6 +35332,7 @@ paths:
                     type:
                       description: The type of the verifier
                       enum:
+                      - cardano_address
                       - ethereum_address
                       - tezos_address
                       - fabric_msp_id
@@ -35394,6 +35402,7 @@ paths:
                   type:
                     description: The type of the verifier
                     enum:
+                    - cardano_address
                     - ethereum_address
                     - tezos_address
                     - fabric_msp_id
@@ -35436,6 +35445,7 @@ paths:
                 type:
                   description: The type of the verifier
                   enum:
+                  - cardano_address
                   - ethereum_address
                   - tezos_address
                   - fabric_msp_id
@@ -35455,6 +35465,7 @@ paths:
                   type:
                     description: The type of the verifier
                     enum:
+                    - cardano_address
                     - ethereum_address
                     - tezos_address
                     - fabric_msp_id
@@ -35786,6 +35797,7 @@ paths:
                           type:
                             description: The type of the verifier
                             enum:
+                            - cardano_address
                             - ethereum_address
                             - tezos_address
                             - fabric_msp_id
@@ -35914,6 +35926,7 @@ paths:
                         type:
                           description: The type of the verifier
                           enum:
+                          - cardano_address
                           - ethereum_address
                           - tezos_address
                           - fabric_msp_id
@@ -37919,6 +37932,7 @@ paths:
                             type:
                               description: The type of the verifier
                               enum:
+                              - cardano_address
                               - ethereum_address
                               - tezos_address
                               - fabric_msp_id
@@ -44409,6 +44423,7 @@ paths:
                     type:
                       description: The type of the verifier
                       enum:
+                      - cardano_address
                       - ethereum_address
                       - tezos_address
                       - fabric_msp_id
@@ -44471,6 +44486,7 @@ paths:
                   type:
                     description: The type of the verifier
                     enum:
+                    - cardano_address
                     - ethereum_address
                     - tezos_address
                     - fabric_msp_id
@@ -44506,6 +44522,7 @@ paths:
                 type:
                   description: The type of the verifier
                   enum:
+                  - cardano_address
                   - ethereum_address
                   - tezos_address
                   - fabric_msp_id
@@ -44525,6 +44542,7 @@ paths:
                   type:
                     description: The type of the verifier
                     enum:
+                    - cardano_address
                     - ethereum_address
                     - tezos_address
                     - fabric_msp_id

doc-site/docs/tutorials/chains/cardano.md

@@ -0,0 +1,86 @@
+---
+title: Cardano
+---
+
+This guide will walk you through the steps to create a local FireFly development environment running against the preview node.
+
+## Previous steps: Install the FireFly CLI
+
+If you haven't set up the FireFly CLI already, please go back to the Getting Started guide and read the section on how to [Install the FireFly CLI](../../gettingstarted/firefly_cli.md).
+
+[← ① Install the FireFly CLI](../../gettingstarted/firefly_cli.md){: .md-button .md-button--primary}
+
+## Create the stack
+
+A Cardano stack can be run in two different ways; using a local Cardano node, or a remote Blockfrost address.
+
+### Option 1: Use a local Cardano node
+
+> **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.
+
+For an example of how to bootstrap and run the Cardano node in Docker, see [the firefly-cardano repo](https://github.com/hyperledger/firefly-cardano/blob/1be3b08d301d6d6eeb5b79e40cf3dbf66181c3de/infra/docker-compose.node.yaml#L4).
+
+The cardano-node exposes a Unix socket named `node.socket`. Pass that to firefly-cli. The example below uses `firefly-cli` to
+ - Create a new Cardano-based stack named `dev`.
+ - Connect to the local Cardano node, which is running in the [preview network](https://preview.cexplorer.io/).
+
+```sh
+ff init cardano dev \
+    --network preview \
+    --socket /path/to/ipc/node.socket
+```
+
+### Option 2: Use Blockfrost
+
+The Cardano connector can also use the [paid Blockfrost API](https://blockfrost.io/) in place of a local Cardano node.
+
+The example below uses firefly-cli to
+ - Create a new Cardano-based stack named `dev`
+ - Use the given blockfrost key for the preview network.
+
+```sh
+ff init cardano dev \
+    --network preview \
+    --blockfrost-key previewXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+## Start the stack
+
+Now you should be able to start your stack by running:
+
+```sh
+ff start dev
+```
+
+After some time it should print out the following:
+
+```
+Web UI for member '0': http://127.0.0.1:5000/ui
+Sandbox UI for member '0': http://127.0.0.1:5109
+
+
+To see logs for your stack run:
+
+ff logs dev
+```
+
+## 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.