Skip to content

Commit ac7ab8b

Browse files
authored
Merge pull request #1175 from Concordium/DOC301-ReviewSmartContracts
Finished review on What is a smart contract section
2 parents 6c2daa7 + ef83055 commit ac7ab8b

File tree

6 files changed

+10
-7
lines changed

6 files changed

+10
-7
lines changed

source/mainnet/docs/smart-contracts/contract-instances.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ transaction for attempting to create the instance is visible on-chain.
9191

9292
.. seealso::
9393

94-
See :ref:`initialize-contract` guide for how to initialize a
94+
See the :ref:`initialize-contract` guide for how to initialize a
9595
contract in practice. You can also watch a video about initializing smart contract instances.
9696

9797
.. raw:: html

source/mainnet/docs/smart-contracts/contract-lifecycle.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ A smart contract is first deployed to the chain as part of a :ref:`contract
88
module <contract-module>`. After this a smart contract can be *initialized* to
99
obtain a :ref:`smart contract instance <contract-instances>`. Finally a smart
1010
contract instance can be repeatedly updated according to its own logic.
11+
Before you can follow this guide, you need to :ref:`setup the development environment <setup-env>`.
12+
1113

1214
.. image:: images/smart-contract-lifecycle.png
1315
:width: 100%

source/mainnet/docs/smart-contracts/contract-module.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ the code.
4444
Wasm is a low-level language and it is impractical to write by hand. Instead, you
4545
can write smart contracts in a more high-level language that is then
4646
compiled to Wasm. The best supported high-level language on Concordium is Rust.
47+
You can read :ref:`this article <writing-smart-contracts>` for more information regarding using Rust on Concordium.
4748

4849
.. _wasm-limitations:
4950

@@ -75,7 +76,7 @@ point values.
7576
Deployment
7677
==========
7778

78-
Deploying a module to the chain means submitting the module bytecode as a
79+
:ref:`Deploying <deploy-module>` a module to the chain means submitting the module bytecode as a
7980
transaction to the Concordium network. If *valid*, this transaction will be
8081
included in a block. This transaction, as every other transaction, has an
8182
associated cost. The cost is based on the size of the bytecode and is charged

source/mainnet/docs/smart-contracts/develop-contracts.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -420,5 +420,5 @@ macro, e.g.: ``#[init(..., payable)]`` and ``#[receive(..., payable)]``.
420420
.. |StateMap| replace:: ``StateMap``
421421
.. _StateSet: https://docs.rs/concordium-std/latest/concordium_std/struct.StateSet.html
422422
.. |StateSet| replace:: ``StateSet``
423-
.. _payable: https://docs.rs/concordium-std-derive/latest/concordium_std_derive/attr.init.html#payable-make-function-accept-an-amount-of-ccd
423+
.. _payable: https://docs.rs/concordium-std/latest/concordium_std/attr.receive.html#payable-make-function-accept-an-amount-of-ccd
424424
.. |payable| replace:: ``payable``

source/mainnet/docs/smart-contracts/guides/build-contract.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ Once you are familiar with smart contracts, it is a good idea to read the :ref:`
1414
To request CCDs for testing, use the buttons in the Concordium Wallets when running Testnet.
1515

1616

17-
Before you can start developing smart contracts, you need to setup the
18-
environment.
17+
Before you can start developing smart contracts, you need to :ref:`setup the development environment <setup-env>`.
1918

2019
You can also watch a video about installing the smart contract tools.
2120

source/mainnet/docs/smart-contracts/introduction.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
What is a smart contract
1212
===============================
1313

14-
Already know what smart contracts are? Go to the :ref:`quick guide<sc-quick-start>` to start building smart contracts on Concordium right away.
14+
Already know what smart contracts are? Go to the :ref:`quick start guide<sc-quick-start>` to start building smart contracts on Concordium right away.
1515

1616
A :term:`smart contract` is a user-supplied piece of code submitted to the Concordium
1717
blockchain, used to define behavior that is not directly part of the core
@@ -81,7 +81,8 @@ does not fulfil their obligations. This will most likely mean that the contract
8181
needs to support some notion of proof that the seller has indeed fulfilled their
8282
obligation, or some way for the highest bidder to file a complaint. Smart
8383
contracts cannot resolve these real-world issues automatically, and the best
84-
solution is likely going to depend on the specifics of the auction.
84+
solution is likely going to depend on the specifics of the auction. You can find
85+
an example implementation of the auction contract on `this repository <https://github.com/Concordium/concordium-rust-smart-contracts/tree/main/examples/auction>`_
8586

8687
Additional reading
8788
------------------

0 commit comments

Comments
 (0)