Skip to content

Commit 6d4bf4e

Browse files
committed
[FAB-11102] Visual Vocab
Added images from our visual vocabulary library to the Glossary & updated definition for Block. Change-Id: I89f7694cd04c3828e3c48fdd2bb47b2178abcc85 Signed-off-by: pama-ibm <pama@ibm.com>
1 parent c4fe7e6 commit 6d4bf4e

File tree

1 file changed

+95
-4
lines changed

1 file changed

+95
-4
lines changed

docs/source/glossary.rst

Lines changed: 95 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,42 @@ on a per profile basis in the "Profiles" section.
4949

5050
.. _Block:
5151

52+
5253
Block
5354
-----
5455

55-
An ordered set of transactions that is cryptographically linked to the
56-
preceding block(s) on a channel.
56+
.. figure:: ./glossary/glossary.block.png
57+
:scale: 50 %
58+
:align: right
59+
:figwidth: 40 %
60+
:alt: A Block
61+
62+
Block B1 is linked to block B0. Block B2 is linked to block B1.
63+
64+
=======
65+
66+
A block contains an ordered set of transactions. It is cryptographically linked
67+
to the preceding block, and in turn it is linked to be subsequent blocks. The
68+
first block in such a chain of blocks is called the **genesis block**. Blocks
69+
are created by the ordering system, and validated by peers.
70+
5771

5872
.. _Chain:
5973

74+
6075
Chain
6176
-----
6277

78+
.. figure:: ./glossary/glossary.blockchain.png
79+
:scale: 75 %
80+
:align: right
81+
:figwidth: 40 %
82+
:alt: Blockchain
83+
84+
Blockchain B contains blocks 0, 1, 2.
85+
86+
=======
87+
6388
The ledger's chain is a transaction log structured as hash-linked blocks of
6489
transactions. Peers receive blocks of transactions from the ordering service, mark
6590
the block's transactions as valid or invalid based on endorsement policies and
@@ -75,9 +100,20 @@ See Smart-Contract_.
75100

76101
.. _Channel:
77102

103+
78104
Channel
79105
-------
80106

107+
.. figure:: ./glossary/glossary.channel.png
108+
:scale: 30 %
109+
:align: right
110+
:figwidth: 40 %
111+
:alt: A Channel
112+
113+
Channel C connects application A1, peer P2 and ordering service O1.
114+
115+
=======
116+
81117
A channel is a private blockchain overlay which allows for data
82118
isolation and confidentiality. A channel-specific ledger is shared across the
83119
peers in the channel, and transacting parties must be properly authenticated to
@@ -262,9 +298,18 @@ the same organization.
262298

263299
.. _Ledger:
264300

301+
265302
Ledger
266303
------
267-
THIS REQUIRES UPDATING
304+
305+
.. figure:: ./glossary/glossary.ledger.png
306+
:scale: 25 %
307+
:align: right
308+
:figwidth: 20 %
309+
:alt: A Ledger
310+
311+
A Ledger, 'L'
312+
268313

269314
A ledger consists of two distinct, though related, parts -- a "blockchain" and
270315
the "state database", also known as "world state". Unlike other ledgers,
@@ -294,6 +339,15 @@ See Organization_.
294339
Membership Service Provider
295340
---------------------------
296341

342+
.. figure:: ./glossary/glossary.msp.png
343+
:scale: 35 %
344+
:align: right
345+
:figwidth: 25 %
346+
:alt: An MSP
347+
348+
An MSP, 'ORG.MSP'
349+
350+
297351
The Membership Service Provider (MSP) refers to an abstract component of the
298352
system that provides credentials to clients, and peers for them to participate
299353
in a Hyperledger Fabric network. Clients use these credentials to authenticate
@@ -329,7 +383,20 @@ identity material tied to each Member_.
329383
.. _Organization:
330384

331385
Organization
332-
-----------------
386+
------------
387+
388+
=====
389+
390+
391+
.. figure:: ./glossary/glossary.organization.png
392+
:scale: 25 %
393+
:align: right
394+
:figwidth: 20 %
395+
:alt: An Organization
396+
397+
An organization, 'ORG'
398+
399+
333400
Also known as "members", organizations are invited to join the blockchain network
334401
by a blockchain service provider. An organization is joined to a network by adding its
335402
Membership Service Provider (MSP_) to the network. The MSP defines how other members of the
@@ -346,6 +413,14 @@ will be part of a consortium.
346413
Peer
347414
----
348415

416+
.. figure:: ./glossary/glossary.peer.png
417+
:scale: 25 %
418+
:align: right
419+
:figwidth: 20 %
420+
:alt: A Peer
421+
422+
A peer, 'P'
423+
349424
A network entity that maintains a ledger and runs chaincode containers in order to perform
350425
read/write operations to the ledger. Peers are owned and maintained by members.
351426

@@ -467,6 +542,14 @@ channels relative to their aligned and varying business agendas.
467542
Transaction
468543
-----------
469544

545+
.. figure:: ./glossary/glossary.transaction.png
546+
:scale: 30 %
547+
:align: right
548+
:figwidth: 20 %
549+
:alt: A Transaction
550+
551+
A transaction, 'T'
552+
470553
Invoke or instantiate results that are submitted for ordering, validation, and commit.
471554
Invokes are requests to read/write data from the ledger. Instantiate is a request to
472555
start and initialize a chaincode on a channel. Application clients gather invoke or
@@ -478,6 +561,14 @@ into a transaction that is submitted for ordering, validation, and commit.
478561
World State
479562
-----------
480563

564+
.. figure:: ./glossary/glossary.worldstate.png
565+
:scale: 40 %
566+
:align: right
567+
:figwidth: 25 %
568+
:alt: Current State
569+
570+
The World State, 'W'
571+
481572
Also known as the “current state”, the world state is a component of the
482573
HyperLedger Fabric :ref:`Ledger`. The world state represents the latest values
483574
for all keys included in the chain transaction log. Chaincode executes

0 commit comments

Comments
 (0)