Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: typos #937

Merged
merged 6 commits into from
Jan 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/get-started/air-gap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Secure your private keys on a network-free transaction host.
image: ../img/og/og-security-air-gap-environment.png
---

"Air gap" originally meant a computer or subnetwork was surrounded by "air" and so could have no data cable connections in or out, so it would be isolated from other computers & networks. These days it also means no radio-based network connection either (WiFi, Blueooth, etc.).
"Air gap" originally meant a computer or subnetwork was surrounded by "air" and so could have no data cable connections in or out, so it would be isolated from other computers & networks. These days it also means no radio-based network connection either (WiFi, Bluetooth, etc.).

Developers & Cardano stake pool operators generally need an air gap environment in which to work with payment keys, stake pool keys and other cryptocurrency resources that offer high-value targets for hackers.

Expand Down Expand Up @@ -95,7 +95,7 @@ The Internet will be unconfigured and disconnected after the OS is installed & p

### Follow instructions: [Ubuntu Tutorials > Install Ubuntu desktop](https://ubuntu.com/tutorials/install-ubuntu-desktop)

... paying partcular attention to these steps:
... paying particular attention to these steps:

#### Wireless (if asked)

Expand Down Expand Up @@ -186,7 +186,7 @@ sudo apt remove unattended-upgrades

Removing Snap is optional because default snaps on the Ubuntu installation media have the same security provenance as the default packages on that same release... yet snaps will also be upgraded in the next part of this procedure, and these upgraded snaps may not be subjected to the same security vetting.

To proceed with removing Snap, follow these instructions (the proceduce exact procedure changes often & these instructions may be the best maintained to date):
To proceed with removing Snap, follow these instructions (the exact procedure changes often & these instructions may be the best maintained to date):

