Skip to content

Commit 6d701a3

Browse files
committed
Improvements to BIP 122
Grammar, punctuation and labeling improvements meant to clarify the BIP and improve readability.
1 parent 2010cf4 commit 6d701a3

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

bip-0122.mediawiki

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010

1111
==Abstract==
1212

13-
This BIP propose an URI scheme for looking up blocks, transactions, addresses on a Blockchain explorer, or in general to make proper Blockchain references
13+
This BIP proposes a URI scheme for looking up blocks, transactions and addresses on a Blockchain explorer, or in general to make proper Blockchain references.
1414

1515
==Motivation==
1616

1717
The purpose of this URI scheme is to enable users to handle all the requests for details about blocks, transactions, etc. with their preferred tool (being that a web service or a local application).
18-
Currently a Bitcoin client usually points to an arbitrary blockchain explorer when the user looks for the details of a transaction, or let him choose from a limited list of possible alternatives.
19-
Other times resorting to cut&paste is needed.
18+
Currently a Bitcoin client usually points to an arbitrary blockchain explorer when the user looks for the details of a transaction or allows the user to choose from a set of alternatives.
19+
Resorting to copy + paste into a browser is often required.
2020
The same happens with posts and messages that reference some particular txs or blocks, if they provide links at all.
2121

2222
==Specification==
@@ -30,7 +30,7 @@ Where:
3030
{| class="wikitable"
3131
! style="text-align: center;" | Element
3232
! colspan="2" style="text-align: center;" | Description
33-
!
33+
! Required?
3434
|-
3535
| chain
3636
| colspan="2" | '''chain ID''' (see below) of the desired chain, leading 0s included. If omitted (which would be the usual case), Bitcoin main net is assumed.
@@ -39,7 +39,7 @@ Where:
3939
| rowspan="3" | type
4040
| tx
4141
| for transactions.
42-
| rowspan="3" |
42+
| rowspan="3" | required
4343
|-
4444
| block
4545
| for blocks (supports both hash or height).
@@ -49,7 +49,7 @@ Where:
4949
|-
5050
| hash
5151
| colspan="2" | the relevant hash to refer to (leading zeros included), or block height.
52-
|
52+
| required
5353
|}
5454

5555
====ABNF grammar====
@@ -104,20 +104,20 @@ A transaction on Bitcoin test net:
104104

105105
==Rationale==
106106

107-
From the point of view of a wallet (or other Blockchain related tool) developer that need to show any kind of Blockchain references, using this scheme mean that he can simply make it a blockchain: link and be done with it, without having to worry about any specific Blockchain explorer or provide a means for the user to select one.
107+
From the point of view of a wallet (or other Blockchain related tool) developers which need to reference Blockchain data, using this scheme mean that he can simply make it a `blockchain:` link without having to worry about any specific Blockchain explorer or provide a means for the user to select one.
108108

109-
Blockchain explorers in turn will simply offer to handle the blockchain: URI, the first time the user visit their website, or launch/install the application, or even set themselves if there isn't already one.
109+
Blockchain explorers in turn will simply offer to handle the `blockchain:` URI schema, the first time the user visit their website, or launch/install the application, or even set themselves if there isn't already one.
110110

111-
Users get the convenience of using always their preferred explorer, which can be especially handy on mobile devices, where juggling with cut&paste is far from ideal.
111+
Users can link directly to their preferred block explorer (avoiding copy + paste which can be awkward on mobile devices).
112112

113113
== Sample implementation ==
114114

115115
[https://github.com/MarcoPon/blockchain-exploration Demo Blockchain: URI handler on GitHub]
116116

117117
==Acknowledgements==
118-
Thanks to Btc Drak for suggesting to provide support for different networks.
119-
Thanks to Jorge Timon for the idea of using genesis blocks hashes to identify them.
120-
Thanks to Richard Moore, Matt Whitlock, Andreas Schildbach for suggestions about the structure and hierarchy of the URI scheme.
118+
119+
Thanks to Btc Drak for suggesting support for different networks and Jorge Timon for the suggestion that we could identify each network by its genesis block hash.
120+
Thanks to Richard Moore, Matt Whitlock, Andreas Schildbach for help with the structure and hierarchy of the URI scheme.
121121

122122
==Copyright==
123123

0 commit comments

Comments
 (0)