Skip to content

Commit f8065f9

Browse files
committed
FAB-3153 Whitespace fixes (docs)
Change-Id: Idf36895256d6fcd1eabd4f44dc72f7449ac7cd86 Signed-off-by: Jessica Wagantall <[email protected]>
1 parent 05de667 commit f8065f9

16 files changed

+114
-114
lines changed

docs/source/FAQ/chaincode_FAQ.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ executed and validated by chain validators together during the consensus
1111
process. Developers can use chaincodes to develop business contracts,
1212
asset definitions, and collectively-managed decentralized applications.
1313

14-
* How do I create a business contract using the fabric?
14+
* How do I create a business contract using the fabric?
1515

1616
There are generally two ways to develop business contracts: the first way is to
1717
code individual contracts into standalone instances of chaincode; the
@@ -20,7 +20,7 @@ create decentralized applications that manage the life cycle of one or
2020
multiple types of business contracts, and let end users instantiate
2121
instances of contracts within these applications.
2222

23-
* How do I create assets using the fabric?
23+
* How do I create assets using the fabric?
2424

2525
Users can use chaincode (for business rules) and membership service (for digital tokens) to
2626
design assets, as well as the logic that manages them.
@@ -35,7 +35,7 @@ fabric does not advocate either one over the other. Instead, one of our
3535
first requirements was to ensure that both approaches can be easily
3636
implemented with tools available in the fabric.
3737

38-
* Which languages are supported for writing chaincode?
38+
* Which languages are supported for writing chaincode?
3939

4040
Chaincode can be written in any programming language and executed in containers
4141
inside the fabric context layer. We are also looking into developing a
@@ -49,7 +49,7 @@ additional languages and the development of a fabric-specific templating
4949
language have been discussed, and more details will be released in the
5050
near future.
5151

52-
* Does the fabric have native currency?
52+
* Does the fabric have native currency?
5353

5454
No. However, if you really need a native currency for your chain network, you can develop your own
5555
native currency with chaincode. One common attribute of native currency

docs/source/FAQ/confidentiality_FAQ.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ known only to their originators, validators, and authorized auditors.
1919
Only holders of the secret keys can interpret transaction contents.
2020

2121
* What if none of the stakeholders of a business contract are
22-
validators?
22+
validators?
2323

2424
In some business scenarios, full confidentiality of contract
2525
logic may be required – such that only contract counterparties and

docs/source/FAQ/consensus_FAQ.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Consensus Algorithm
22
-------------------
33

4-
Which Consensus Algorithm is used in Fabric?
4+
Which Consensus Algorithm is used in Fabric?
55

66
The fabric is built on a pluggable architecture such that developers can configure
77
their deployment with the consensus module that best suits their needs.

docs/source/FAQ/identity_management_FAQ.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Identity Management (Membership Service)
22
----------------------------------------
33

4-
* What is unique about the fabric's Membership Service module?
4+
* What is unique about the fabric's Membership Service module?
55

66
One of the things that makes the Membership Service module stand out from
77
the pack is our implementation of the latest advances in cryptography.

docs/source/FAQ/usage_FAQ.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Usage
22
-----
33

4-
* What are the expected performance figures for the fabric?
4+
* What are the expected performance figures for the fabric?
55

66
The performance of any chain network depends on several factors: proximity
77
of the validating nodes, number of validators, encryption method,
@@ -15,7 +15,7 @@ continuously improving the performance and the scalability of the
1515
system.
1616

1717
* Do I have to own a validating node to transact on a chain
18-
network?
18+
network?
1919

2020
No. You can still transact on a chain network by owning a
2121
non-validating node (NV-node).
@@ -32,7 +32,7 @@ In addition, NV-nodes retain full copies of the ledger, enabling local
3232
queries of the ledger data.
3333

3434
* What does the error string "state may be inconsistent, cannot
35-
query" as a query result mean?
35+
query" as a query result mean?
3636

3737
Sometimes, a validating peer will be out
3838
of sync with the rest of the network. Although determining this

docs/source/Setup/TLSSetup.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Steps to enable TLS for all sever (ECA , ACA , TLSCA , TCA) and between ACA clie
1010
serverhostoverride:
1111
tls_enabled: false
1212
client:
13-
cert:
13+
cert:
1414
file:
1515

1616
To enable TLS between the ACA client and the rest of the CA Services
@@ -45,7 +45,7 @@ output of the form:
4545
Subject Public Key Info:
4646
Public Key Algorithm: id-ecPublicKey
4747
EC Public Key:
48-
pub:
48+
pub:
4949
04:38:d2:62:75:4a:18:d9:f7:fe:6a:e7:df:32:e2:
5050
15:0f:01:9c:1b:4f:dc:ff:22:97:5c:2a:d9:5c:c3:
5151
a3:ef:e3:90:3b:3c:8a:d2:45:b1:60:11:94:5e:a7:
@@ -55,16 +55,16 @@ output of the form:
5555
X509v3 extensions:
5656
X509v3 Key Usage: critical
5757
Digital Signature, Key Encipherment
58-
X509v3 Extended Key Usage:
58+
X509v3 Extended Key Usage:
5959
TLS Web Server Authentication
6060
X509v3 Basic Constraints: critical
6161
CA:FALSE
62-
X509v3 Subject Key Identifier:
62+
X509v3 Subject Key Identifier:
6363
E8:9C:86:81:59:D4:D7:76:43:C7:2E:92:88:30:1B:30:A5:B3:A4:5C
64-
X509v3 Authority Key Identifier:
64+
X509v3 Authority Key Identifier:
6565
keyid:5E:33:AC:E0:9D:B9:F9:71:5F:1F:96:B5:84:85:35:BE:89:8C:35:C2
6666

67-
X509v3 Subject Alternative Name:
67+
X509v3 Subject Alternative Name:
6868
DNS:www.example.com
6969
Signature Algorithm: ecdsa-with-SHA256
7070
30:45:02:21:00:9f:7e:93:93:af:3d:cf:7b:77:f0:55:2d:57:

docs/source/Style-guides/go-style.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Coding guidelines
22
-----------------
33

4-
Coding Golang
4+
Coding Golang
55
~~~~~~~~~~~~~~
66

77
We code in Go™ and strictly follow the `best
@@ -12,7 +12,7 @@ code and fix all errors and warnings: -
1212
vet <https://golang.org/cmd/vet/>`__ -
1313
`goimports <https://godoc.org/golang.org/x/tools/cmd/goimports>`__
1414

15-
Generating gRPC code
15+
Generating gRPC code
1616
---------------------
1717

1818
If you modify any ``.proto`` files, run the following command to

docs/source/biz/usecases.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ Key Components
188188
interrogate the chaincode that defines an asset type. If an asset
189189
represents shares of publicly traded companies, then the view access
190190
right must be granted to every entity on the network.
191-
191+
192192

193193
One Trade, One Contract
194194
-----------------------

docs/source/case_for_fabric.rst

+55-55
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,71 @@
11
The Case for Fabric
22
===================
33

4-
Hyperledger Fabric is a social innovation that is about to free innovators in startups,
5-
enterprises and government to transform and radically reduce the cost of working together
6-
across organizations. By the end of this section, you should have the essential understanding
4+
Hyperledger Fabric is a social innovation that is about to free innovators in startups,
5+
enterprises and government to transform and radically reduce the cost of working together
6+
across organizations. By the end of this section, you should have the essential understanding
77
of Fabric you need to start *knitting* together a great business network.
88

9-
Fabric is a network of networks, like the Internet itself. An application can use one or more
10-
networks, each managing different :ref:`Assets`, Agreements and Transactions between different
11-
sets of :ref:`Member` s. In Fabric, the Ordering Service is the foundation of each network.
12-
The founder of a network selects an Ordering Service (or creates a new one) and passes in a
13-
config file with the rules (usually called Policies) that govern it. Examples of these rules
14-
include setting/defining which Members can join the network, how Members can be added or removed,
15-
and configuration details like block size. While it is possible for one company to set and control
16-
these rules as a "dictator," typically these rules will also include policies that make changing
17-
the rules a matter of consensus among the members of the network. Fabric also requires some level of
18-
"endorsement" in order to transact. Check out the power and intricacy of :doc:`endorsement-policies`
19-
, which are used across the Fabric landscape - from a consortium's network configuration to a simple
9+
Fabric is a network of networks, like the Internet itself. An application can use one or more
10+
networks, each managing different :ref:`Assets`, Agreements and Transactions between different
11+
sets of :ref:`Member` s. In Fabric, the Ordering Service is the foundation of each network.
12+
The founder of a network selects an Ordering Service (or creates a new one) and passes in a
13+
config file with the rules (usually called Policies) that govern it. Examples of these rules
14+
include setting/defining which Members can join the network, how Members can be added or removed,
15+
and configuration details like block size. While it is possible for one company to set and control
16+
these rules as a "dictator," typically these rules will also include policies that make changing
17+
the rules a matter of consensus among the members of the network. Fabric also requires some level of
18+
"endorsement" in order to transact. Check out the power and intricacy of :doc:`endorsement-policies`
19+
, which are used across the Fabric landscape - from a consortium's network configuration to a simple
2020
read operation.
2121

