Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Revise TX Overview Image #581

Merged
merged 1 commit into from Oct 3, 2014

Conversation

Projects
None yet
2 participants
Contributor

harding commented Sep 27, 2014

Preview: http://dg0.dtrt.org/en/developer-guide#transactions

  • Replace previous TX Overview image with a simplified illustration.
    The previous overview image was commented out in pull #566 / commit
    6afc683
  • Add new illustration showing the specifics of outputs and inputs (and
    how they're related). This replaces most of the detail lost by using a
    simplified overview image
  • Add two short paragraphs briefly describing the ouput and input
    features, leading into the existing detailed P2PKH description
Contributor

saivann commented Sep 27, 2014

@harding Do you think a modified illustration like the one below would make it more obvious; by showing an output actually spent, and the last output being still unspent (no arrow that suggests otherwise).

capture du 2014-09-27 14 13 17

Contributor

harding commented Sep 27, 2014

@saivann I do like that modification. I'll give it a try, revise the commit, and post an update here. Thanks!

Contributor

harding commented Sep 27, 2014

@saivann image updated. Thanks! Here's the new version:

New Version

@saivann saivann commented on an outdated diff Oct 1, 2014

_includes/guide_transactions.md
@@ -37,7 +37,22 @@ Bitcoin peers and miners which set of rules to use to validate it. This
lets developers create new rules for future transactions without
invalidating previous transactions.
-The figures below help illustrate the other transaction features by
+![Spending An Output](/img/dev/en-tx-overview-spending.svg)
+
+An output has an implied index number based on its location in the
+transaction---the first output is output zero. The output also has an
+amount in satoshis which it pays to a conditional pubkey script. Anyone
+who can satisfy the conditions of that pubkey script can spend up to the
+amount of satoshis paid to it.
+
+An input uses a transaction identifier (txid) and an output index number
+(often called "vout" for output vector) to identify a particular output to
+be spent. It also has a signature script which allows it to provide data
+parameters that satisify the conditionals in the pubkey script. (The sequence
@saivann

saivann Oct 1, 2014

Contributor

@harding s/satisify/satisfy

@saivann saivann commented on an outdated diff Oct 1, 2014

img/dev/en-tx-overview-spending.dot
+
+ subgraph cluster_outputs {
+ pubkey_script [ label = "Pubkey\nScript" ];
+ amount [ label = "Amount\n(satoshis)" ];
+ output0_label [ shape = "none", label = "Output 0\n(Implied)" ]
+ label = "Example Output Paying A Pubkey Script"
+ }
+ graph [ penwidth = 0 ];
+}
+
+subgraph cluster_tx1 {
+ subgraph cluster_inputs {
+ index [ label = "Output\nIndex" ];
+ sequence [ label = "Sequence\nNumber" ];
+ signature_script [ label = "Signature\nScript" ];
+ txid [ label = "Transaction\nIndentifier" ];
@saivann

saivann Oct 1, 2014

Contributor

s/Indentifier/Identifier

Contributor

saivann commented Oct 1, 2014

Two small typos found, otherwise LGTM, thanks!

Revise TX Overview Image
* Replace previous TX Overview image with a simplified illustration.
  The previous overview image was commented out in pull #566 / commit
  6afc683.  New image incorporates suggestions by @saivann (thanks!)

* Add new illustration showing the specifics of outputs and inputs (and
  how they're related). This replaces most of the detail lost by using a
  simplified overview image

* Add two short paragraphs briefly describing the ouput and input
  features, leading into the existing detailed P2PKH description
Contributor

harding commented Oct 1, 2014

@saivann Typos fixed. Thanks!

In the absence of critical feedback, I'll merge this pull around 23:00 UTC Thursday.

@harding harding merged commit e26b0e3 into bitcoin-dot-org:master Oct 3, 2014

harding added a commit that referenced this pull request Oct 3, 2014

@harding harding deleted the harding:tx-overview-image branch Feb 25, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment