Skip to content

Commit

Permalink
refactor(defects): refactoring defects out
Browse files Browse the repository at this point in the history
malformed files
  • Loading branch information
sam committed Jul 29, 2020
1 parent f2d8789 commit d912a26
Show file tree
Hide file tree
Showing 260 changed files with 28,435 additions and 25,795 deletions.
2 changes: 1 addition & 1 deletion Chain/AccountIdentifier.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ properties:
type: string
example: "0x3a065000ab4183c6bf581dc1e55a605455fc6d61"
sub_account:
$ref: 'SubAccountIdentifier.yaml'
$ref: "SubAccountIdentifier.yaml"
metadata:
description: |
Blockchains that utilize a username model (where the address is not a derivative of a cryptographic
Expand Down
6 changes: 3 additions & 3 deletions Chain/Allow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ description: |
that contains any of the above information that is not specified here.
type: object
required:
- operation_statuses
- operation_statuses
- operation_types
- errors
- historical_balance_lookup
Expand All @@ -32,7 +32,7 @@ properties:
client validation to error.
type: array
items:
$ref: 'OperationStatus.yaml'
$ref: "OperationStatus.yaml"
operation_types:
description: |
All Operation.Type this implementation supports. Any type
Expand All @@ -49,7 +49,7 @@ properties:
cause client validation to error.
type: array
items:
$ref: 'Error.yaml'
$ref: "Error.yaml"
historical_balance_lookup:
type: boolean
description: |
Expand Down
2 changes: 1 addition & 1 deletion Chain/Amount.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ properties:
type: string
example: "1238089899992"
currency:
$ref: 'Currency.yaml'
$ref: "Currency.yaml"
metadata:
type: object
8 changes: 4 additions & 4 deletions Chain/Block.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ required:
- transactions
properties:
block_identifier:
$ref: 'BlockIdentifier.yaml'
$ref: "BlockIdentifier.yaml"
parent_block_identifier:
$ref: 'BlockIdentifier.yaml'
$ref: "BlockIdentifier.yaml"
timestamp:
$ref: 'Timestamp.yaml'
$ref: "Timestamp.yaml"
transactions:
type: array
items:
$ref: 'Transaction.yaml'
$ref: "Transaction.yaml"
metadata:
type: object
example:
Expand Down
2 changes: 1 addition & 1 deletion Chain/CurveType.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ description: |
* secp256k1: SEC compressed - `33 bytes` (https://secg.org/sec1-v2.pdf#subsubsection.2.3.3)
* edwards25519: `y (255-bits) || x-sign-bit (1-bit)` - `32 bytes` (https://ed25519.cr.yp.to/ed25519-20110926.pdf)
type: string
type: string
enum:
- secp256k1
- edwards25519
2 changes: 1 addition & 1 deletion Chain/NetworkIdentifier.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ properties:
type: string
example: "mainnet"
sub_network_identifier:
$ref: 'SubNetworkIdentifier.yaml'
$ref: "SubNetworkIdentifier.yaml"
8 changes: 4 additions & 4 deletions Chain/Operation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ required:
- status
properties:
operation_identifier:
$ref: 'OperationIdentifier.yaml'
$ref: "OperationIdentifier.yaml"
related_operations:
description: |
Restrict referenced related_operations to identifier indexes
Expand All @@ -34,7 +34,7 @@ properties:
in a single transfer or linking operations in a call tree.
type: array
items:
$ref: 'OperationIdentifier.yaml'
$ref: "OperationIdentifier.yaml"
example:
- index: 0
operation_identifier:
Expand All @@ -56,9 +56,9 @@ properties:
type: string
example: "Reverted"
account:
$ref: 'AccountIdentifier.yaml'
$ref: "AccountIdentifier.yaml"
amount:
$ref: 'Amount.yaml'
$ref: "Amount.yaml"
metadata:
type: object
example:
Expand Down
2 changes: 1 addition & 1 deletion Chain/OperationStatus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: |
type: object
required:
- status
- successful
- successful
properties:
status:
description: |
Expand Down
2 changes: 1 addition & 1 deletion Chain/PublicKey.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: |
Note that there is no PrivateKey struct as this
is NEVER the concern of an implementation.
type: object
type: object
required:
- hex_bytes
- curve_type
Expand Down
2 changes: 1 addition & 1 deletion Chain/SubAccountIdentifier.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: |
specify which state (if applicable) an account instantiation refers to.
type: object
required:
- address
- address
properties:
address:
description: |
Expand Down
2 changes: 1 addition & 1 deletion Chain/SubNetworkIdentifier.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: |
optional for all non-sharded blockchains.
type: object
required:
- network
- network
properties:
network:
type: string
Expand Down
4 changes: 2 additions & 2 deletions Chain/Transaction.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ required:
- operations
properties:
transaction_identifier:
$ref: 'TransactionIdentifier.yaml'
$ref: "TransactionIdentifier.yaml"
operations:
type: array
items:
$ref: 'Operation.yaml'
$ref: "Operation.yaml"
metadata:
description: |
Transactions that are related to other transactions (like a cross-shard transaction) should include
Expand Down
4 changes: 2 additions & 2 deletions HEADER.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
freighttrust:
info:
version: "2.1.0"
title: 'Protocol specifications'
description: 'protocol values'
title: "Protocol specifications"
description: "protocol values"
license:
name: Mozilla Public License 2.0
url: hhttps://www.mozilla.org/en-US/MPL/2.0/
Expand Down
22 changes: 8 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<!-- Attribution-NonCommercial-NoDerivs 2.5 \*
<https://spdx.org/licenses/CC-BY-NC-ND-2.5.html> \* © 2020 FreightTrust
and Clearing Corporation \*/ = Clearing, Settlement and Delivery of
Expand All @@ -18,12 +17,11 @@ Trades & Orders -->

For ABNF specs, [see the `spec_abnf` dir](https://github.com/freight-trust/protocol/tree/master/spec_abnf/abnf)

- directories with `spec_*` are the reference specification
- directories with `lib` or `module`/`component` *should* be the technical implementation
- directories with `spec_*` are the reference specification
- directories with `lib` or `module`/`component` _should_ be the technical implementation

### Interfaces


<img src="service-mesh.png"
alt="Freight Trust Network Interface"
style="float: left; margin-right: 10px;" />
Expand All @@ -37,20 +35,19 @@ For ABNF specs, [see the `spec_abnf` dir](https://github.com/freight-trust/proto

<br />


### Legal Regimes (Burgess)

#### Concepts

- Units of Execution
- Units of Agreement
- Units of Afferent
- Units of Efferent
- Units of Lexigram


- Controlled Natural Language = Jurisdictional Grammar (see [Burgess](https://github.com/freight-trust/burgess) )
- Afferent = Towards
- Efferent = Away
* Controlled Natural Language = Jurisdictional Grammar (see [Burgess](https://github.com/freight-trust/burgess) )
* Afferent = Towards
* Efferent = Away

## Blocks as `units of agreement`

Expand All @@ -63,15 +60,12 @@ Rules
"x chains to y if x links to y."
"x chains to z if x links to y and y chains to z."


Facts are *primitives* (i.e. not containing variables) that apply
Facts are _primitives_ (i.e. not containing variables) that apply
a predicate to arguments

to Block1 followed by Block2 and
to Block2 followed by Block3

to Block2 followed by Block3

Rules are of the form `conclusion :- condition` (i.e. containing variables), with the Prolog-like (symbol) infix `":-"` corresponding to the above "if".

This consittutes the extent of which RuleML is applied to the `TradeDocs` system, a basic primitive set for `rule-conditions`

27 changes: 5 additions & 22 deletions ROOT/BOLWorkflow.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,10 @@
"format": "uri",
"type": "string",
"description": "pki",
"enum": [
"notify",
"notifyAll",
"getClass",
"finalize"
]
"enum": ["notify", "notifyAll", "getClass", "finalize"]
},
"GoverningLaw": {
"enum": [
"MASTER_AGREEMENT",
"USCA",
"USDE",
"USIL",
"USNY",
"OTHER"
],
"enum": ["MASTER_AGREEMENT", "USCA", "USDE", "USIL", "USNY", "OTHER"],
"type": "string"
},
"Cosignee": {
Expand Down Expand Up @@ -59,16 +47,11 @@
"additionalProperties": {
"format": null,
"type": "object",
"required": [
"checksum_digit"
]
"required": ["checksum_digit"]
}
},
"AssetClass": {
"enum": [
null,
null
],
"enum": [null, null],
"type": "string",
"items": {
"enum": null,
Expand All @@ -95,4 +78,4 @@
"type": "string"
}
}
}
}
22 changes: 4 additions & 18 deletions ROOT/BillOfLadingModel.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,10 @@
"format": "uri",
"type": "string",
"description": "pki",
"enum": [
"notify",
"notifyAll",
"getClass",
"finalize"
]
"enum": ["notify", "notifyAll", "getClass", "finalize"]
},
"GoverningLaw": {
"enum": [
"MASTER_AGREEMENT",
"USCA",
"USDE",
"USIL",
"USNY",
"OTHER"
],
"enum": ["MASTER_AGREEMENT", "USCA", "USDE", "USIL", "USNY", "OTHER"],
"type": "string"
},
"Cosignee": {
Expand Down Expand Up @@ -59,10 +47,8 @@
"additionalProperties": {
"format": null,
"type": "object",
"required": [
"checksum_digit"
]
"required": ["checksum_digit"]
}
}
}
}
}
28 changes: 13 additions & 15 deletions ROOT/LoadContactInfo.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
{
"Loop_G61_204": "LoadContactInfo",
"Loop_G61_204": "LoadContactInfo",

"class": {
"class": {
"L11": "List",
"Item": "G61",

"L11": "List",
"Item": "G61",

"G61": {
"Name": "G61.Name_02",
"CommunicationNumberQualifier": "G61.CommunicationNumberQualifier_03",
"ContactFunctionCode": "G61.ContactFunctionCode_01",
"CommunicationNumber": "G61.CommunicationNumber_04",
"ContactInquiryReference": "G61.ContactInquiryReference_05"
}

}
}
"G61": {
"Name": "G61.Name_02",
"CommunicationNumberQualifier": "G61.CommunicationNumberQualifier_03",
"ContactFunctionCode": "G61.ContactFunctionCode_01",
"CommunicationNumber": "G61.CommunicationNumber_04",
"ContactInquiryReference": "G61.ContactInquiryReference_05"
}
}
}
2 changes: 1 addition & 1 deletion ROOT/SpecialHandlingCode.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@
"URC": "Lift Gate",
"ZZZ": "Mutually Defined"
}
}
}
Loading

0 comments on commit d912a26

Please sign in to comment.