22-
We mentioned that the Ordering Service (OS) is the foundation of the network, and you're probably
23-
thinking, "It must do something beyond just ordering." Well you're right! All members and entities
24-
in the network will be tied to a higher level certificate authority, and this authority is defined
25-
within the configuration of the Ordering Service. As a result, the OS can verify and authenticate
26-
transactions arriving from any corner of the network. The OS plays a central and critical role in
27-
the functionality and integrity of the network, and skeptics might fear too much centralization of
28-
power and responsibility. After all, that's a principal feature of shared ledger technology - to
29-
decentralize the control and provide a foundation of trust with entities who you CAN'T wholeheartedly
30-
trust. Well let's assuage that fear. The OS is agnostic to transaction details; it simply orders on
31-
a first-come-first-serve basis and returns blocks to their corresponding channels. Perhaps more
32-
importantly though, control of the ordering service can be shared and co-administered by the
33-
participating members in the network. OR, if even that solution is untenable, then the OS can be
34-
hosted and maintained by a trusted third-party. Fabric is built upon a modular and pluggable
35-
architecture, so the only real decision for business networks is how to configure an OS to meet
36-
their requirements.
22+
We mentioned that the Ordering Service (OS) is the foundation of the network, and you're probably
23+
thinking, "It must do something beyond just ordering." Well you're right! All members and entities
24+
in the network will be tied to a higher level certificate authority, and this authority is defined
25+
within the configuration of the Ordering Service. As a result, the OS can verify and authenticate
26+
transactions arriving from any corner of the network. The OS plays a central and critical role in
27+
the functionality and integrity of the network, and skeptics might fear too much centralization of
28+
power and responsibility. After all, that's a principal feature of shared ledger technology - to
29+
decentralize the control and provide a foundation of trust with entities who you CAN'T wholeheartedly
30+
trust. Well let's assuage that fear. The OS is agnostic to transaction details; it simply orders on
31+
a first-come-first-serve basis and returns blocks to their corresponding channels. Perhaps more
32+
importantly though, control of the ordering service can be shared and co-administered by the
33+
participating members in the network. OR, if even that solution is untenable, then the OS can be
34+
hosted and maintained by a trusted third-party. Fabric is built upon a modular and pluggable
35+
architecture, so the only real decision for business networks is how to configure an OS to meet
36+
their requirements.
3737

