Doc updates #3540

piotr-iohk · 2022-10-18T09:37:27Z

Comments

Various doc updates. Getting rid of references to old testnet and general polishing.

Issue Number

paweljakubas · 2022-10-18T10:54:14Z

docs/user-guide/common-use-cases/assets.md

@@ -271,7 +276,7 @@ $ curl -X POST http://localhost:8090/v2/wallets/73d38c71e4b8b5d71769622ab4f5bfde
 ```
 That's it! I should now receive CBOR-encoded `transaction`, `fee` and `coin_selection` details in response.
 I can now **sign** and **submit** such a transaction just like in [[how-to-make-a-transaction]].
-Once submitted my freshly minted NFT should be added to my wallet balance!
+Once transaction submitted your freshly minted NFT should be added to the wallet balance!


Suggested change

Once transaction submitted your freshly minted NFT should be added to the wallet balance!

Once the transaction is submitted your freshly minted NFT should be added to the wallet balance!

After the transaction has been submitted, your freshly-minted NFT should appear in your wallet balance!

paweljakubas · 2022-10-18T10:55:45Z

docs/user-guide/common-use-cases/delegation.md

@@ -135,6 +135,7 @@ $ curl -X POST http://localhost:8090/v2/wallets/1b0aa24994b4181e79116c131510f2ab
 -H "Content-Type: application/json"
 ```

-> :information_source: Note that all rewards will be withdrawn only if you add {"withdrawal":"self"} to the payload. You can do it in a single transaction though as above.
+After constructing delegation quit transaction I should receive CBOR-encoded `transaction`, `fee` and `coin_selection` details in response.


Suggested change

After constructing delegation quit transaction I should receive CBOR-encoded `transaction`, `fee` and `coin_selection` details in response.

After constructing a quitting-from-pool transaction I should receive CBOR-encoded `transaction`, `fee` and `coin_selection` details in the corresponding response.

"After constructing a transaction that undelegates from a stake pool, I should receive a CBOR-encoded transaction, fee, and coin_selection in the response."

paweljakubas · 2022-10-18T10:56:40Z

docs/user-guide/common-use-cases/delegation.md


-> :information_source: Refer to [[how-to-make-a-transaction]] for details on signing and submitting it to the network.
+> :information_source: Note that all rewards will be withdrawn only if you add {"withdrawal":"self"} to the payload. You can do it in a single transaction though as above.


Suggested change

> :information_source: Note that all rewards will be withdrawn only if you add {"withdrawal":"self"} to the payload. You can do it in a single transaction though as above.

> :information_source: Note that all rewards will be withdrawn only if you add {"withdrawal":"self"} to the payload. You can realize this within a single transaction as shown above.

You can achieve this with a single transaction, as shown above.

jonathanknowles

Hi @piotr-iohk

Just some suggested rewordings!

jonathanknowles · 2022-10-18T11:46:38Z

docs/user-guide/common-use-cases/delegation.md

