This PR #510 updates faucet page with information about required bech32 format for pool ID when using faucet.

Once this ticket in cardano-world repo is implemented facuet will support both formats and additional info about bech32format for pool ID can be removed.

Hello @nahern,

Am interested to learn more about Marlowe, but when attempting to access the embedded Playground link (https://play.marlowe-finance.io/) from: https://docs.cardano.org/marlowe/marlowe-get-started, I receive the "The connection is Not Private" error message.

Is there something wrong with the SSL certificate? Is the embedded link correct?

The issue appears in both Safari and Chrome.

Screenshot below demonstrates this.

Cheers!

Glen

There is a small typo in the architecture diagram, specifically in the spelling of GraphQL API Server. See attached image for location.

https://github.com/input-output-hk/cardano-documentation/blob/staging/content/05-explore-cardano/02-cardano-architecture/[email protected]

It leads to https://docs.cardano.org/explore-cardano/cardano-architecture/overview
Where is it supposed to point to?

Documentation for cardano-serialization-lib was previously hosted on the old documentation website, but it seems to be no longer included since the new launch. What needs to be done to get it added again?

The url to Native Tokens Dashboard is unreachable.

Maybe replace with https://cexplorer.io/token ?

I'm following the https://docs.cardano.org/plutus/Plutus-transactions tutorial

When I run cardano-cli query tip --mainnet inside my nix-shell I see the error:
cardano-cli: Network.Socket.connect: <socket: 16>: does not exist (No such file or directory)

Here is what I've done previously...

nix-shell plutus-tutorial.nix

And then inside the nix-shell I run cardano-node-mainnet

What am I missing?

In the "Address" section there is also "Adrestia" definition.

It is one of the widely used libraries in cardano ecosystem, and was present before revamp

Sphinx doco can be found here

There is this picture

(used here)

Shouldn't we interchange "Distributed systems" and "Decentralized systems" captions on this picture?

Excerpts from the description of decentralized system:
"interconnected, independent nodes and terminals." - we have interconnected nodes on the last picture
"This ensures independence from centralized entities" - only on the last picture we don't have centralized server.

When looking at the Alonzo- and Babbage-era code in cardano-ledger it is more than clear that the documentation which describes the minimum ada value requirements is completely outdated (pre Alonzo!).

Please fix this, it is misguiding and simply wrong (judging by the code).

There are a couple of wrong links here https://docs.cardano.org/learn/ .

Specifically, https://docs.cardano.org/learn/delegation/ (located here content/03-learn/04-delegation.mdx in the repository) contains at least 2 broken links:

1. "delegation certificate" leads to https://docs.cardano.org/development-guidelines/operating-a-stake-pool/creating-keys-and-certificates#creatinganoperationalcertificate with a "404 not found error".
2. "multi-sig" leads to https://github.com/input-output-hk/cardano-node/blob/master/doc/reference/simple-scripts.md#multi-signature-scripts with a "404 not found error" once more.

Perhaps (1) is supposed to link to https://docs.cardano.org/operating-a-stake-pool/creating-keys-and-certificates and (2) to https://github.com/input-output-hk/cardano-node/blob/c6b574229f76627a058a7e559599d2fc3f40575d/doc/reference/simple-scripts.md#multisignatures . I can try to fix them, if these are indeed the correct links.

Moved from cardano-foundation/docs-cardano-org#78

Pretty much anything I search for in the docs the last few days results in 404s. For example if I search for "cardano plutus docs" the top result is https://docs.cardano.org/projects/plutus/en/latest/ which is now a 404.

If URLs have to change, it'd be nice to have redirects for all the people with bookmarks or searching. It's significantly harder to find docs now (especially as the site doesn't seem to have its own search functionality).

The sitemap on https://docs.cardano.org/sitemap.xml uses the wrong subdomains for the links.

Example:

<loc>https://cardano.org/core-concepts</loc>

Should be:

<loc>https://docs.cardano.org/core-concepts</loc>

This addres
0x021dD53a0C2397cF71e9B367B9A71642e03AA71B

Hi, the docs mention an EVM sidechain repository written in Scala, is there a link to this or is it being developed non-publicly?

Something like github does (the two chain links in front of the heading):

This way those exact locatins could be copied and referenced from other places (e.g from cardano.stackexchange.com). The id attributes already seem to be present on the headings and work:

The linked REST API project has been deprecated and stopped working after the Alonzo hard-fork. It should not appear in the architecture documentation or list of projects.

See https://github.com/input-output-hk/cardano-documentation/blob/master/content/05-explore-cardano/02-cardano-architecture.mdx

In this section of the docs plutus and Marlowe are mentioned as tools for writing smart contracts:

https://github.com/input-output-hk/cardano-documentation/blob/fb70af93721a1e8966dbc90efc6f1d60a7a8c367/content/02-new-to-cardano/10-what-is-a-smart-contract.mdx

However, new projects like @ImperatorLang and @aiken-lang are emerging and would likely be of interest for anyone planning to build on cardano.

1. Should these projects be listed here at all, given they are community driven and not built by IOHK?
2. Should they be listed as equals or in a "community" / additional references section?
3. Should we wait until they are production ready? Given that they might be production ready by the time a Dev building on them wants to go live

In the "Peer-to-peer (P2P) networking" page of the Cardano docs it states, "Note: The P2P deployment is currently in testing stages. The team is focused on the delivery of final features for SPOs and the preparation of QuickCheck simulation tests. The full P2P deployment will happen later in 2021. This documentation describes the P2P functionality for information purposes only ahead of this release." I believe this is out of date but do not wan't to create a pull request because this is not my area of expertise.

That would be awesome if possible!

The Cardano Testnet Faucet page is down, not sure where to reach out to in order to get this resolved:

https://docs.cardano.org/cardano-testnet/tools/faucet/

Hello, I read though the operator documentation and see that there are several ways to get the executables on to a server. While the docker option implies, to me, it has an upgrade path of simply pulling changes, I am not clear on how to upgrade when using the other methods.

Would it be possible to mention how upgrades to newer versions are done for pre-compiled binaries and for people who build from source?

And if an upgrade fails, could that also be discussed?

When following these instructions to download pre-compiled binaries of cardano node and cli:
https://github.com/input-output-hk/cardano-documentation/blob/master/content/06-development-guidelines/01-installing-the-cardano-node.mdx#downloading-pre-compiled-executables

we're instructed to download them from the GitHub releases of cardano-node: https://github.com/input-output-hk/cardano-node/releases

However, the binaries aren't offered there.

Please clarify where the pre-compiled binaries can be downloaded from.

content/05-explore-cardano/02-cardano-architecture/03-cardano-db-sync-best-practices.mdx states the following

The system requirements for cardano-db-sync (with both db-sync and the node running on the same machine) are:
{...}
16 Gigabytes of RAM.
{...}
80 Gigabytes or more of disk storage {...}

while https://github.com/input-output-hk/cardano-db-sync/blob/master/Readme.md states

The system requirements for cardano-db-sync (with both db-sync and the node running on the same machine are:

{...}
32 Gigabytes of RAM or more.
{...}
Ensure that the machine has sufficient IOPS (Input/Output Operations per Second). Ie it should be 60k IOPS or better. Lower IOPS ratings will result in slower sync times and/or falling behind the chain tip.
160 Gigabytes or more of disk storage {...}

Both should be in sync (or even better referenced instead of duplicated). I can confirm 16 GB ain't sufficient.

When visiting cardano.org -> developers -> Marlowe Playground i get a Page not found.

If you go to Cardano Docs page and scroll down to the Explore More section for Cardano architecture the link leads to a 404 page.

After using the search tool I believe this link is what it was meant to be.

there's a broken link at https://docs.cardano.org/core-concepts/cardano-keys/ 😅

Upstream project cardano-node changed the filenames.

Following instructions from https://docs.cardano.org/native-tokens/getting-started

Using --address works.

% cardano-cli query utxo --mainnet --address addr1qxxwkrsw3y5j5p5gm6qfc2m8tc3g6gjl2ppeukpmkrceq9nk2p4eyt7frkz70dwtj040wfyemjyrycrpwh06aece7xzqjn0m7t

Response:

                           TxHash                                 TxIx        Amount
--------------------------------------------------------------------------------------
97a1b830a12510fc20bc2b778a9e0f54747c91e9d5660a1dd4c40c39c435cd5b     0        4641718 lovelace + 1 34fabf5a4e43d04d25dc1476c4b1aeb88e28d853b98b8bcd7577bd20.ZEN1

But when I use the TxHash#TxIX I get this error

% cardano-cli query utxo --mainnet --tx-in 97a1b830a12510fc20bc2b778a9e0f54747c91e9d5660a1dd4c40c39c435cd5b#0

Response:

cardano-cli: ShelleyEncoderUnsupportedQuery (SomeSecond (GetUTxOByTxIn (fromList [TxInCompact (TxId {_unTxId = SafeHash "97a1b830a12510fc20bc2b778a9e0f54747c91e9d5660a1dd4c40c39c435cd5b"}) 0]))) ShelleyNodeToClientVersion3%  

I am using the Daedalus wallet node $ export CARDANO_NODE_SOCKET_PATH="~/Library/Application Support/Daedalus Mainnet/cardano-node.socket

DAEDALUS 4.2.0
macOS build 18540, Cardano Node 1.27.0, Cardano Wallet 2021.6.11

@ path --> /cardano-testnet/getting-started/

Under section titled, "Installing the Node":

• Link titled "cardano-client" links to invalid URL --> https://github.com/input-output-hk/cardano-node/tree/master/cardano-client-demo

Under section titled, "Configurations":

-Link titled "Understanding configuration files" links to invalid URL --> https://github.com/input-output-hk/cardano-node/blob/master/doc/getting-started/understanding-config-files.md

-Link titled "Configuring the node using YAML" links to invalid URL --> https://github.com/input-output-hk/cardano-node/blob/master/doc/reference/configuring-a-node-using-yaml.md

Sort of... trying to work out what the Ambassadors programme is all about...will send an email via the link...Ciao for now - Riccardo

This link is not being redirected: https://docs.cardano.org/core-concepts/cardano-keys#gatsby-focus-wrapper
Where I can find a search tool inside the docs page?

the title kinda says it all really… at this point in time it's not just a nice to have as majority of developer resources have made the transition to dark mode - including IDEs!

is there some work happening on this front that's not been made public? or is there some other reason why this hasn't been implemented yet? genuinely curious.

https://docs.cardano.org/getting-started/installing-the-cardano-node says nix is an option,
https://github.com/input-output-hk/cardano-node/blob/master/doc/getting-started/install.md/ says nix is no longer supported.

Which one is right?

Since the nix build fails if libsodium is already installed, I suppose it is the latter. In any case it should be consistent in the documentation.

The consequence of the design section in Minimum ada value requirement page contains wrong information:

The number of each kind of token in an output does not affect the min-ada-value of the output, but the number of types of tokens contained in an output increases the min-value.

According to our own experiments the The number of each kind of token in an output does not affect the min-ada-value of the output part is plain and simply wrong. Here are the results of a few experiments we ran:

Experiments with custom Tokens showed a similar pattern:

This clearly shows that when increasing the number of a kind of token, the min-ada-value is affected.

The testnet faucet tool, at url, is currently down and returns 404.

It could just be my browser but when I click the 1 at the end of the sentence, "claimTransactionHash of the transaction is NOT included in the distributed set" on the Main Chain Plutus Script page of the Cardano docs it doesn't do anything. Just a small bug but thought I'd let whoever controls this repo know. This is the page: https://docs.cardano.org/cardano-sidechains/sidechain-toolkit/mainchain-plutus-scripts#fn-1 .

There is a wrong link in the Getting Support page of the docs. The Group for Development Queries points to the Cardano Developers telegram group, instead of the official group called Cardano Developers Official.

The documentation for Creating a Stake Pool is very confusing.

Particularly in terms of if the hardware requirement.

In terms of hardware, you should ensure you have the following:

• 8 GB of RAM
• 24 GB of hard disk space
• a good network connection and about 1 GB of bandwidth per hour
• a public IP4 address

Is this just talking about the core node, or the relay?

I find it questionable since the relay and core have very different workloads.

Would you please confirm if the relay and core nodes have the exact same requirements or if perhaps the relay or core has a different set of requirements?

First of all, thanks everyone for the amazing job on the Cardano docs!

I could not find any translation branches/issues/pull-requests or the structure to help on this matter. Since the documentation is open to anyone to contribute, I decided to leave here some question on this regard:

1. Is the technologies published in the docs mature enough for translations?
2. Is there already a contribution process defined?
3. If they are not, is it planed only for the 'Basho' phase of the Cardano roadmap?
4. What is still needed for the translation process take place?

the reCAPTCA showing :

ERROR for site owner:
Invalid domain for site key

When I try to use the faucet in preprod mode it always returns the error message UTXO not found.

Here's the code I generate the address (using C# package CardanoSharp.Wallet):

byte[] privateKeyA = new byte[32];
Ed25519.KeyPairFromSeed(out publicKeyA, out _, privateKeyA);
PublicKey publicKey = new PublicKey(publicKeyA, publicKeyA);

var address1 = AddressUtility.GetEnterpriseAddress(publicKey, NetworkType.Preprod);
var address2 = AddressUtility.GetBaseAddress(publicKey, publicKey, NetworkType.Preprod);

The preview mode works well and I can get test adas in faucet, but not in preprod mode.

For a span of over 200 epochs there has been far greater than 20% going into the treasury from the reserves. The documentation would lead one to believe that 80% of the per epoch reserves of ADA that is being minted would be going to the delegators and operators of the network. This is not the case and the documentation glosses over this reality.

1. The content from this documentation page eludes to τ (funds going into the Treasury) as being 20%. However review of Treasury, Circulation, Reserves and Rewards Allocations shows that this is actually greater than 30%.

2. The following Compound contribution to the Treasury from
   the inefficiencies of the pools explains the compounding effect of inefficiencies, leading to much greater than 20% moving to the treasury.

   • The findings list 40% going to treasury from the per epoch reserves.
     • During epochs 213-223 the treasury exceeded 40%, and on occasion even 50%, averaging 43.2% of the per epoch reserves
     • During epochs 224-240 the treasury averaged 34.4% of the per epoch reserves
     • During epochs 241-388 the treasury averaged 31% of the per epoch reserves

An average of 31% is going into the Treasury per epoch for over 150 epochs. This in essence is either:

• A reduction of the delegator fraction of rewards by 13.75%, conversely would increase rewards by > 15% per epoch.
• A depletion of the reserves by an additional amount which goes to the treasury instead of being retained in the reserves.

The documentation does not address this and that seems like being disingenuous or intentionally withholding or obfuscating the truth from the participants. I suggest the documentation should explain the parameters setting of 20%. However it should strive to describe accurately the split the treasury actually receives per epoch, because it is clearly not 20% and has a real impact on the bottom line of the delegators compounded annual return on stake and the operators profit margins, or the length of time reserves will be available before the network needs to be fully self sustaining.

The current Faucet page has an issue with the reCapcha integration.

When in the Testnet faucet section of the integrate cardano documentation the Faucet section is clipping the tADA submission process, so much so that the captcha and the address input sections are not selectable.