38-
(This notion of the OS as a pluggable component also opens the door to exciting opportunities for
39-
innovative teams and individuals. Currently there are only a few OS orchestrations - Solo and Kafka.
40-
However, other options such as Intel's PoET or BFT flavors could be powerful supplementaries to Fabric,
38+
(This notion of the OS as a pluggable component also opens the door to exciting opportunities for
39+
innovative teams and individuals. Currently there are only a few OS orchestrations - Solo and Kafka.
40+
However, other options such as Intel's PoET or BFT flavors could be powerful supplementaries to Fabric,
4141
and help solve challenging use cases.)
4242

43-
To participate in the Network, each Organization maintains a runtime called a :ref:`Peer`, which will
44-
allow an application to participate in Transactions, interact with the Ordering Service, and maintain
45-
a set of ledgers. Notice we said a set of ledgers. One of Fabric's key innovations is the ability to
46-
run multiple :ref:`Channel` s on each network. This is how a network can conduct both highly confidential
47-
bilateral transactions and multilateral, or even public, transactions in the same solution without
48-
everyone having a copy of every transaction or run the code in every agreement. Watch how Fabric is
43+
To participate in the Network, each Organization maintains a runtime called a :ref:`Peer`, which will
44+
allow an application to participate in Transactions, interact with the Ordering Service, and maintain
45+
a set of ledgers. Notice we said a set of ledgers. One of Fabric's key innovations is the ability to
46+
run multiple :ref:`Channel` s on each network. This is how a network can conduct both highly confidential
47+
bilateral transactions and multilateral, or even public, transactions in the same solution without
48+
everyone having a copy of every transaction or run the code in every agreement. Watch how Fabric is
4949
Building a Blockchain for Business .
5050

51-
If you're still reading, you clearly have some knowledge and an interest in distributed ledger
52-
technology, AND you probably think a key piece is missing. Where is consensus in all of this? Well,
53-
it's embedded in the entire life cycle of a transaction. Transactions come into the network, and the
54-
submitting client's identity is verified and consented upon. Transactions then get executed and endorsed,
55-
and these endorsements are consented upon. Transactions get ordered, and the validity of this order is
56-
consented upon. Finally, transactions get committed to a shared ledger, and each transaction's subsequent
57-
impact on the state of the involved asset(s) is consented upon. Consensus isn't pigeonholed into one
58-
module or one function. It lives and exists throughout the entire DNA of Fabric. Fabric is built
59-
with security at the forefront, not as an afterthought. Members and participating entities operate with
60-
known identities, no action on the network circumvents the sign/verify/authenticate mandate. Requirements
61-
such as security, privacy and confidentiality are paramount in some manner to nearly all business dealings,
62-
and they, like consensus, are stitched into the very essence of Fabric.
51+
If you're still reading, you clearly have some knowledge and an interest in distributed ledger
52+
technology, AND you probably think a key piece is missing. Where is consensus in all of this? Well,
53+
it's embedded in the entire life cycle of a transaction. Transactions come into the network, and the
54+
submitting client's identity is verified and consented upon. Transactions then get executed and endorsed,
55+
and these endorsements are consented upon. Transactions get ordered, and the validity of this order is
56+
consented upon. Finally, transactions get committed to a shared ledger, and each transaction's subsequent
57+
impact on the state of the involved asset(s) is consented upon. Consensus isn't pigeonholed into one
58+
module or one function. It lives and exists throughout the entire DNA of Fabric. Fabric is built
59+
with security at the forefront, not as an afterthought. Members and participating entities operate with
60+
known identities, no action on the network circumvents the sign/verify/authenticate mandate. Requirements
61+
such as security, privacy and confidentiality are paramount in some manner to nearly all business dealings,
62+
and they, like consensus, are stitched into the very essence of Fabric.
6363

64-
So what problem do you want to solve? What assets are at stake? Who are the players? What levels of
65-
security and encryption do you need? Fabric is designed to provide an answer and solution to this
66-
challenging collective of questions and beyond. Just like fabric - in the literal sense of the word - is
67-
used in everything from airplane seats to bespoke suits, solutions built on Hyperledger Fabric can range
68-
from diamond provenance to equities trading. Explore the documentation and see how you can leverage Fabric
64+
So what problem do you want to solve? What assets are at stake? Who are the players? What levels of
65+
security and encryption do you need? Fabric is designed to provide an answer and solution to this
66+
challenging collective of questions and beyond. Just like fabric - in the literal sense of the word - is
67+
used in everything from airplane seats to bespoke suits, solutions built on Hyperledger Fabric can range
68+
from diamond provenance to equities trading. Explore the documentation and see how you can leverage Fabric
6969
to craft a PoC for your own business network.
7070

7171

docs/source/chaincode.rst

+18-18
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ languages such as Go or Java. It is installed and instantiated through
1111
an SDK or CLI onto a network of Hyperledger Fabric peer nodes, enabling
1212
interaction with that network's shared ledger.
1313

14-
There are three aspects to chaincode development:
14+
There are three aspects to chaincode development:
1515

1616
* Chaincode Interfaces
17-
* APIs
17+
* APIs
1818
* Chaincode Responses
1919

2020
Chaincode interfaces
2121
--------------------
2222

2323
A chaincode implements the Chaincode Interface that supports two
24-
methods:
24+
methods:
2525

26-
* ``Init``
26+
* ``Init``
2727
* ``Invoke``
2828

2929
Init()
@@ -45,10 +45,10 @@ Dependencies
4545
------------
4646

4747
The import statement lists a few dependencies for the chaincode to
48-
compile successfully.
48+
compile successfully.
4949

5050
* fmt – contains ``Println`` for debugging/logging.
51-
* errors – standard go error format.
51+
* errors – standard go error format.
5252
* `shim <https://github.com/hyperledger/fabric/tree/master/core/chaincode/shim>`__ – contains the definitions for the chaincode interface and the chaincode stub, which are required to interact with the ledger.
5353

5454
Chaincode APIs
@@ -80,7 +80,7 @@ The chaincode response comes in the form of a protobuffer.
8080

8181
.. code:: go
8282
83-
message Response {
83+
message Response {
8484
8585
// A status code that should follow the HTTP status codes.
8686
int32 status = 1;
@@ -98,32 +98,32 @@ events.
9898

9999
.. code:: go
100100
101-
messageEvent {
101+
messageEvent {
102102
103103
oneof Event {
104104
105-
//Register consumer sent event
105+
//Register consumer sent event
106106
Register register = 1;
107107
108-
//producer events common.
109-
Block block = 2;
110-
ChaincodeEvent chaincodeEvent = 3;
108+
//producer events common.
109+
Block block = 2;
110+
ChaincodeEvent chaincodeEvent = 3;
111111
Rejection rejection = 4;
112112
113-
//Unregister consumer sent events
114-
Unregister unregister = 5;
113+
//Unregister consumer sent events
114+
Unregister unregister = 5;
115115
116-
}
116+
}
117117
118118
}
119119
120120
.. code:: go
121121
122122
messageChaincodeEvent {
123123
124-
string chaincodeID = 1;
125-
string txID = 2;
126-
string eventName = 3;
124+
string chaincodeID = 1;
125+
string txID = 2;
126+
string eventName = 3;
127127
bytes payload = 4;
128128
129129
}

0 commit comments

Comments
 (0)