mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
docs: Replace some links with redirects found by linkcheck
This commit is contained in:
parent
20138f35df
commit
986bc361b1
@ -8,7 +8,7 @@ Contracts can be created "from outside" via Ethereum transactions or from within
|
|||||||
|
|
||||||
IDEs, such as `Remix <https://remix.ethereum.org/>`_, make the creation process seamless using UI elements.
|
IDEs, such as `Remix <https://remix.ethereum.org/>`_, make the creation process seamless using UI elements.
|
||||||
|
|
||||||
One way to create contracts programmatically on Ethereum is via the JavaScript API `web3.js <https://github.com/ethereum/web3.js>`_.
|
One way to create contracts programmatically on Ethereum is via the JavaScript API `web3.js <https://github.com/web3/web3.js>`_.
|
||||||
It has a function called `web3.eth.Contract <https://web3js.readthedocs.io/en/1.0/web3-eth-contract.html#new-contract>`_
|
It has a function called `web3.eth.Contract <https://web3js.readthedocs.io/en/1.0/web3-eth-contract.html#new-contract>`_
|
||||||
to facilitate contract creation.
|
to facilitate contract creation.
|
||||||
|
|
||||||
|
@ -151,6 +151,6 @@ The output of the above looks like the following (trimmed):
|
|||||||
Additional Resources for Understanding Events
|
Additional Resources for Understanding Events
|
||||||
=============================================
|
=============================================
|
||||||
|
|
||||||
- `Javascript documentation <https://github.com/ethereum/web3.js/blob/1.x/docs/web3-eth-contract.rst#events>`_
|
- `Javascript documentation <https://github.com/web3/web3.js/blob/1.x/docs/web3-eth-contract.rst#events>`_
|
||||||
- `Example usage of events <https://github.com/ethchange/smart-exchange/blob/master/lib/contracts/SmartExchange.sol>`_
|
- `Example usage of events <https://github.com/ethchange/smart-exchange/blob/master/lib/contracts/SmartExchange.sol>`_
|
||||||
- `How to access them in js <https://github.com/ethchange/smart-exchange/blob/master/lib/exchange_transactions.js>`_
|
- `How to access them in js <https://github.com/ethchange/smart-exchange/blob/master/lib/exchange_transactions.js>`_
|
||||||
|
@ -102,9 +102,9 @@ This can be easiest accomplished using Homebrew: ``brew install coreutils``.
|
|||||||
On Windows systems, make sure that you have a privilege to create symlinks,
|
On Windows systems, make sure that you have a privilege to create symlinks,
|
||||||
otherwise several tests may fail.
|
otherwise several tests may fail.
|
||||||
Administrators should have that privilege, but you may also
|
Administrators should have that privilege, but you may also
|
||||||
`grant it to other users <https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/create-symbolic-links#policy-management>`_
|
`grant it to other users <https://learn.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/create-symbolic-links#policy-management>`_
|
||||||
or
|
or
|
||||||
`enable Developer Mode <https://docs.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development>`_.
|
`enable Developer Mode <https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development>`_.
|
||||||
|
|
||||||
Running the Tests
|
Running the Tests
|
||||||
-----------------
|
-----------------
|
||||||
|
@ -36,7 +36,7 @@ Creating the signature
|
|||||||
Alice does not need to interact with the Ethereum network
|
Alice does not need to interact with the Ethereum network
|
||||||
to sign the transaction, the process is completely offline.
|
to sign the transaction, the process is completely offline.
|
||||||
In this tutorial, we will sign messages in the browser
|
In this tutorial, we will sign messages in the browser
|
||||||
using `web3.js <https://github.com/ethereum/web3.js>`_ and
|
using `web3.js <https://github.com/web3/web3.js>`_ and
|
||||||
`MetaMask <https://metamask.io>`_, using the method described in `EIP-712 <https://github.com/ethereum/EIPs/pull/712>`_,
|
`MetaMask <https://metamask.io>`_, using the method described in `EIP-712 <https://github.com/ethereum/EIPs/pull/712>`_,
|
||||||
as it provides a number of other security benefits.
|
as it provides a number of other security benefits.
|
||||||
|
|
||||||
|
@ -185,7 +185,7 @@ arguments ``from``, ``to`` and ``amount``, which makes it possible to track
|
|||||||
transactions.
|
transactions.
|
||||||
|
|
||||||
To listen for this event, you could use the following
|
To listen for this event, you could use the following
|
||||||
JavaScript code, which uses `web3.js <https://github.com/ethereum/web3.js/>`_ to create the ``Coin`` contract object,
|
JavaScript code, which uses `web3.js <https://github.com/web3/web3.js/>`_ to create the ``Coin`` contract object,
|
||||||
and any user interface calls the automatically generated ``balances`` function from above:
|
and any user interface calls the automatically generated ``balances`` function from above:
|
||||||
|
|
||||||
.. code-block:: javascript
|
.. code-block:: javascript
|
||||||
|
@ -182,7 +182,7 @@ Syntax and Semantics
|
|||||||
Solidity supports import statements to help modularise your code that
|
Solidity supports import statements to help modularise your code that
|
||||||
are similar to those available in JavaScript
|
are similar to those available in JavaScript
|
||||||
(from ES6 on). However, Solidity does not support the concept of
|
(from ES6 on). However, Solidity does not support the concept of
|
||||||
a `default export <https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export#Description>`_.
|
a `default export <https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export#description>`_.
|
||||||
|
|
||||||
At a global level, you can use import statements of the following form:
|
At a global level, you can use import statements of the following form:
|
||||||
|
|
||||||
|
@ -46,7 +46,7 @@ for the purposes of NatSpec.
|
|||||||
|
|
||||||
- For Vyper, use ``"""`` indented to the inner contents with bare
|
- For Vyper, use ``"""`` indented to the inner contents with bare
|
||||||
comments. See the `Vyper
|
comments. See the `Vyper
|
||||||
documentation <https://vyper.readthedocs.io/en/latest/natspec.html>`__.
|
documentation <https://docs.vyperlang.org/en/latest/natspec.html>`__.
|
||||||
|
|
||||||
The following example shows a contract and a function using all available tags.
|
The following example shows a contract and a function using all available tags.
|
||||||
|
|
||||||
|
@ -28,7 +28,7 @@ Integrated (Ethereum) Development Environments
|
|||||||
* `Embark <https://framework.embarklabs.io/>`_
|
* `Embark <https://framework.embarklabs.io/>`_
|
||||||
Developer platform for building and deploying decentralized applications.
|
Developer platform for building and deploying decentralized applications.
|
||||||
|
|
||||||
* `Foundry <https://github.com/gakonst/foundry>`_
|
* `Foundry <https://github.com/foundry-rs/foundry>`_
|
||||||
Fast, portable and modular toolkit for Ethereum application development written in Rust.
|
Fast, portable and modular toolkit for Ethereum application development written in Rust.
|
||||||
|
|
||||||
* `Hardhat <https://hardhat.org/>`_
|
* `Hardhat <https://hardhat.org/>`_
|
||||||
@ -37,7 +37,7 @@ Integrated (Ethereum) Development Environments
|
|||||||
* `Remix <https://remix.ethereum.org/>`_
|
* `Remix <https://remix.ethereum.org/>`_
|
||||||
Browser-based IDE with integrated compiler and Solidity runtime environment without server-side components.
|
Browser-based IDE with integrated compiler and Solidity runtime environment without server-side components.
|
||||||
|
|
||||||
* `Truffle <https://www.trufflesuite.com/truffle>`_
|
* `Truffle <https://trufflesuite.com/truffle/>`_
|
||||||
Ethereum development framework.
|
Ethereum development framework.
|
||||||
|
|
||||||
Editor Integrations
|
Editor Integrations
|
||||||
@ -50,7 +50,7 @@ Editor Integrations
|
|||||||
|
|
||||||
* IntelliJ
|
* IntelliJ
|
||||||
|
|
||||||
* `IntelliJ IDEA plugin <https://plugins.jetbrains.com/plugin/9475-intellij-solidity>`_
|
* `IntelliJ IDEA plugin <https://plugins.jetbrains.com/plugin/9475-solidity/>`_
|
||||||
Solidity plugin for IntelliJ IDEA (and all other JetBrains IDEs).
|
Solidity plugin for IntelliJ IDEA (and all other JetBrains IDEs).
|
||||||
|
|
||||||
* Sublime Text
|
* Sublime Text
|
||||||
|
@ -17,11 +17,11 @@ conflicts, project specific style guides take precedence.
|
|||||||
|
|
||||||
The structure and many of the recommendations within this style guide were
|
The structure and many of the recommendations within this style guide were
|
||||||
taken from python's
|
taken from python's
|
||||||
`pep8 style guide <https://www.python.org/dev/peps/pep-0008/>`_.
|
`pep8 style guide <https://peps.python.org/pep-0008/>`_.
|
||||||
|
|
||||||
The goal of this guide is *not* to be the right way or the best way to write
|
The goal of this guide is *not* to be the right way or the best way to write
|
||||||
Solidity code. The goal of this guide is *consistency*. A quote from python's
|
Solidity code. The goal of this guide is *consistency*. A quote from python's
|
||||||
`pep8 <https://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds>`_
|
`pep8 <https://peps.python.org/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds>`_
|
||||||
captures this concept well.
|
captures this concept well.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
Loading…
Reference in New Issue
Block a user