Skip to content

Commit bc31786

Browse files
committed
Update markdown in the README
1 parent 89bd612 commit bc31786

File tree

2 files changed

+37
-33
lines changed

2 files changed

+37
-33
lines changed

BIP32.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
BIP32 Wallets
22
-------------
33

4-
The pycoin library implements a deterministic wallet that will securly generate Bitcoin addresses compliant with
4+
The pycoin library implements a deterministic wallet that will securely generate Bitcoin addresses compliant with
55
[BIP0032].
66

77
This includes creating and parsing standard wallet keys.

README.md

+36-32
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ pycoin -- Python Cryptocoin Utilities
44
This is an implementation of a bunch of utility routines that may be useful when dealing with bitcoin and some
55
alt-coins. It has been tested with Python 2.7, 3.3, 3.4 and 3.5.
66

7-
See also http://github.com/richardkiss/pycoinnet/ for a library that speaks the bitcoin protocol.
7+
See also [pycoinnet](http://github.com/richardkiss/pycoinnet/) for a library that speaks the bitcoin protocol.
88

99
High Level
1010
==========
@@ -21,25 +21,33 @@ where P is a subkey of K, you can actually work your way up the tree to determin
2121
to the public wallet key K (unless private derivation was used at some point between the two keys)! Be sure you
2222
understand this warning before giving out public wallet keys!
2323

24-
pycoin.key.Key:
24+
`pycoin.key.Key`
25+
---------------
2526

26-
```Key(hierarchical_wallet=None, secret_exponent=None,
27-
public_pair=None, hash160=None, prefer_uncompressed=None, is_compressed=True, netcode)```
27+
```
28+
Key(hierarchical_wallet=None,
29+
secret_exponent=None,
30+
public_pair=None,
31+
hash160=None,
32+
prefer_uncompressed=None,
33+
is_compressed=True,
34+
netcode)
35+
```
2836

29-
Specify one of "hierarchical_wallet, secret_exponent, public_pair or hash160" to create a ```Key```.
37+
Specify one of "hierarchical_wallet, secret_exponent, public_pair or hash160" to create a `Key`.
3038

3139
Or
3240

33-
```Key.from_text(b58_text)``` accepts an address (bitcoin or other), a WIF, or a BIP32 wallet string and yield a Key.
41+
`Key.from_text(b58_text)` accepts an address (bitcoin or other), a WIF, or a BIP32 wallet string and yield a Key.
3442

35-
```Key.from_sec(sec)``` creates a Key from the SEC bytestream encoding of a public pair.
43+
`Key.from_sec(sec)` creates a Key from the SEC bytestream encoding of a public pair.
3644

3745

3846
pycoin.key.BIP32Node (formerly pycoin.wallet.Wallet) provides a BIP32 hierarchical wallet.
3947

40-
Much of this API is exposed in the ```ku``` command-line utility. See also COMMAND-LINE-TOOLS.md.
48+
Much of this API is exposed in the `ku` command-line utility. See also [COMMAND-LINE-TOOLS.md](./COMMAND-LINE-TOOLS.md).
4149

42-
See ```BIP32.txt``` for more information.
50+
See [BIP32.txt](./BIP32.txt) for more information.
4351

4452

4553
Transactions
@@ -48,37 +56,37 @@ Transactions
4856
pycoin.tx.Tx is a class that wraps a bitcoin transaction. You can create, edit, sign, or validate a transaction using
4957
methods in this class.
5058

51-
You can also use ```pycoin.tx.tx_utils``` which has ```create_tx``` and ```create_signed_tx```, which gives you a
59+
You can also use `pycoin.tx.tx_utils` which has `create_tx` and `create_signed_tx`, which gives you a
5260
very easy way to create signed transactions.
5361

54-
The command-line utility ```tx``` is a Swiss Army knife of transaction utilities. See also COMMAND-LINE-TOOLS.md.
62+
The command-line utility `tx` is a Swiss Army knife of transaction utilities. See also [COMMAND-LINE-TOOLS.md](./COMMAND-LINE-TOOLS.md).
5563

5664

5765
Services
5866
--------
5967

6068
When signing or verifying signatures on a transaction, the source transactions are generally needed. If you set two
61-
environment variables in your ```.profile``` like this:
69+
environment variables in your `.profile` like this:
6270

6371
PYCOIN_CACHE_DIR=~/.pycoin_cache
6472
PYCOIN_BTC_PROVIDERS="blockr.io blockchain.info blockr.io blockexplorer.com"
6573
export PYCOIN_CACHE_DIR PYCOIN_BTC_PROVIDERS
6674

67-
and then ```tx``` will automatically fetch transactions from the web sites listed and cache the results in
68-
```PYCOIN_CACHE_DIR``` when they are needed.
75+
and then `tx` will automatically fetch transactions from the web sites listed and cache the results in
76+
`PYCOIN_CACHE_DIR` when they are needed.
6977

70-
(The old syntax with ```PYCOIN_SERVICE_PROVIDERS``` is deprecated.)
78+
(The old syntax with `PYCOIN_SERVICE_PROVIDERS` is deprecated.)
7179

72-
The module pycoin.services includes two functions ```spendables_for_address```, ```get_tx_db``` that look at the
80+
The module pycoin.services includes two functions `spendables_for_address`, `get_tx_db` that look at the
7381
environment variables set to determine which web sites to use to fetch the underlying information. The sites are
7482
polled in the order they are listed in the environment variable.
7583

7684

7785
Blocks
7886
------
7987

80-
The command-line utility ```block``` will dump a block in a human-readable format. For further information, look at
81-
```pycoin.block```, which includes the object ```Block``` which will parse and stream the binary format of a block.
88+
The command-line utility `block` will dump a block in a human-readable format. For further information, look at
89+
`pycoin.block`, which includes the object `Block` which will parse and stream the binary format of a block.
8290

8391

8492
Low Level
@@ -87,10 +95,10 @@ Low Level
8795
ECDSA Signing and Verification
8896
------------------------------
8997

90-
The module ```pycoin.ecdsa``` deals with ECDSA keys directly. Important structures include:
98+
The module `pycoin.ecdsa` deals with ECDSA keys directly. Important structures include:
9199

92-
- the ```secret_exponent``` (a large integer that represents a private key)
93-
- the ```public_pair``` (a pair of large integers x and y that represent a public key)
100+
- the `secret_exponent` (a large integer that represents a private key)
101+
- the `public_pair` (a pair of large integers x and y that represent a public key)
94102

95103
There are a handful of functions: you can do things like create a signature, verify a signature, generate the public
96104
pair from the secret exponent, and flush out the public pair from just the x value (there are two possible values
@@ -100,7 +108,7 @@ for y of opposite even/odd parity, so you include a flag indicating which value
100108
Encoding
101109
--------
102110

103-
The ```pycoin.encoding``` module declares some conversion utilities useful when dealing with Bitcoin. Important
111+
The `pycoin.encoding` module declares some conversion utilities useful when dealing with Bitcoin. Important
104112
structures include:
105113

106114
* base58 (the encoding used for Bitcoin addresses)
@@ -116,15 +124,11 @@ Users
116124

117125
Here's a partial list of users of pycoin:
118126

119-
ChangeTip https://changetip.com/
120-
121-
GreenAddress https://greenaddress.it/
122-
123-
Coinkite https://coinkite.com/
124-
125-
Wall of Coins https://wallofcoins.com/
126-
127-
Blockonomics https://www.blockonomics.co/
127+
* [ChangeTip](https://changetip.com/)
128+
* [GreenAddress](https://greenaddress.it/)
129+
* [Coinkite](https://coinkite.com/)
130+
* [Wall of Coins](https://wallofcoins.com/)
131+
* [Blockonomics](https://www.blockonomics.co/)
128132

129133
Email me at him@richardkiss.com to be added to this list.
130134

@@ -147,4 +151,4 @@ Want to donate? Feel free. Send to 1KissFDVu2wAYWPRm4UGh5ZCDU9sE9an8T.
147151
I'm also available for bitcoin consulting... him@richardkiss.com.
148152

149153

150-
[BIP0032]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki
154+
[BIP0032](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)

0 commit comments

Comments
 (0)