Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/types/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ nav_order: 2
|------------|-------------|------|
| `id` | The UUID assigned to this event by your local FireFly node | [`UUID`](simpletypes#uuid) |
| `sequence` | A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) | `int64` |
| `type` | All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application | `FFEnum`:<br/>`"transaction_submitted"`<br/>`"message_confirmed"`<br/>`"message_rejected"`<br/>`"datatype_confirmed"`<br/>`"identity_confirmed"`<br/>`"identity_updated"`<br/>`"token_pool_confirmed"`<br/>`"token_pool_op_failed"`<br/>`"token_transfer_confirmed"`<br/>`"token_transfer_op_failed"`<br/>`"token_approval_confirmed"`<br/>`"token_approval_op_failed"`<br/>`"contract_interface_confirmed"`<br/>`"contract_api_confirmed"`<br/>`"blockchain_event_received"`<br/>`"blockchain_invoke_op_succeeded"`<br/>`"blockchain_invoke_op_failed"` |
| `type` | All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application | `FFEnum`:<br/>`"transaction_submitted"`<br/>`"message_confirmed"`<br/>`"message_rejected"`<br/>`"datatype_confirmed"`<br/>`"identity_confirmed"`<br/>`"identity_updated"`<br/>`"token_pool_confirmed"`<br/>`"token_pool_op_failed"`<br/>`"token_transfer_confirmed"`<br/>`"token_transfer_op_failed"`<br/>`"token_approval_confirmed"`<br/>`"token_approval_op_failed"`<br/>`"contract_interface_confirmed"`<br/>`"contract_api_confirmed"`<br/>`"blockchain_event_received"`<br/>`"blockchain_invoke_op_succeeded"`<br/>`"blockchain_invoke_op_failed"`<br/>`"blockchain_contract_deploy_op_succeeded"`<br/>`"blockchain_contract_deploy_op_failed"` |
| `namespace` | The namespace of the event. Your application must subscribe to events within a namespace | `string` |
| `reference` | The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset | [`UUID`](simpletypes#uuid) |
| `correlator` | For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool | [`UUID`](simpletypes#uuid) |
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/types/message.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ nav_order: 15
| `id` | The UUID of the message. Unique to each message | [`UUID`](simpletypes#uuid) |
| `cid` | The correlation ID of the message. Set this when a message is a response to another message | [`UUID`](simpletypes#uuid) |
| `type` | The type of the message | `FFEnum`:<br/>`"definition"`<br/>`"broadcast"`<br/>`"private"`<br/>`"groupinit"`<br/>`"transfer_broadcast"`<br/>`"transfer_private"` |
| `txtype` | The type of transaction used to order/deliver this message | `FFEnum`:<br/>`"none"`<br/>`"unpinned"`<br/>`"batch_pin"`<br/>`"network_action"`<br/>`"token_pool"`<br/>`"token_transfer"`<br/>`"contract_invoke"`<br/>`"token_approval"`<br/>`"data_publish"` |
| `txtype` | The type of transaction used to order/deliver this message | `FFEnum`:<br/>`"none"`<br/>`"unpinned"`<br/>`"batch_pin"`<br/>`"network_action"`<br/>`"token_pool"`<br/>`"token_transfer"`<br/>`"contract_deploy"`<br/>`"contract_invoke"`<br/>`"token_approval"`<br/>`"data_publish"` |
| `author` | The DID of identity of the submitter | `string` |
| `key` | The on-chain signing key used to sign the transaction | `string` |
| `created` | The creation time of the message | [`FFTime`](simpletypes#fftime) |
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/types/operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ nav_order: 7
| `id` | The UUID of the operation | [`UUID`](simpletypes#uuid) |
| `namespace` | The namespace of the operation | `string` |
| `tx` | The UUID of the FireFly transaction the operation is part of | [`UUID`](simpletypes#uuid) |
| `type` | The type of the operation | `FFEnum`:<br/>`"blockchain_pin_batch"`<br/>`"blockchain_network_action"`<br/>`"blockchain_invoke"`<br/>`"sharedstorage_upload_batch"`<br/>`"sharedstorage_upload_blob"`<br/>`"sharedstorage_upload_value"`<br/>`"sharedstorage_download_batch"`<br/>`"sharedstorage_download_blob"`<br/>`"dataexchange_send_batch"`<br/>`"dataexchange_send_blob"`<br/>`"token_create_pool"`<br/>`"token_activate_pool"`<br/>`"token_transfer"`<br/>`"token_approval"` |
| `type` | The type of the operation | `FFEnum`:<br/>`"blockchain_pin_batch"`<br/>`"blockchain_network_action"`<br/>`"blockchain_deploy"`<br/>`"blockchain_invoke"`<br/>`"sharedstorage_upload_batch"`<br/>`"sharedstorage_upload_blob"`<br/>`"sharedstorage_upload_value"`<br/>`"sharedstorage_download_batch"`<br/>`"sharedstorage_download_blob"`<br/>`"dataexchange_send_batch"`<br/>`"dataexchange_send_blob"`<br/>`"token_create_pool"`<br/>`"token_activate_pool"`<br/>`"token_transfer"`<br/>`"token_approval"` |
| `status` | The current status of the operation | `OpStatus` |
| `plugin` | The plugin responsible for performing the operation | `string` |
| `input` | The input to this operation | [`JSONObject`](simpletypes#jsonobject) |
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/types/transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ nav_order: 6
|------------|-------------|------|
| `id` | The UUID of the FireFly transaction | [`UUID`](simpletypes#uuid) |
| `namespace` | The namespace of the FireFly transaction | `string` |
| `type` | The type of the FireFly transaction | `FFEnum`:<br/>`"none"`<br/>`"unpinned"`<br/>`"batch_pin"`<br/>`"network_action"`<br/>`"token_pool"`<br/>`"token_transfer"`<br/>`"contract_invoke"`<br/>`"token_approval"`<br/>`"data_publish"` |
| `type` | The type of the FireFly transaction | `FFEnum`:<br/>`"none"`<br/>`"unpinned"`<br/>`"batch_pin"`<br/>`"network_action"`<br/>`"token_pool"`<br/>`"token_transfer"`<br/>`"contract_deploy"`<br/>`"contract_invoke"`<br/>`"token_approval"`<br/>`"data_publish"` |
| `created` | The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction | [`FFTime`](simpletypes#fftime) |
| `blockchainIds` | The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions | `string[]` |

Loading