aljaz/dlcspecs
1
0
Fork 0
mirror of https://github.com/aljazceru/dlcspecs.git synced 2025-12-17 06:14:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Oracle Announcement TLVs (#105)

Browse Source 
* Oracle Announcement TLVs

* Nadav's review

* Respond to more review

* Range Event Descriptor

* Add num outcomes to enum descriptor
This commit is contained in:
Ben Carman
2020-10-08 15:00:37 -05:00
committed by GitHub
parent 90b9cb7463
commit 44837f9472
1 changed files with 84 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
Messaging.md
View File

@@ -23,6 +23,14 @@ All data fields are unsigned big-endian unless otherwise specified.
* [Version 0 `cet_adaptor_signatures`](#version-0-cet_adaptor_signatures)
* [The `funding_signatures` Type](#the-funding_signatures-type)
* [Version 0 `funding_signatures`](#version-0-funding_signatures)
* [The `event_descriptor` Type](#the-event_descriptor-type)
* [Version 0 `external_event_descriptor`](#version-0-external_event_descriptor)
* [Version 0 `enum_event_descriptor`](#version-0-enum_event_descriptor)
* [Version 0 `range_event_descriptor`](#version-0-range_event_descriptor)
* [The `oracle_event` Type](#the-oracle_event-type)
* [Version 0 `oracle_event`](#version-0-oracle_event)
* [The `oracle_announcement` Type](#the-oracle_announcement-type)
* [Version 0 `oracle_announcement`](#version-0-oracle_announcement)
* [Authors](#authors)
## Connection Handling and Multiplexing
@@ -47,6 +55,7 @@ Various fundamental types are referred to in the message specifications:
* `u16`: a 2 byte unsigned integer
* `u32`: a 4 byte unsigned integer
* `u64`: an 8 byte unsigned integer
* `int32`: a 4 byte signed integer
Inside TLV records which contain a single value, leading zeros in
integers can be omitted:
@@ -69,6 +78,7 @@ The following convenience types are also defined:
* `script_sig`: A bitcoin script signature encoded as ASM prefixed a `u16` value indicating its length.
* `short_contract_id`: an 8 byte value identifying a contract funding transaction on-chain (see [BOLT #7](https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#definition-of-short-channel-id))
* `bigsize`: a variable-length, unsigned integer similar to Bitcoin's CompactSize encoding, but big-endian. Described in [BigSize](https://github.com/lightningnetwork/lightning-rfc/blob/master/01-messaging.md#appendix-a-bigsize-test-vectors).
* `string`: a UTF-8 encoded string using [NFC for normalization](https://github.com/discreetlogcontracts/dlcspecs/issues/89)
## DLC Specific Types
@@ -165,10 +175,84 @@ This type contains signatures of the funding transaction and any necessary infor
`witness` is the data for a witness element in a witness stack. An empty `witness_stack` is an error,
as every input must be Segwit. Witness elements should *not* include their length as part of the witness data.
### The `event_descriptor` Type
This type contains information about the *exact* and fully specified outcomes in an event for which an oracle plans on releasing a signature over.
#### Version 0 `external_event_descriptor`
1. type: 55300 (`external_event_descriptor_v0`)
2. data:
* [`string`:`external_name`]
`external_name` can refer to anything here and it is up to the oracle and user to agree on how to interpret it.
#### Version 0 `enum_event_descriptor`
1. type: 55302 (`enum_event_descriptor_v0`)
2. data:
* [`u16`:`num_outcomes`]
* [`u16`:`outcome_1_len`]
* [`string`:`outcome_1`]
* ...
* [`u16`:`outcome_n_len`]
* [`string`:`outcome_n`]
This type of event descriptor is a simple enumeration where the value `n` is the number of outcomes in the event.
Each `outcome_i` corresponds to the pre-image of a possible outcome that the oracle could sign.
#### Version 0 `range_event_descriptor`
1. type: 55304 (`range_event_descriptor_v0`)
2. data:
* [`int32`:`start`]
* [`int32`:`stop`]
* [`u16`:`step`]
`start` refers to the first possible outcome number
`end` refers to the last possible outcome number
`step` refers to the increment between each outcome
### The `oracle_event` Type
This type contains information about an event for which an oracle plans on releasing a signature over.
#### Version 0 `oracle_event`
1. type: 55330 (`oracle_event_v0`)
2. data:
* [`x_point`:`oracle_public_key`]
* [`x_point`:`oracle_nonce`]
* [`u32`:`event_maturity_epoch`]
* [`event_descriptor`:`event_descriptor`]
* [`string`:`event_uri`]
`event_maturity_epoch` refers to the earliest time this event (UTC) is expected to be signed, in epoch seconds.
`event_uri` is a name and/or categorization of this event given by the oracle.
### The `oracle_announcement` Type
This type contains information about an announcement of an oracle to attest to an event in the future.
#### Version 0 `oracle_announcement`
1. type: 55332 (`oracle_announcement`)
2. data:
* [`signature`:`annoucement_signature`]
* [`oracle_event`:`oracle_event`]
The `annoucement_signature` is a signature of the hash of the serialized `oracle_event` that is valid with respect to `oracle_public_key`. This can be shared with peers that have already verified this oracle's public key.
## Authors
Nadav Kohen <nadavk25@gmail.com>
Ben Carman <benthecarman@live.com>
![Creative Commons License](https://i.creativecommons.org/l/by/4.0/88x31.png "License CC-BY")
<br>
This work is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).