You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|name|The name of the configured Blockchain plugin|`string`|`<nil>`
637
637
|type|The type of the configured Blockchain Connector plugin|`string`|`<nil>`
638
638
639
+
## plugins.blockchain[].cardano.cardanoconnect
640
+
641
+
|Key|Description|Type|Default Value|
642
+
|---|-----------|----|-------------|
643
+
|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`
644
+
|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`
645
+
|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`
646
+
|expectContinueTimeout|See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport)|[`time.Duration`](https://pkg.go.dev/time#Duration)|`1s`
647
+
|headers|Adds custom headers to HTTP requests|`map[string]string`|`<nil>`
648
+
|idleTimeout|The max duration to hold a HTTP keepalive connection between calls|[`time.Duration`](https://pkg.go.dev/time#Duration)|`475ms`
649
+
|maxConnsPerHost|The max number of connections, per unique hostname. Zero means no limit|`int`|`0`
650
+
|maxIdleConns|The max number of idle connections to hold pooled|`int`|`100`
651
+
|maxIdleConnsPerHost|The max number of idle connections, per unique hostname. Zero means net/http uses the default of only 2.|`int`|`100`
652
+
|passthroughHeadersEnabled|Enable passing through the set of allowed HTTP request headers|`boolean`|`false`
653
+
|requestTimeout|The maximum amount of time that a request is allowed to remain open|[`time.Duration`](https://pkg.go.dev/time#Duration)|`30s`
654
+
|tlsHandshakeTimeout|The maximum amount of time to wait for a successful TLS handshake|[`time.Duration`](https://pkg.go.dev/time#Duration)|`10s`
655
+
|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>`
656
+
|url|The URL of the Cardanoconnect instance|URL `string`|`<nil>`
|ca|The TLS certificate authority in PEM format (this option is ignored if caFile is also set)|`string`|`<nil>`
693
+
|caFile|The path to the CA file for TLS on this API|`string`|`<nil>`
694
+
|cert|The TLS certificate in PEM format (this option is ignored if certFile is also set)|`string`|`<nil>`
695
+
|certFile|The path to the certificate file for TLS on this API|`string`|`<nil>`
696
+
|clientAuth|Enables or disables client auth for TLS on this API|`string`|`<nil>`
697
+
|enabled|Enables or disables TLS on this API|`boolean`|`false`
698
+
|insecureSkipHostVerify|When to true in unit test development environments to disable TLS verification. Use with extreme caution|`boolean`|`<nil>`
699
+
|key|The TLS certificate key in PEM format (this option is ignored if keyFile is also set)|`string`|`<nil>`
700
+
|keyFile|The path to the private key file for TLS on this API|`string`|`<nil>`
701
+
|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>`
702
+
703
+
## plugins.blockchain[].cardano.cardanoconnect.ws
704
+
705
+
|Key|Description|Type|Default Value|
706
+
|---|-----------|----|-------------|
707
+
|connectionTimeout|The amount of time to wait while establishing a connection (or auto-reconnection)|[`time.Duration`](https://pkg.go.dev/time#Duration)|`45s`
708
+
|heartbeatInterval|The amount of time to wait between heartbeat signals on the WebSocket connection|[`time.Duration`](https://pkg.go.dev/time#Duration)|`30s`
709
+
|initialConnectAttempts|The number of attempts FireFly will make to connect to the WebSocket when starting up, before failing|`int`|`5`
710
+
|path|The WebSocket sever URL to which FireFly should connect|WebSocket URL `string`|`<nil>`
711
+
|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`
712
+
|url|URL to use for WebSocket - overrides url one level up (in the HTTP config)|`string`|`<nil>`
713
+
|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`
Copy file name to clipboardExpand all lines: doc-site/docs/reference/types/verifier.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ title: Verifier
22
22
|`hash`| Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network |`Bytes32`|
23
23
|`identity`| The UUID of the parent identity that has claimed this verifier |[`UUID`](simpletypes.md#uuid)|
24
24
|`namespace`| The namespace of the verifier |`string`|
25
-
|`type`| The type of the verifier |`FFEnum`:<br/>`"ethereum_address"`<br/>`"tezos_address"`<br/>`"fabric_msp_id"`<br/>`"dx_peer_id"`|
25
+
|`type`| The type of the verifier |`FFEnum`:<br/>`"cardano_address"`<br/>`"ethereum_address"`<br/>`"tezos_address"`<br/>`"fabric_msp_id"`<br/>`"dx_peer_id"`|
26
26
|`value`| The verifier string, such as an Ethereum address, or Fabric MSP identifier |`string`|
27
27
|`created`| The time this verifier was created on this node |[`FFTime`](simpletypes.md#fftime)|
This guide will walk you through the steps to create a local FireFly development environment running against the preview node.
6
+
7
+
## Previous steps: Install the FireFly CLI
8
+
9
+
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).
10
+
11
+
[← ① Install the FireFly CLI](../../gettingstarted/firefly_cli.md){: .md-button .md-button--primary}
12
+
13
+
## Create the stack
14
+
15
+
A Cardano stack can be run in two different ways; using a local Cardano node, or a remote Blockfrost address.
16
+
17
+
### Option 1: Use a local Cardano node
18
+
19
+
> **NOTE**: The cardano-node communicates over a Unix socket, so this will not work on Windows.
20
+
21
+
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.
22
+
23
+
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).
24
+
25
+
The cardano-node exposes a Unix socket named `node.socket`. Pass that to firefly-cli. The example below uses `firefly-cli` to
26
+
- Create a new Cardano-based stack named `dev`.
27
+
- Connect to the local Cardano node, which is running in the [preview network](https://preview.cexplorer.io/).
28
+
29
+
```sh
30
+
ff init cardano dev \
31
+
--network preview \
32
+
--socket /path/to/ipc/node.socket
33
+
```
34
+
35
+
### Option 2: Use Blockfrost
36
+
37
+
The Cardano connector can also use the [paid Blockfrost API](https://blockfrost.io/) in place of a local Cardano node.
38
+
39
+
The example below uses firefly-cli to
40
+
- Create a new Cardano-based stack named `dev`
41
+
- Use the given blockfrost key for the preview network.
Now you should be able to start your stack by running:
52
+
53
+
```sh
54
+
ff start dev
55
+
```
56
+
57
+
After some time it should print out the following:
58
+
59
+
```
60
+
Web UI for member '0': http://127.0.0.1:5000/ui
61
+
Sandbox UI for member '0': http://127.0.0.1:5109
62
+
63
+
64
+
To see logs for your stack run:
65
+
66
+
ff logs dev
67
+
```
68
+
69
+
## Get some ADA
70
+
71
+
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
72
+
```sh
73
+
ff accounts list dev
74
+
```
75
+
76
+
The response will look like
77
+
```json
78
+
[
79
+
{
80
+
"address": "addr_test1...",
81
+
"privateKey": "..."
82
+
}
83
+
]
84
+
```
85
+
86
+
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.
0 commit comments