@@ -135,6 +135,7 @@ $ curl -X POST http://localhost:8090/v2/wallets/1b0aa24994b4181e79116c131510f2ab
 -H "Content-Type: application/json"
 ```

-> :information_source: Note that all rewards will be withdrawn only if you add {"withdrawal":"self"} to the payload. You can do it in a single transaction though as above.
+After constructing delegation quit transaction I should receive CBOR-encoded `transaction`, `fee` and `coin_selection` details in response.


"After constructing a transaction that undelegates from a stake pool, I should receive a CBOR-encoded transaction, fee, and coin_selection in the response."

jonathanknowles · 2022-10-18T11:49:06Z

docs/user-guide/common-use-cases/assets.md

@@ -7,7 +7,7 @@ title: Managing native assets

 - [[how-to-start-wallet-server]]
 - [[how-to-create-a-wallet]]
- - In order to be able to send transactions we need funds on the wallet. In case of [Testnet](https://testnets.cardano.org/en/testnets/cardano/overview/) we can request tADA from the [faucet](https://testnets.cardano.org/en/testnets/cardano/tools/faucet/).
+ - In order to be able to send transactions we need funds on the wallet. In case of `preview` and `preprod` [testnets](https://testnets.cardano.org/en/testnets/cardano/overview/) we can request tADA from the [faucet](https://testnets.cardano.org/en/testnets/cardano/tools/faucet/).


"In order to be able to send transactions, our wallet must have funds."

Or

"In order to be able to send transactions, we must have a wallet with funds."

jonathanknowles · 2022-10-18T11:52:22Z

docs/user-guide/common-use-cases/assets.md

@@ -62,18 +62,23 @@ You can also list assets that were ever associated with the wallet.

 ## Assets off-chain metadata

-Issuers of native assets may put some metadata about them in the off-chain metadata server, like **Cardano Token Registry**.
+Issuers of native assets may put some off-chain metadata about them in the **Cardano Token Registry**. There are separate instances of token registry for `mainnet` and testnets (e.g. `preview` or `preprod`). Users can submit metadata to the repository which will be then served via corresponding server.


Perhaps:

Issuers of native assets may submit off-chain metadata relating to those assets to the Cardano Token Registry. There are separate instances of the token registry for mainnet and for each test network (e.g. preview or preprod). Metadata submitted to the registry will be then served via the corresponding server.

jonathanknowles · 2022-10-18T11:54:08Z

docs/user-guide/common-use-cases/assets.md


 > :information_source: Read more: [Cardano Token Registry](https://developers.cardano.org/docs/native-tokens/token-registry/cardano-token-registry), [CIP26](https://cips.cardano.org/cips/cip26).

-Cardano-wallet is capable of reading that metadata and serving it along while listing assets. All you have to do is to start wallet with `--token-metadata-server` parameter pointing to an off-chain metadata server.
+Cardano-wallet is capable of reading that metadata and serving it along while listing assets. All you have to do is to start wallet with `--token-metadata-server` parameter pointing to an off-chain metadata server corresponding to your network.


Cardano-wallet is capable of reading that metadata and serving it when listing assets. All you have to do is to start the wallet with the --token-metadata-server option, specifying an off-chain metadata server that corresponds to your network.

jonathanknowles · 2022-10-18T11:54:38Z

docs/user-guide/common-use-cases/assets.md

@@ -142,7 +147,7 @@ $ curl -X POST http://localhost:8091/v2/wallets/73d38c71e4b8b5d71769622ab4f5bfde
 "policy_vk12d0gdel9u6px8wf3uv4z6m4h447n9qsad24gztaku8dzzdqfajzqfm3rr0"
 ```

-Once we sort it out we are all set and we can proceed into minting an NFT from our wallet!
+Once we sort it out we are all set and we can proceed into minting NFT from our wallet!


Once we have finished, we can proceed to minting NFTs from our wallet!

jonathanknowles · 2022-10-18T11:55:20Z

docs/user-guide/common-use-cases/assets.md

@@ -271,7 +276,7 @@ $ curl -X POST http://localhost:8090/v2/wallets/73d38c71e4b8b5d71769622ab4f5bfde
 ```
 That's it! I should now receive CBOR-encoded `transaction`, `fee` and `coin_selection` details in response.
 I can now **sign** and **submit** such a transaction just like in [[how-to-make-a-transaction]].
-Once submitted my freshly minted NFT should be added to my wallet balance!
+Once transaction submitted your freshly minted NFT should be added to the wallet balance!


After the transaction has been submitted, your freshly-minted NFT should appear in your wallet balance!

jonathanknowles · 2022-10-18T11:55:58Z

docs/user-guide/common-use-cases/delegation.md


-> :information_source: Refer to [[how-to-make-a-transaction]] for details on signing and submitting it to the network.
+> :information_source: Note that all rewards will be withdrawn only if you add {"withdrawal":"self"} to the payload. You can do it in a single transaction though as above.


You can achieve this with a single transaction, as shown above.

jonathanknowles · 2022-10-18T11:56:56Z

docs/user-guide/common-use-cases/how-to-start-wallet-server.md

  --database-path ./db \
  --socket-path /path/to/node.socket
 ```
 2. Start wallet:
+
+When starting wallet against any testnet environment like `preview` or `preprod` we need to feed wallet with `byron-genesis.json` file:


When starting a wallet instance that targets a testing environment such as preview or preprod, we need to provide a byron-genesis.json file to the wallet:

jonathanknowles · 2022-10-18T11:58:10Z

