Skip to content

Commit 7e0909c

Browse files
EnriqueL8EnriqueL8
committed
Update the field definitions
Signed-off-by: Enrique Lacal <[email protected]>
1 parent 041b378 commit 7e0909c

File tree

4 files changed

+51
-36
lines changed

4 files changed

+51
-36
lines changed

‎doc-site/docs/reference/types/_includes/contractlistener_description.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ In these examples, the event schema in the FireFly Interface format is provided
188188

189189
### With Interface Reference
190190

191-
These examples use an `interface` reference when creating the filters, the `eventPath` field is used to reference an event defined within the interface provided. See an example of creating a [FireFly Interface](../../tutorials/custom_contracts/ethereum.md/#the-firefly-interface-format) for an EVM smart contract.
191+
These examples use an `interface` reference when creating the filters, the `eventPath` field is used to reference an event defined within the interface provided. In this case, we do not need to provide the event schema as the section above shows. See an example of creating a [FireFly Interface](../../tutorials/custom_contracts/ethereum.md/#the-firefly-interface-format) for an EVM smart contract.
192192

193193
**Muliple Filters**
194194
```json

‎doc-site/docs/reference/types/contractlistener.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: ContractListener
33
---
44
{% include-markdown "./_includes/contractlistener_description.md" %}
55

6-
### Example Response from the API
6+
### Example
77

88
```json
99
{
@@ -121,9 +121,9 @@ title: ContractListener
121121

122122
| Field Name | Description | Type |
123123
|------------|-------------|------|
124-
| `event` | The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI | [`FFISerializedEvent`](#ffiserializedevent) |
124+
| `event` | The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied | [`FFISerializedEvent`](#ffiserializedevent) |
125125
| `location` | A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel | [`JSONAny`](simpletypes.md#jsonany) |
126-
| `interface` | A reference to an existing FFI, containing pre-registered type information for the event | [`FFIReference`](#ffireference) |
126+
| `interface` | A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath | [`FFIReference`](#ffireference) |
127127
| `signature` | The stringified signature of the event and location, as computed by the blockchain plugin | `string` |
128128

129129

‎doc-site/docs/swagger/swagger.yaml‎

Lines changed: 45 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1443,7 +1443,7 @@ paths:
14431443
event:
14441444
description: The definition of the event, either provided
14451445
in-line when creating the listener, or extracted from
1446-
the referenced FFI
1446+
the referenced FFI when supplied
14471447
properties:
14481448
description:
14491449
description: A description of the smart contract event
@@ -1487,7 +1487,8 @@ paths:
14871487
type: object
14881488
interface:
14891489
description: A reference to an existing FFI, containing
1490-
pre-registered type information for the event
1490+
pre-registered type information for the event, used
1491+
in combination with eventPath
14911492
properties:
14921493
id:
14931494
description: The UUID of the FireFly interface
@@ -1725,7 +1726,7 @@ paths:
17251726
event:
17261727
description: The definition of the event, either provided
17271728
in-line when creating the listener, or extracted from
1728-
the referenced FFI
1729+
the referenced FFI when supplied
17291730
properties:
17301731
description:
17311732
description: A description of the smart contract event
@@ -1767,7 +1768,8 @@ paths:
17671768
type: object
17681769
interface:
17691770
description: A reference to an existing FFI, containing
1770-
pre-registered type information for the event
1771+
pre-registered type information for the event, used in
1772+
combination with eventPath
17711773
properties:
17721774
id:
17731775
description: The UUID of the FireFly interface
@@ -5885,7 +5887,7 @@ paths:
58855887
event:
58865888
description: The definition of the event, either provided
58875889
in-line when creating the listener, or extracted from
5888-
the referenced FFI
5890+
the referenced FFI when supplied
58895891
properties:
58905892
description:
58915893
description: A description of the smart contract event
@@ -5929,7 +5931,8 @@ paths:
59295931
type: object
59305932
interface:
59315933
description: A reference to an existing FFI, containing
5932-
pre-registered type information for the event
5934+
pre-registered type information for the event, used
5935+
in combination with eventPath
59335936
properties:
59345937
id:
59355938
description: The UUID of the FireFly interface
@@ -6082,7 +6085,7 @@ paths:
60826085
event:
60836086
description: The definition of the event, either provided
60846087
in-line when creating the listener, or extracted from the
6085-
referenced FFI
6088+
referenced FFI when supplied
60866089
properties:
60876090
description:
60886091
description: A description of the smart contract event
@@ -6127,7 +6130,8 @@ paths:
61276130
type: string
61286131
interface:
61296132
description: A reference to an existing FFI, containing pre-registered
6130-
type information for the event
6133+
type information for the event, used in combination with
6134+
eventPath
61316135
properties:
61326136
id:
61336137
description: The UUID of the FireFly interface
@@ -6251,7 +6255,7 @@ paths:
62516255
event:
62526256
description: The definition of the event, either provided
62536257
in-line when creating the listener, or extracted from
6254-
the referenced FFI
6258+
the referenced FFI when supplied
62556259
properties:
62566260
description:
62576261
description: A description of the smart contract event
@@ -6293,7 +6297,8 @@ paths:
62936297
type: object
62946298
interface:
62956299
description: A reference to an existing FFI, containing
6296-
pre-registered type information for the event
6300+
pre-registered type information for the event, used in
6301+
combination with eventPath
62976302
properties:
62986303
id:
62996304
description: The UUID of the FireFly interface
@@ -6489,7 +6494,7 @@ paths:
64896494
event:
64906495
description: The definition of the event, either provided
64916496
in-line when creating the listener, or extracted from
6492-
the referenced FFI
6497+
the referenced FFI when supplied
64936498
properties:
64946499
description:
64956500
description: A description of the smart contract event
@@ -6531,7 +6536,8 @@ paths:
65316536
type: object
65326537
interface:
65336538
description: A reference to an existing FFI, containing
6534-
pre-registered type information for the event
6539+
pre-registered type information for the event, used in
6540+
combination with eventPath
65356541
properties:
65366542
id:
65376543
description: The UUID of the FireFly interface
@@ -6683,7 +6689,7 @@ paths:
66836689
event:
66846690
description: The definition of the event, either provided
66856691
in-line when creating the listener, or extracted from the
6686-
referenced FFI
6692+
referenced FFI when supplied
66876693
properties:
66886694
description:
66896695
description: A description of the smart contract event
@@ -6728,7 +6734,8 @@ paths:
67286734
type: string
67296735
interface:
67306736
description: A reference to an existing FFI, containing pre-registered
6731-
type information for the event
6737+
type information for the event, used in combination with
6738+
eventPath
67326739
properties:
67336740
id:
67346741
description: The UUID of the FireFly interface
@@ -14132,7 +14139,7 @@ paths:
1413214139
event:
1413314140
description: The definition of the event, either provided
1413414141
in-line when creating the listener, or extracted from
14135-
the referenced FFI
14142+
the referenced FFI when supplied
1413614143
properties:
1413714144
description:
1413814145
description: A description of the smart contract event
@@ -14176,7 +14183,8 @@ paths:
1417614183
type: object
1417714184
interface:
1417814185
description: A reference to an existing FFI, containing
14179-
pre-registered type information for the event
14186+
pre-registered type information for the event, used
14187+
in combination with eventPath
1418014188
properties:
1418114189
id:
1418214190
description: The UUID of the FireFly interface
@@ -14345,7 +14353,7 @@ paths:
1434514353
event:
1434614354
description: The definition of the event, either provided
1434714355
in-line when creating the listener, or extracted from the
14348-
referenced FFI
14356+
referenced FFI when supplied
1434914357
properties:
1435014358
description:
1435114359
description: A description of the smart contract event
@@ -14385,7 +14393,8 @@ paths:
1438514393
type: object
1438614394
interface:
1438714395
description: A reference to an existing FFI, containing pre-registered
14388-
type information for the event
14396+
type information for the event, used in combination with
14397+
eventPath
1438914398
properties:
1439014399
id:
1439114400
description: The UUID of the FireFly interface
@@ -14509,7 +14518,7 @@ paths:
1450914518
event:
1451014519
description: The definition of the event, either provided
1451114520
in-line when creating the listener, or extracted from
14512-
the referenced FFI
14521+
the referenced FFI when supplied
1451314522
properties:
1451414523
description:
1451514524
description: A description of the smart contract event
@@ -14551,7 +14560,8 @@ paths:
1455114560
type: object
1455214561
interface:
1455314562
description: A reference to an existing FFI, containing
14554-
pre-registered type information for the event
14563+
pre-registered type information for the event, used in
14564+
combination with eventPath
1455514565
properties:
1455614566
id:
1455714567
description: The UUID of the FireFly interface
@@ -19041,7 +19051,7 @@ paths:
1904119051
event:
1904219052
description: The definition of the event, either provided
1904319053
in-line when creating the listener, or extracted from
19044-
the referenced FFI
19054+
the referenced FFI when supplied
1904519055
properties:
1904619056
description:
1904719057
description: A description of the smart contract event
@@ -19085,7 +19095,8 @@ paths:
1908519095
type: object
1908619096
interface:
1908719097
description: A reference to an existing FFI, containing
19088-
pre-registered type information for the event
19098+
pre-registered type information for the event, used
19099+
in combination with eventPath
1908919100
properties:
1909019101
id:
1909119102
description: The UUID of the FireFly interface
@@ -19245,7 +19256,7 @@ paths:
1924519256
event:
1924619257
description: The definition of the event, either provided
1924719258
in-line when creating the listener, or extracted from the
19248-
referenced FFI
19259+
referenced FFI when supplied
1924919260
properties:
1925019261
description:
1925119262
description: A description of the smart contract event
@@ -19290,7 +19301,8 @@ paths:
1929019301
type: string
1929119302
interface:
1929219303
description: A reference to an existing FFI, containing pre-registered
19293-
type information for the event
19304+
type information for the event, used in combination with
19305+
eventPath
1929419306
properties:
1929519307
id:
1929619308
description: The UUID of the FireFly interface
@@ -19414,7 +19426,7 @@ paths:
1941419426
event:
1941519427
description: The definition of the event, either provided
1941619428
in-line when creating the listener, or extracted from
19417-
the referenced FFI
19429+
the referenced FFI when supplied
1941819430
properties:
1941919431
description:
1942019432
description: A description of the smart contract event
@@ -19456,7 +19468,8 @@ paths:
1945619468
type: object
1945719469
interface:
1945819470
description: A reference to an existing FFI, containing
19459-
pre-registered type information for the event
19471+
pre-registered type information for the event, used in
19472+
combination with eventPath
1946019473
properties:
1946119474
id:
1946219475
description: The UUID of the FireFly interface
@@ -19666,7 +19679,7 @@ paths:
1966619679
event:
1966719680
description: The definition of the event, either provided
1966819681
in-line when creating the listener, or extracted from
19669-
the referenced FFI
19682+
the referenced FFI when supplied
1967019683
properties:
1967119684
description:
1967219685
description: A description of the smart contract event
@@ -19708,7 +19721,8 @@ paths:
1970819721
type: object
1970919722
interface:
1971019723
description: A reference to an existing FFI, containing
19711-
pre-registered type information for the event
19724+
pre-registered type information for the event, used in
19725+
combination with eventPath
1971219726
properties:
1971319727
id:
1971419728
description: The UUID of the FireFly interface
@@ -19867,7 +19881,7 @@ paths:
1986719881
event:
1986819882
description: The definition of the event, either provided
1986919883
in-line when creating the listener, or extracted from the
19870-
referenced FFI
19884+
referenced FFI when supplied
1987119885
properties:
1987219886
description:
1987319887
description: A description of the smart contract event
@@ -19912,7 +19926,8 @@ paths:
1991219926
type: string
1991319927
interface:
1991419928
description: A reference to an existing FFI, containing pre-registered
19915-
type information for the event
19929+
type information for the event, used in combination with
19930+
eventPath
1991619931
properties:
1991719932
id:
1991819933
description: The UUID of the FireFly interface

‎internal/coremsgs/en_struct_descriptions.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,8 +319,8 @@ var (
319319
// ContractListenerOptions field descriptions
320320
ContractListenerOptionsFirstEvent = ffm("ContractListenerOptions.firstEvent", "A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest'")
321321

322-
ListenerFilterInterface = ffm("ListenerFilter.interface", "A reference to an existing FFI, containing pre-registered type information for the event")
323-
ListenerFilterEvent = ffm("ListenerFilter.event", "The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI")
322+
ListenerFilterInterface = ffm("ListenerFilter.interface", "A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath")
323+
ListenerFilterEvent = ffm("ListenerFilter.event", "The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied")
324324
ListenerFilterEventPath = ffm("ListenerFilter.eventPath", "When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener")
325325
ListenerFilterLocation = ffm("ListenerFilter.location", "A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel")
326326
ListenerFilterSignature = ffm("ListenerFilter.signature", "The stringified signature of the event and location, as computed by the blockchain plugin")

0 commit comments

Comments
 (0)