Skip to content

Commit 1401cb7

Browse files
author
Daniel Cousens
authored
Merge pull request #114 from cryptocoinjs/dcousens-patch-1
APIv3: fix markdown formatting
2 parents 7b1a317 + cb75f25 commit 1401cb7

1 file changed

Lines changed: 27 additions & 23 deletions

File tree

API.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,97 +23,99 @@
2323
- [`.ecdh(Buffer publicKey, Buffer privateKey)`](#ecdhbuffer-publickey-buffer-privatekey---buffer)
2424
- [`.ecdhUnsafe(Buffer publicKey, Buffer privateKey [, Boolean compressed = true])`](#ecdhunsafebuffer-publickey-buffer-privatekey--boolean-compressed--true---buffer)
2525

26-
#####`.privateKeyVerify(Buffer privateKey)` -> `Boolean`
26+
<hr>
27+
28+
##### .privateKeyVerify(Buffer privateKey) -> Boolean
2729

2830
Verify an ECDSA *privateKey*.
2931

3032
<hr>
3133

32-
#####`.privateKeyExport(Buffer privateKey [, Boolean compressed = true])` -> `Buffer`
34+
##### .privateKeyExport(Buffer privateKey [, Boolean compressed = true]) -> Buffer
3335

3436
Export a *privateKey* in DER format.
3537

3638
<hr>
3739

38-
#####`.privateKeyImport(Buffer privateKey)` -> `Buffer`
40+
##### .privateKeyImport(Buffer privateKey) -> Buffer
3941

4042
Import a *privateKey* in DER format.
4143

4244
<hr>
4345

44-
#####`.privateKeyTweakAdd(Buffer privateKey, Buffer tweak)` -> `Buffer`
46+
##### .privateKeyTweakAdd(Buffer privateKey, Buffer tweak) -> Buffer
4547

4648
Tweak a *privateKey* by adding *tweak* to it.
4749

4850
<hr>
4951

50-
#####`.privateKeyTweakMul(Buffer privateKey, Buffer tweak)` -> `Buffer`
52+
##### .privateKeyTweakMul(Buffer privateKey, Buffer tweak) -> Buffer
5153

5254
Tweak a *privateKey* by multiplying it by a *tweak*.
5355

5456
<hr>
5557

56-
#####`.publicKeyCreate(Buffer privateKey [, Boolean compressed = true])` -> `Buffer`
58+
##### .publicKeyCreate(Buffer privateKey [, Boolean compressed = true]) -> Buffer
5759

5860
Compute the public key for a *privateKey*.
5961

6062
<hr>
6163

62-
#####`.publicKeyConvert(Buffer publicKey [, Boolean compressed = true])` -> `Buffer`
64+
##### .publicKeyConvert(Buffer publicKey [, Boolean compressed = true]) -> Buffer
6365

6466
Convert a *publicKey* to *compressed* or *uncompressed* form.
6567

6668
<hr>
6769

68-
#####`.publicKeyVerify(Buffer publicKey)` -> `Boolean`
70+
##### .publicKeyVerify(Buffer publicKey) -> Boolean
6971

7072
Verify an ECDSA *publicKey*.
7173

7274
<hr>
7375

74-
#####`.publicKeyTweakAdd(Buffer publicKey, Buffer tweak [, Boolean compressed = true])` -> `Buffer`
76+
##### .publicKeyTweakAdd(Buffer publicKey, Buffer tweak [, Boolean compressed = true]) -> Buffer
7577

7678
Tweak a *publicKey* by adding *tweak* times the generator to it.
7779

7880
<hr>
7981

80-
#####`.publicKeyTweakMul(Buffer publicKey, Buffer tweak [, Boolean compressed = true])` -> `Buffer`
82+
##### .publicKeyTweakMul(Buffer publicKey, Buffer tweak [, Boolean compressed = true]) -> Buffer
8183

8284
Tweak a *publicKey* by multiplying it by a *tweak* value.
8385

8486
<hr>
8587

86-
#####`.publicKeyCombine(Array<Buffer> publicKeys [, Boolean compressed = true])` -> `Buffer`
88+
##### .publicKeyCombine(Array<Buffer> publicKeys [, Boolean compressed = true]) -> Buffer
8789

8890
Add a given *publicKeys* together.
8991

9092
<hr>
9193

92-
#####`.signatureNormalize(Buffer signature)` -> `Buffer`
94+
##### .signatureNormalize(Buffer signature) -> Buffer
9395

9496
Convert a *signature* to a normalized lower-S form.
9597

9698
<hr>
9799

98-
#####`.signatureExport(Buffer signature)` -> `Buffer`
100+
##### .signatureExport(Buffer signature) -> Buffer
99101

100102
Serialize an ECDSA *signature* in DER format.
101103

102104
<hr>
103105

104-
#####`.signatureImport(Buffer signature)` -> `Buffer`
106+
##### .signatureImport(Buffer signature) -> Buffer
105107

106108
Parse a DER ECDSA *signature* (follow by [BIP66](https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki)).
107109

108110
<hr>
109111

110-
#####`.signatureImportLax(Buffer signature)` -> `Buffer`
112+
##### .signatureImportLax(Buffer signature) -> Buffer
111113

112114
Same as [signatureImport](#signatureimportbuffer-signature---buffer) but not follow by [BIP66](https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki).
113115

114116
<hr>
115117

116-
#####`.sign(Buffer message, Buffer privateKey [, Object options])` -> `{signature: Buffer, recovery: number}`
118+
##### .sign(Buffer message, Buffer privateKey [, Object options]) -> {signature: Buffer, recovery: number}
117119

118120
Create an ECDSA signature. Always return low-S signature.
119121

@@ -124,19 +126,21 @@ Inputs: 32-byte message m, 32-byte scalar key d, 32-byte scalar nonce k.
124126
* Compose 32-byte scalar s = k^-1 \* (r \* d + m). Reject nonce if s is zero.
125127
* The signature is (r, s).
126128

127-
######Option: `Function noncefn`
129+
###### Option: `Function noncefn`
128130

129131
Nonce generator. By default it is [rfc6979](https://tools.ietf.org/html/rfc6979).
130132

131-
Function signature: `noncefn(Buffer message, Buffer privateKey, ?Buffer algo, ?Buffer data, Number attempt)` -> `Buffer`
133+
Function signature:
134+
135+
##### noncefn(Buffer message, Buffer privateKey, ?Buffer algo, ?Buffer data, Number attempt) -> Buffer
132136

133-
######Option: `Buffer data`
137+
###### Option: `Buffer data`
134138

135139
Additional data for [noncefn](#option-function-noncefn) (RFC 6979 3.6) (32 bytes). By default is `null`.
136140

137141
<hr>
138142

139-
#####`.verify(Buffer message, Buffer signature, Buffer publicKey)` -> `Boolean`
143+
##### .verify(Buffer message, Buffer signature, Buffer publicKey) -> Boolean
140144

141145
Verify an ECDSA signature.
142146

@@ -151,18 +155,18 @@ Inputs: 32-byte message m, public key point Q, signature: (32-byte r, scalar s).
151155

152156
<hr>
153157

154-
#####`.recover(Buffer message, Buffer signature, Number recovery [, Boolean compressed = true])` -> `Buffer`
158+
##### .recover(Buffer message, Buffer signature, Number recovery [, Boolean compressed = true]) -> Buffer
155159

156160
Recover an ECDSA public key from a signature.
157161

158162
<hr>
159163

160-
#####`.ecdh(Buffer publicKey, Buffer privateKey)` -> `Buffer`
164+
##### .ecdh(Buffer publicKey, Buffer privateKey) -> Buffer
161165

162166
Compute an EC Diffie-Hellman secret and applied sha256 to compressed public key.
163167

164168
<hr>
165169

166-
#####`.ecdhUnsafe(Buffer publicKey, Buffer privateKey [, Boolean compressed = true])` -> `Buffer`
170+
##### .ecdhUnsafe(Buffer publicKey, Buffer privateKey [, Boolean compressed = true]) -> Buffer
167171

168172
Compute an EC Diffie-Hellman secret and return public key as result.

0 commit comments

Comments
 (0)