- **[How do I turn off snap in Ubuntu?](https://linuxhint.com/turn-off-snap-ubuntu/)**

Expand Down Expand Up @@ -252,8 +252,8 @@ Note this will build `cardano-node` as well as `cardano-cli`, but don't worry: y

We will leave the definition of "forever" up to your understanding of Internet threats and whether these can come from OS package repositories, etc., with this in mind:

- Software updates at 6-month intervals (e.g. after the Ubuntu "point releases") will patch security problems idendified during that period: as well as install new software which may introduce *new* security problems.
- Any spyware or back-door deliberately placed in the package upgrades on Ubuntu or any other version of Linux could generally just as easily have been placed on the packages used to build your installation media.
- Software updates at 6-month intervals (e.g. after the Ubuntu "point releases") will patch security problems identified during that period: as well as install new software which may introduce *new* security problems.
- Any spyware or backdoor deliberately placed in the package upgrades on Ubuntu or any other version of Linux could generally just as easily have been placed on the packages used to build your installation media.

### Precautions to avoid accidental connection to the Internet

Expand Down Expand Up @@ -290,7 +290,7 @@ Linux veterans only\! (otherwise please [follow option 1](#option-1-install-your
This option may suit more demanding users, especially those:

- who travel a lot and need to maintain their Cardano operations "on the road";
- who need the convenience of booting in a air gap environment which has direct access to all their files on the host computer (as you would when booting off from an installer USB drive);
- who need the convenience of booting in an air gap environment which has direct access to all their files on the host computer (as you would when booting off from an installer USB drive);
- who, instead of using a USB drive to transfer unencrypted files in & out of the air gap, would rather use that same USB drive to store these files with encryption while also providing the Cardano CLI for use on any machine supporting the same boot method;
- who want to make encrypted backups or their keys, passwords and other records from their air gap environment directly to the host computer.

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/blockfrost.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ After clicking on `Save Project` you will immediately get your `API KEY`. Save i

## Query the latest epoch

Send your first request to get data about the latest epoch. Don't forget to replace `1234567890`with your `API KEY`.
Send your first request to get data about the latest epoch. Don't forget to replace `1234567890` with your `API KEY`.

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/cardano-developer-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ A subreddit dedicated to everyone building on the Cardano blockchain.
Chat style conversations on Telegram in one of the oldest Cardano developer groups.

[**IOG Technical Discord**](https://discord.com/invite/w6TwW9bGA6)
Head to the the [IOG Discord](https://discord.com/invite/w6TwW9bGA6) if you want to join the [Plutus Pioneers](../smart-contracts/plutus#get-started-with-the-plutus-pioneer-program).
Head to the [IOG Discord](https://discord.com/invite/w6TwW9bGA6) if you want to join the [Plutus Pioneers](../smart-contracts/plutus#get-started-with-the-plutus-pioneer-program).

[**t.me/IOHK_Marlowe**](https://t.me/IOHK_Marlowe)
Dedicated channel for Marlowe developers and users. Marlowe is a specialized domain-specific language for financial smart contracts on Cardano. You can ask questions, participate in discussions and meet the team behind Marlowe.
Expand Down
30 changes: 15 additions & 15 deletions docs/get-started/cardano-wallet-js.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ image: ../img/og/og-getstarted-cardano-wallet-js.png
---

## cardano-wallet-js
`cardano-wallet-js` is a javascript/typescript SDK for Cardano with a several functionalities. You can use it as a client for the official [cardano-wallet](https://github.com/input-output-hk/cardano-wallet) and also to create Native Tokens and NFTs.
`cardano-wallet-js` is a javascript/typescript SDK for Cardano with several functionalities. You can use it as a client for the official [cardano-wallet](https://github.com/input-output-hk/cardano-wallet) and also to create Native Tokens and NFTs.

## Table of Contents

Expand Down Expand Up @@ -196,7 +196,7 @@ Output:
```

:::important
The recovery phrase is the only way you can restore your wallet and you **SHOULD KEEP IT SECURE AND PRIVATE**. You'll get a completeley different recovery phrase each time you execute the method.
The recovery phrase is the only way you can restore your wallet and you **SHOULD KEEP IT SECURE AND PRIVATE**. You'll get a completely different recovery phrase each time you execute the method.
:::

For convenience, you can convert the recovery phrase into an array using this:
Expand Down Expand Up @@ -258,7 +258,7 @@ wallet = await wallet.updatePassphrase(oldPassphrase, newPassphrase);
The wallet itself doesn't hold the passphrase, you can check it's correctly updated trying to call a method needing the passphrase e.g: `sendPayment`
:::
### Wallet addresses
Cardano wallets are Multi-Account Hierarchy Deterministic that follow a variation of BIP-44 described [here](https://github.com/input-output-hk/implementation-decisions/blob/e2d1bed5e617f0907bc5e12cf1c3f3302a4a7c42/text/1852-hd-chimeric.md). All the addresses are derived from a root key (is like a key factory) which you can get from the recovery phrase. Also the wallets will always have 20 "consecutive" unused address, so anytime you use one of them new address will be "discovered" to keep the rule.
Cardano wallets are Multi-Account Hierarchy Deterministic that follow a variation of BIP-44 described [here](https://github.com/input-output-hk/implementation-decisions/blob/e2d1bed5e617f0907bc5e12cf1c3f3302a4a7c42/text/1852-hd-chimeric.md). All the addresses are derived from a root key (is like a key factory) which you can get from the recovery phrase. Also the wallets will always have 20 "consecutive" unused addresses, so anytime you use one of them new address will be "discovered" to keep the rule.
```js
let addresses = await wallet.getAddresses(); // list will contain at least 20 address
```
Expand Down Expand Up @@ -291,7 +291,7 @@ let rewardBalance = wallet.getRewardBalance();
let totalBalance = wallet.getTotalBalance();
```
### Wallet delegation
The wallet have information about whether already delegate on a stake pool or not
The wallet has information about whether already delegate on a stake pool or not
```js
let delegation = wallet.getDelegation();
console.log(delegation);
Expand All @@ -305,7 +305,7 @@ It the wallet is not delegate to any stake pool the output should be something s
}
}
```
If you start delegating (see [Stake pool section](#stake-pool-operations-with-the-wallet) the action will not take effect inmediatelly but the `next` property will indicate when the delegation will finally take effect.
If you start delegating (see [Stake pool section](#stake-pool-operations-with-the-wallet) the action will not take effect immediately but the `next` property will indicate when the delegation will finally take effect.
The delegation meanwhile should look like this:
```js
{
Expand All @@ -326,9 +326,9 @@ The delegation meanwhile should look like this:
Property `changes_at` will indicate the epoch at the delegation will take effect
:::

If we ask again after/during the epoch 10, we should get the delgation in place:
If we ask again after/during the epoch 10, we should get the delegation in place:
```js
// refresh the wallet if you are using the same object. This will fecth the info from the blockchain
// refresh the wallet if you are using the same object. This will fetch the info from the blockchain
await wallet.refresh();

let delegation = wallet.getDelegation();
Expand All @@ -352,8 +352,8 @@ let stake = 1000000000;
let pools = await walletServer.getStakePools(stake);
```
:::note
You'll get pool ordered by `non_myopic_member_rewards` which basically means from heighest to lower expected rewards. By default the wallet server
isn't configured to fecth the pool's metadata (e.g. ticker, name, homepage) but you can specify it through the update settings functionality, see Update Settings section below.
You'll get pool ordered by `non_myopic_member_rewards` which basically means from highest to lower expected rewards. By default the wallet server
isn't configured to fetch the pool's metadata (e.g. ticker, name, homepage) but you can specify it through the update settings functionality, see Update Settings section below.
:::

Estimate delegation fee:
Expand All @@ -372,7 +372,7 @@ let pool = pools[0];
let transaction = await wallet.delegate(pool.id, passphrase);
```
:::note
The transacion status initially is set to `pending`, so you should keep tracking the transaction using the `id` in order to make sure the final status (e.g. `in_ledger`). You can learn more about the transacion's life cycle [here](https://github.com/input-output-hk/cardano-wallet/wiki/About-Transactions-Lifecycle).
The transaction status initially is set to `pending`, so you should keep tracking the transaction using the `id` in order to make sure the final status (e.g. `in_ledger`). You can learn more about the transaction's life cycle [here](https://github.com/input-output-hk/cardano-wallet/wiki/About-Transactions-Lifecycle).
For delegate to another stake pool use the same method above specifying a different stake pool.
:::

Expand Down Expand Up @@ -446,7 +446,7 @@ let amounts = [5000000]; // 5 ADA
let transaction = await senderWallet.sendPayment(passphrase, receiverAddress, amounts);
```
:::note
You can pass a list of address and amount. We expect both list have the same length where elemetns on each list is index related to the other.
You can pass a list of address and amount. We expect both list have the same length where elements on each list is index related to the other.
You can think of it as sending `amounts[i]` to `addresses[i]`.
:::

Expand Down Expand Up @@ -539,7 +539,7 @@ let signed = Buffer.from(txBody.to_bytes()).toString('hex');
let txId = await walletServer.submitTx(signed);
```
### Key handling
There ara a couple of methods you can use to derive and get private/public key pairs. For more info check [here](https://github.com/input-output-hk/technical-docs/blob/main/cardano-components/cardano-wallet/doc/About-Address-Derivation.md).
There are a couple of methods you can use to derive and get private/public key pairs. For more info check [here](https://github.com/input-output-hk/technical-docs/blob/main/cardano-components/cardano-wallet/doc/About-Address-Derivation.md).

Get root key from recovery phrase
```js
Expand Down Expand Up @@ -681,7 +681,7 @@ tokens.filter(t => t.scriptKeyPairs).forEach(t => signingKeys.push(...t.scriptKe

let metadata = Seed.buildTransactionMetadata(data);

// the wallet currently doesn't support including tokens not previuosly minted
// the wallet currently doesn't support including tokens not previously minted
// so we need to include it manually.
coinSelection.outputs = coinSelection.outputs.map(output => {
if (output.address === addresses[0].address) {
Expand All @@ -697,8 +697,8 @@ coinSelection.outputs = coinSelection.outputs.map(output => {
return output;
});

// we need to sing the tx and calculate the actual fee and the build again
// since the coin selection doesnt calculate the fee with the asset tokens included
// we need to sign the tx and calculate the actual fee and the build again
// since the coin selection doesn't calculate the fee with the asset tokens included
let txBody = Seed.buildTransactionWithToken(coinSelection, ttl, tokens, signingKeys, {data: data, config: config});
let tx = Seed.sign(txBody, signingKeys, metadata, scripts);

Expand Down