cardano-foundation/docs-cardano-org

Documentation for Cardano

Cardano Documentation

This repository has been deprecated. please see https://github.com/input-output-hk/cardano-documentation for the source code to https://docs.cardano.org

Welcome to the central hub for Cardano documentation, here you will find content that describes and supports the components and features that are live on Cardano mainnet.

If you are interested in developing on Cardano, experimenting with the Cardano testnet, or other test development environments, please visit Cardano Developers.

Cardano explained

Cardano is a decentralized third-generation proof-of-stake blockchain platform and home to the ada cryptocurrency. It is the first blockchain platform to evolve out of a scientific philosophy and a research-first driven approach.

The Cardano platform has been designed from the ground up and verified by an industry-leading combination of top engineers and academic experts in the fields of blockchain and cryptography. It has a strong focus on sustainability, scalability, and transparency. It is a fully open source project that aims to deliver an inclusive, fair, and resilient infrastructure for financial and social applications on a global scale. One of its primary goals is to bring reliable, secure financial services to those people who do not currently have access.

Cardano has been designed with security as one of its founding principles. It is written in Haskell, a functional programming language. In a functional language like Haskell, building your system using pure functions is encouraged, which leads to a design where components are conveniently testable in isolation. Furthermore, advanced features of Haskell enable us to employ a whole range of powerful methods for ensuring correctness of the code, such as basing the implementation on formal and executable specifications, extensive property-based testing, and running tests in simulation.

Cardano is developing a smart contract platform which seeks to deliver more advanced features than any protocol previously developed and will serve as a stable and secure platform for the development of enterprise-level dApps. In the near future, Cardano will use a democratic governance system that allows the project to evolve over time, and fund itself in a sustainable way through a visionary treasury system.

You can read more about Cardano on the official Cardano website and watch a summary of the mission of Cardano in this explainer video. If you are looking for a user-friendly wallet for Cardano, please take a look at Daedalus for a desktop wallet or Yoroi for a mobile wallet.

docs-cardano-org's Issues

The year of copyright is hard coded in the configuration file

At the current stand of conf.py the year of copyright is set to be '2020', which is outdated. This should be fixed, preferably using a solution that uses the current year upon a new rebuild.

Consider adding redirects for old links in search engines/bookmarks that are now all 404s

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).

Native Token exercises need more references

I've restarted learning Haskell and got nix running on my windows (ubuntu wsl), now I would like to continue the native token exercises, but I can't find any sources tagged mary, would you please provide a (linked) reference?
Could I use e.g. 1.27.0?

https://github.com/cardano-foundation/docs-cardano-org/blame/main/native-tokens/exercises.md#L7 @fsancheziohk

Add a contributing.md to the repo

This repo is missing a contributing.md, so we should add one.

The primary font used in the docs is very thin

Not really a technical issue, but I still wanted to point out that the font in the docs is really thin. Or maybe its about the font-family itself. I find it a bit difficult to stare at it for a long time on a white background. Can we do something about it ?

Its just an opinion, feel free to close it if everyone doesn't agree.

Error in pool performance factor in pledging-rewards.md ?

Hello,

Parameters \sigma and s and z_0 of the pledging reward formula (https://docs.cardano.org/core-concepts/pledging-rewards) are said to be given in proportion to the total amount of ADA supply.

However, when it comes to the pool performance factor, the doc is using \beta / \sigma as a measure of how “ideal” the mining pool performed. However, it seems to me that this factor is false since \sigma is computed with respect to the total ADA supply and not the total amount of staked ADA.

Indeed, I believe that the probability for a mining pool to mint a block is “total ADA delegated to the pool” / “total staked ADA” and not “total ADA delegated to the pool” / “total ADA supply”.

Would you agree with this?

Thank you!

Pledging and rewards

Can you please update the page 'Pledging and rewards' with the following two items:

• In the formula f(s,sigma) sigma stands for relative total stake and in the formula beta/sigma, sigma stands for relative active stake.
• The monetary expansion is adjusted by min(1, èta).

I've spend a lot of time figuring out why my calculations didn't match the real rewards my pool got, and those two things (especially the first one), were the problem. Only after stumbling upon the document at https://hydra.iohk.io/build/5737201/download/1/delegation_design_spec.pdf, all was suddenly clear.

Thank you!

Code display issue

Hi,

I hope I am writing in the correct place.
On this page (link) code snippets do not show properly in section:

• What does a Marlowe contract look like?
• Sample Escrow Contract

I have reproduced this issue in Google Chrome, Firefox, Safari and Brave.
I have attached screenshots for reference.

Issue#1

Issue#2

invalid link on page

page https://docs.cardano.org/en/latest/getting-started/stake-pool-operators/operational-certificate.html

You can see an example of a transaction containing certificates here.

this link doesn't valid https://github.com/input-output-hk/cardano-tutorials/blob/master/node-setup/node-op-cert

Remove Chivo font-family from body text

Consider removing body from the list of tags that are targeted by the Chivo font-family. It is difficult to read and functions better as a font-family for htags.

docs-cardano-org/.sphinx/_static/css/custom.css

Lines 9 to 12 in 080c362

	body, h1, h2, h3, h4, h5, h6 {
	font-family: 'Chivo', sans-serif;
	letter-spacing: .03rem;
	}

Explain how delegation by pool owners differ from delegation by pool stakers?

In https://github.com/cardano-foundation/docs-cardano-org/blob/main/explore-cardano/understanding-pledging-and-rewards.md is this statement:

Remember that the pledge is declared during pool registration, (alongside the cost and margin values), and has to be honored by the pool owners who are delegating to the pool: If they collectively delegate less than the declared pledge, pool rewards for that epoch will be zero.

How does the network know which wallets that delegate to a pool belong to "pool owners"? Say I set up a pool, I configure the pledge parameter to 100k and once pool is visible in daedalus wallet, I delegate to it my wallet with > 100k ADA. How does the network know that I am the pool owner in order to confirm that pledge is fullfilled? Or does the ADA for pledge need to be present on some wallet associated directly with the pool? How can I make such association?

This is somewhat confusing right now. Can someone with better insight clear this up? From network point of view who is "pool owner" how is their wallet identified? Or is the pledge also fullfilled when the sum of all staked ADA by all delegators is higher than pledged value? Therefore being rather irrelevant if staked ADA really belongs to pool owners or not?

Install the newly built node and CLI commands to the ~/.local/bin directory

Please advise next steps i have ran into this issue several times and i am not sure what to do here.