Skip to content

Commit 7c334df

Browse files
Added change log.
1 parent 4b2aeeb commit 7c334df

File tree

1 file changed

+125
-0
lines changed

1 file changed

+125
-0
lines changed

CHANGELOG.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,136 @@
22

33
# Change Log
44

5+
This document serves as the change log for the ONIXLabs Corda Core API.
6+
7+
## Version 1.1.0
8+
9+
### Contract
10+
11+
#### Extensions
12+
13+
- Moved to new extension file naming convention for maintainability.
14+
- Added extensions to obtain single inputs, reference inputs and outputs from a `LedgerTransaction`.
15+
16+
### Workflow
17+
18+
#### Extensions
19+
20+
- Moved to new extension naming convention for maintainability.
21+
- Added extensions to filter a set of sessions to include or exclude certain counter-parties, or state participants.
22+
523
## Version 1.0.0
624

25+
### Contract
26+
27+
#### ChainState (interface)
28+
29+
Defines a Corda chain state.
30+
31+
> A chain state is similar to a `LinearState`, in that it represents a set of state transitions. Chain states adopt a concept similar to blockchain, where each new state transition references the previous one by it's `StateRef`, or null if it's the first state in the chain.
32+
33+
#### Hashable (interface)
34+
35+
Defines an object that can produce a unique hash.
36+
37+
> This is useful if you require some level of state uniqueness.
38+
39+
#### Resolvable (interface)
40+
41+
Defines an object which resolves a `ContractState`.
42+
43+
> This is the fundamental principle on which state pointers are implemented in Corda; their ability to maintain and resolve a reference back to another known state in the vault. The implementation here is flexible and open, allowing developers to model resolvable as a design pattern, rather than as a strict implementation detail.
44+
45+
#### TransactionResolution (enum)
46+
47+
Defines how to resolve states from a transaction, and is used by the `Resolvable` interface.
48+
49+
#### Extensions
50+
51+
- Added extension to obtain a set of owning keys from a collection of `AbstractParty`.
52+
- Added extension to obtain a participant hash to determine state uniqueness by participation.
53+
- Added extensions to determine whether a chain state instance is pointing to a specified `StateRef`.
54+
- Added extension to cast an unknown `StateAndRef<*>` to a typed `StateAndRef<T>`.
55+
56+
### Workflow
57+
58+
#### FindStateFlow (abstract class)
59+
60+
Represents the base class for implementing a query that finds a single state.
61+
62+
#### FindStatesFlow (abstract class)
63+
64+
Represents the base class for implementing a query that finds multiple states.
65+
66+
> This design pattern enables developers to be more consistent in their approach to performing vault queries, regardless of whether they're being performed from within the node (using `ServiceHub`) or from an RPC client (using `CordaRPCOps`).
67+
68+
#### Message (open class)
69+
70+
Represents an open, transient message.
71+
72+
#### MessageAcknowledgement (open class)
73+
74+
Represents an open acknowledgement to a message.
75+
76+
#### SendMessageFlow (class)
77+
78+
Sends a message to other nodes on the Corda network.
79+
80+
#### ReceiveMessageFlow (class)
81+
82+
Receives a message from another node on the Corda network.
83+
84+
#### SendMessageAcknowledgementFlow (class)
85+
86+
Sends a message acknowledgement to other nodes on the Corda network.
87+
88+
#### ReceiveMessageAcknowledgementFlow (class)
89+
90+
Receives a message acknowledgement from another node on the Corda network.
91+
92+
#### TransactionNote (class)
93+
94+
Represents a wrapper around a transaction note and the transaction that the note belongs to.
95+
96+
#### SendTransactionNoteFlow (class)
97+
98+
Sends a transaction note to other nodes on the Corda network for persistence.
99+
100+
#### ReceiveTransactionNoteFlow (class)
101+
102+
Receives a transaction note from another node on the Corda network, and optionally persists it.
103+
104+
> All messaging APIs are part of the ONIXLabs Corda Code messaging protocol, which allows Corda nodes to send and receive transient messages and messages acknowledgements, which are not bound to the ledger.
105+
106+
#### Extensions
107+
108+
- Added extensions to obtain the first notary from the network map cache.
109+
- Added extensions to obtain a random notary from the network map cache.
110+
- Added extensions to obtain the preferred notary from the CorDapp config file.
111+
- Added extensions to set, and optionally log progress tracker steps.
112+
- Added extensions to initiate flow sessions for a collection of parties and/or state participants.
113+
- Added extensions to check that sufficient flow sessions have been passed for the specified states.
114+
- Added extensions to find transactions by transaction ID or `StateRef`.
115+
- Added constants for default sorting and default, or maximum size page specification.
116+
- Added extensions to build complex query expressions.
117+
118+
### Integration
119+
120+
#### RPCService (abstract class)
121+
122+
Represents the base class for implementing services that utilize `CordaRPCOps`.
123+
124+
#### MessageService (class)
125+
126+
Represents an RPC service for sending and subscribing to transient messages.
127+
128+
#### MessageAcknowledgementService (class)
7129

130+
Represents an RPC service for sending and subscribing to transience message acknowledgements.
8131

132+
#### TransactionNoteService (class)
9133

134+
Represents an RPC service for adding, sending and persisting transaction notes.
10135

11136

12137

0 commit comments

Comments
 (0)