Skip to content

Commit

Permalink
Update query and txjob subprotocol documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Jamie Bertram committed Dec 8, 2023
1 parent 3c47358 commit d589086
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ parameterized by the type of query that the server supports.
| Message | Begin state | End state | Parameter | Description |
| --- | --- | --- | --- | --- |
| 1. `Request req` | `Req` | `Res a` | | Sends a request to the server. |
| | | | `ctx` | An optional Open Telemetry span context originating from the sender from which child spans on the server should descend. |
| | | | `req` | A request tree with a result of type `a`. |
| 2. `Respond a` | `Res a` | `Req` | | Sends a response to the client. |
| | | | `a` | The response type. |
| 3. `Done` | `Req` | `Done` | | Terminates the session. |
| | | | `ctx` | An optional Open Telemetry span context originating from the sender from which child spans on the server should descend. |

### Request trees

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,10 @@ For more details on the types mentioned, please see:
| | | | | `stakeCredential` | An optional stake credential to attach to the script address for this contract. |
| | | | | `v` | The version of the contract. |
| | | | | `wallet` | A `WalletAddresses` record of the wallet authorizing the transaction. |
| | | | | `threadName` | [Optional] The role name for the contract's thread token, if it uses open roles. |
| | | | | `roles` | A `RoleTokensConfig` that describes how role tokens are to be minted and distributed in this contract. |
| | | | | `metadata` | A `MarloweTransactionMetadata` record to attach to the transaction's metadata. |
| | | | | `minAdaDeposit` | The **[min ada deposit for the contract](https://docs.marlowe.iohk.io/docs/platform-and-architecture/marlowe-language-guide#minimum-ada-requirements-minutxo)**. |
| | | | | `minAdaDeposit` | [Optional] The **[min ada deposit for the contract](https://docs.marlowe.iohk.io/docs/platform-and-architecture/marlowe-language-guide#minimum-ada-requirements-minutxo)**. |
| | | | | `contract` | The Marlowe contract to run. |
| 2. `ApplyInputs` | none | `ApplyInputsError` | `InputsApplied` | | Builds a transaction that applies inputs to a running Marlowe contract. |
| | | | | `v` | The version of the contract. |
Expand Down

0 comments on commit d589086

Please sign in to comment.