Skip to content

Commit

Permalink
Doc : change 'dashes' for 'some funds/funds'
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex-Werner committed May 8, 2018
1 parent e556961 commit 8bf3808
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/address.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Represents a dash address. Addresses are the most popular way to make dash transactions. See [the dash documentation](https://dash-docs.github.io/en/glossary/address) for technical background information.

## Instantiate an Address
To be able to receive dashes an address is needed, but in order to spend them a private key is necessary. Please take a look at the [`PrivateKey`](privatekey.md) docs for more information about exporting and saving a key.
To be able to receive some funds an address is needed, but in order to spend them a private key is necessary. Please take a look at the [`PrivateKey`](privatekey.md) docs for more information about exporting and saving a key.

```javascript
var privateKey = new PrivateKey();
Expand Down
2 changes: 1 addition & 1 deletion docs/crypto.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Dash Crypto
The cryptographic primitives (ECDSA and HMAC) implementations in this package have been reviewed by the BitPay engineering team. More audits and reviews are welcomed.
The cryptographic primitives (ECDSA and HMAC) implementations in this package have been reviewed by the BBitPay engineering team. More audits and reviews are welcomed.

## Random
The `dashcore.crypto.Random` namespace contains a single function, named `getRandomBuffer(size)` that returns a `Buffer` instance with random bytes. It may not work depending on the engine that dashcore is running on (doesn't work with IE versions lesser than 11).
Expand Down
4 changes: 2 additions & 2 deletions docs/script.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ assert(script.toString() === '33 0x022df8750480ad5b26950b25c7ba79d3e37d75f640f8e
```

### Pay to Multisig (p2ms)
Multisig outputs allow to share control of dashes between several keys. When creating the script, one specifies the public keys that control the funds, and how many of those keys are required to sign off spending transactions to be valid. An output with N public keys of which M are required is called an m-of-n output (For example, 2-of-3, 3-of-5, 4-of-4, etc.)
Multisig outputs allow to share control of some funds between several keys. When creating the script, one specifies the public keys that control the funds, and how many of those keys are required to sign off spending transactions to be valid. An output with N public keys of which M are required is called an m-of-n output (For example, 2-of-3, 3-of-5, 4-of-4, etc.)

Note that regular multisig outputs are rarely used nowadays. The best practice is to use a p2sh multisig output (See Script#toScriptHashOut()).

Expand All @@ -50,7 +50,7 @@ assert(script.toString() === 'OP_2 33 0x022df8750480ad5b26950b25c7ba79d3e37d75f6
```

### Pay to Script Hash (p2sh)
Pay to script hash outputs are scripts that contain the hash of another script, called `redeemScript`. To spend dashes sent in a p2sh output, the spending transaction must provide a script matching the script hash and data which makes the script evaluate to true. This allows to defer revealing the spending conditions to the moment of spending. It also makes it possible for the receiver to set the conditions to spend those dashes.
Pay to script hash outputs are scripts that contain the hash of another script, called `redeemScript`. To spend funds sent in a p2sh output, the spending transaction must provide a script matching the script hash and data which makes the script evaluate to true. This allows to defer revealing the spending conditions to the moment of spending. It also makes it possible for the receiver to set the conditions to spend those funds.

Most multisig transactions today use p2sh outputs where the `redeemScript` is a multisig output.

Expand Down
2 changes: 1 addition & 1 deletion docs/transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ These are the current default values in the dashcore library involved on these c
- `Transaction.DUST_AMOUNT`: `546` (duffs)

## Fee calculation
When outputs' value don't sum up to the same amount that inputs, the difference in dashes goes to the miner of the block that includes this transaction. The concept of a "change address" usually is associated with this: an output with an address that can be spent by the creator of the transaction.
When outputs' value don't sum up to the same amount that inputs, the difference in funds goes to the miner of the block that includes this transaction. The concept of a "change address" usually is associated with this: an output with an address that can be spent by the creator of the transaction.

For this reason, some methods in the Transaction class are provided:
- `change(address)`: Set up the change address. This will set an internal `_changeScript` property that will store the change script associated with that address.
Expand Down

0 comments on commit 8bf3808

Please sign in to comment.