Skip to content

Commit

Permalink
Merge pull request cryptocoinjs#114 from cryptocoinjs/dcousens-patch-1
Browse files Browse the repository at this point in the history
APIv3: fix markdown formatting
  • Loading branch information
dcousens committed Oct 2, 2017
2 parents 7b1a317 + cb75f25 commit 1401cb7
Showing 1 changed file with 27 additions and 23 deletions.
50 changes: 27 additions & 23 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,97 +23,99 @@
- [`.ecdh(Buffer publicKey, Buffer privateKey)`](#ecdhbuffer-publickey-buffer-privatekey---buffer)
- [`.ecdhUnsafe(Buffer publicKey, Buffer privateKey [, Boolean compressed = true])`](#ecdhunsafebuffer-publickey-buffer-privatekey--boolean-compressed--true---buffer)

#####`.privateKeyVerify(Buffer privateKey)` -> `Boolean`
<hr>

##### .privateKeyVerify(Buffer privateKey) -> Boolean

Verify an ECDSA *privateKey*.

<hr>

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

Export a *privateKey* in DER format.

<hr>

#####`.privateKeyImport(Buffer privateKey)` -> `Buffer`
##### .privateKeyImport(Buffer privateKey) -> Buffer

Import a *privateKey* in DER format.

<hr>

#####`.privateKeyTweakAdd(Buffer privateKey, Buffer tweak)` -> `Buffer`
##### .privateKeyTweakAdd(Buffer privateKey, Buffer tweak) -> Buffer

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

<hr>

#####`.privateKeyTweakMul(Buffer privateKey, Buffer tweak)` -> `Buffer`
##### .privateKeyTweakMul(Buffer privateKey, Buffer tweak) -> Buffer

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

<hr>

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

Compute the public key for a *privateKey*.

<hr>

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

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

<hr>

#####`.publicKeyVerify(Buffer publicKey)` -> `Boolean`
##### .publicKeyVerify(Buffer publicKey) -> Boolean

Verify an ECDSA *publicKey*.

<hr>

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

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

<hr>

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

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

<hr>

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

Add a given *publicKeys* together.

<hr>

#####`.signatureNormalize(Buffer signature)` -> `Buffer`
##### .signatureNormalize(Buffer signature) -> Buffer

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

<hr>

#####`.signatureExport(Buffer signature)` -> `Buffer`
##### .signatureExport(Buffer signature) -> Buffer

Serialize an ECDSA *signature* in DER format.

<hr>

#####`.signatureImport(Buffer signature)` -> `Buffer`
##### .signatureImport(Buffer signature) -> Buffer

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

<hr>

#####`.signatureImportLax(Buffer signature)` -> `Buffer`
##### .signatureImportLax(Buffer signature) -> Buffer

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

<hr>

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

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

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

######Option: `Function noncefn`
###### Option: `Function noncefn`

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

Function signature: `noncefn(Buffer message, Buffer privateKey, ?Buffer algo, ?Buffer data, Number attempt)` -> `Buffer`
Function signature:

##### noncefn(Buffer message, Buffer privateKey, ?Buffer algo, ?Buffer data, Number attempt) -> Buffer

######Option: `Buffer data`
###### Option: `Buffer data`

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

<hr>

#####`.verify(Buffer message, Buffer signature, Buffer publicKey)` -> `Boolean`
##### .verify(Buffer message, Buffer signature, Buffer publicKey) -> Boolean

Verify an ECDSA signature.

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

<hr>

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

Recover an ECDSA public key from a signature.

<hr>

#####`.ecdh(Buffer publicKey, Buffer privateKey)` -> `Buffer`
##### .ecdh(Buffer publicKey, Buffer privateKey) -> Buffer

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

<hr>

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

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

0 comments on commit 1401cb7

Please sign in to comment.