docs/user-guide/common-use-cases/how-to-start-wallet-server.md

 ```
+> :information_source: Notice that we use different urls for `mainnet` and `testnet` `--token-metadata-server` option. These are links to [Cardano Token Registry](https://developers.cardano.org/docs/native-tokens/token-registry/cardano-token-registry) servers. See [[assets]] for more information.


Notice that we use different URLs for mainnet and test networks with the --token-metadata-server option. These URLs point to Cardano Token Registry servers. See [[assets]] for more information.

jonathanknowles · 2022-10-18T11:58:55Z

docs/user-guide/common-use-cases/assets.md

@@ -271,7 +276,7 @@ $ curl -X POST http://localhost:8090/v2/wallets/73d38c71e4b8b5d71769622ab4f5bfde
 ```
 That's it! I should now receive CBOR-encoded `transaction`, `fee` and `coin_selection` details in response.
 I can now **sign** and **submit** such a transaction just like in [[how-to-make-a-transaction]].
-Once submitted my freshly minted NFT should be added to my wallet balance!
+Once transaction submitted your freshly minted NFT should be added to the wallet balance!


After the transaction has been submitted, your freshly-minted NFT should appear in your wallet balance!

piotr-iohk · 2022-10-18T14:49:17Z

bors r+

iohk-bors · 2022-10-18T16:07:18Z

Build succeeded:

User guides updates

da9a2cc

piotr-iohk self-assigned this Oct 18, 2022

piotr-iohk requested review from HeinrichApfelmus and paweljakubas October 18, 2022 10:20

paweljakubas reviewed Oct 18, 2022

View reviewed changes

paweljakubas approved these changes Oct 18, 2022

View reviewed changes

jonathanknowles reviewed Oct 18, 2022

View reviewed changes

Piotr Stachyra added 2 commits October 18, 2022 14:45

Address review remarks

f8b2da3

Bring back cardano icon into API doc (as SVG)

c15f9fd

iohk-bors bot merged commit f366f02 into master Oct 18, 2022

iohk-bors bot deleted the piotr/doc-updates branch October 18, 2022 16:07

WilliamKingNoel-Bot pushed a commit that referenced this pull request Oct 18, 2022

docs: Merge #3540

b6ff378

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc updates #3540

Doc updates #3540

piotr-iohk commented Oct 18, 2022

paweljakubas Oct 18, 2022

jonathanknowles Oct 18, 2022

paweljakubas Oct 18, 2022

jonathanknowles Oct 18, 2022

paweljakubas Oct 18, 2022

jonathanknowles Oct 18, 2022

jonathanknowles left a comment

jonathanknowles Oct 18, 2022

jonathanknowles Oct 18, 2022 •

edited

Loading

jonathanknowles Oct 18, 2022

jonathanknowles Oct 18, 2022

jonathanknowles Oct 18, 2022

jonathanknowles Oct 18, 2022 •

edited

Loading

jonathanknowles Oct 18, 2022

jonathanknowles Oct 18, 2022 •

edited

Loading

jonathanknowles Oct 18, 2022

jonathanknowles Oct 18, 2022

piotr-iohk commented Oct 18, 2022

iohk-bors bot commented Oct 18, 2022

	Once transaction submitted your freshly minted NFT should be added to the wallet balance!
	Once the transaction is submitted your freshly minted NFT should be added to the wallet balance!

	After constructing delegation quit transaction I should receive CBOR-encoded `transaction`, `fee` and `coin_selection` details in response.
	After constructing a quitting-from-pool transaction I should receive CBOR-encoded `transaction`, `fee` and `coin_selection` details in the corresponding response.


		> :information_source: Refer to [[how-to-make-a-transaction]] for details on signing and submitting it to the network.
		> :information_source: Note that all rewards will be withdrawn only if you add {"withdrawal":"self"} to the payload. You can do it in a single transaction though as above.

		```
		> :information_source: Notice that we use different urls for `mainnet` and `testnet` `--token-metadata-server` option. These are links to [Cardano Token Registry](https://developers.cardano.org/docs/native-tokens/token-registry/cardano-token-registry) servers. See [[assets]] for more information.

Doc updates #3540

Doc updates #3540

Conversation

piotr-iohk commented Oct 18, 2022

Comments

Issue Number

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonathanknowles left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonathanknowles Oct 18, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonathanknowles Oct 18, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonathanknowles Oct 18, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

piotr-iohk commented Oct 18, 2022

iohk-bors bot commented Oct 18, 2022

jonathanknowles Oct 18, 2022 •

edited

Loading

jonathanknowles Oct 18, 2022 •

edited

Loading

jonathanknowles Oct 18, 2022 •

edited

Loading