Updated v3 changelog.

Author: MrMatthewLayton

docs/CHANGELOG-3.0.0.md

@@ -48,4 +48,138 @@ data class SignatureData(
 
 ---
 
+### SendTransactionStep _Object_
+
+**Module:** onixlabs-corda-core-workflow
+
+**Package:** io.onixlabs.corda.core.workflow
+
+Represents a progress tracker step indicating that a signed transaction is being sent.
+
+```kotlin
+object SendTransactionStep : Step
+```
+
+### Remarks
+
+The `publishTransaction` extension function uses this as the default `progressTrackerStep` argument, however you can replace it with your own progress tracker step.
+
+---
+
+### ReceiveTransactionStep _Object_
+
+**Module:** onixlabs-corda-core-workflow
+
+**Package:** io.onixlabs.corda.core.workflow
+
+Represents a progress tracker step indicating that a signed transaction is being received.
+
+```kotlin
+object SendTransactionStep : Step
+```
+
+### Remarks
+
+The `publishTransactionHandler` extension function uses this as the default `progressTrackerStep` argument, however you can replace it with your own progress tracker step.
+
+---
+
+### publishTransaction _Extension Function_
+
+**Module:** onixlabs-corda-core-workflow
+
+**Package:** io.onixlabs.corda.core.workflow
+
+Publishes a `SignedTransaction` to the specified flow sessions.
+
+```kotlin
+@Suspendable
+fun FlowLogic<*>.publishTransaction(
+    transaction: SignedTransaction,
+    sessions: Set<FlowSession>,
+    progressTrackerStep: Step = SendTransactionStep
+): SignedTransaction
+```
+
+#### Remarks
+
+To use this function, `SendTransactionStep` will need to be evident in your progress tracker, unless you replace the default argument with your own progress tracker step.
+
+---
+
+### publishTransactionHandler _Extension Function_
+
+**Module:** onixlabs-corda-core-workflow
+
+**Package:** io.onixlabs.corda.core.workflow
+
+Handles and records a published `SignedTransaction`.
+
+```kotlin
+@Suspendable
+fun FlowLogic<*>.publishTransactionHandler(
+    session: FlowSession,
+    statesToRecord: StatesToRecord = StatesToRecord.ALL_VISIBLE,
+    checkSufficientSignatures: Boolean = true,
+    progressTrackerStep: Step = ReceiveTransactionStep
+): SignedTransaction
+```
+
+#### Remarks
+
+To use this function, `ReceiveTransactionStep` will need to be evident in your progress tracker, unless you replace the default argument with your own progress tracker step.
+
+---
+
+### finalizeTransaction _Extension Function_
+
+**Module:** onixlabs-corda-core-workflow
+
+**Package:** io.onixlabs.corda.core.workflow
+
+Finalizes a transaction.
+
+```kotlin
+@Suspendable
+fun FlowLogic<*>.finalizeTransaction(
+    transaction: SignedTransaction,
+    sessions: Iterable<FlowSession> = emptyList(),
+    counterpartyStatesToRecord: StatesToRecord = StatesToRecord.ONLY_RELEVANT,
+    ourStatesToRecord: StatesToRecord = StatesToRecord.ONLY_RELEVANT
+): SignedTransaction
+```
+
+>   🔵  **INFORMATION**
+>
+>   This API exists in version 2.1.0 however in version 3.0.0 there are two notable changes:
+>
+>   1.   The `sessions` parameter provides a default `emptyList()` argument; useful for finalising local transactions.
+>   2.   `SendStatesToRecordStep` only needs to be evident in your progress tracker when finalising transactions with counter-parties. For local transactions, this progress tracker step can be omitted.
+
+---
+
+### StatesToRecordBySession _Class_
+
+**Module:** onixlabs-corda-core-workflow
+
+**Package:** io.onixlabs.corda.core.workflow
+
+Represents a mapping of `FlowSession` to `StatesToRecord`, allowing a transaction initiator to specify how each counter-party should record the states of a transaction.
+```kotlin
+class StatesToRecordBySession(
+  statesToRecordBySession: Map<FlowSession, StatesToRecord> = emptyMap()
+)
+```
+
+### Remarks
+
+>   🔵  **INFORMATION**
+>
+>   This API exists in version 2.1.0 however in version 3.0.0, there are two notable changes:
+>
+>   1.   `addSession` has been renamed to `setSessionStatesToRecord`. If a flow session already exists in the underlying map, this function will overwrite its `StatesToRecord` value. If a flow session doesn't exist in the underlying map, this function will add the flow session to the underlying map with the specified `StatesToRecord` value.
+>   2.   `addMissionSession` has been renamed to `addSessionStatesToRecord`. If a flow session already exists in the underlying map, this function will ignore the addition.  If a flow session doesn't exist in the underlying map, this function will add the flow session to the underlying map with the specified `StatesToRecord` value.
+
+---
+
 ###