Commit Graph

3326 Commits

Author SHA1 Message Date
Daniel Kirchner
f2c930588c
Merge pull request #13079 from uji/sort-grammer-rules
Sort grammar rules of SolidityLexer.g4
2022-06-08 12:55:59 +02:00
Prajwal Borkar
6061219641 Fix link to the optimizer step sequence in optimizer.rst 2022-05-31 15:41:22 +02:00
uji
5f6f353953 Sort grammer rules of SolidityLexer.g4 2022-05-30 00:15:48 +09:00
shady41
ecb7c0b008 Moved operator precedence from the cheatsheet to the operator docs 2022-05-25 23:07:51 +02:00
Dustin Alandzes
10c991c3ff
expect -> except in docs/contributing.rst 2022-05-24 23:14:21 -05:00
chriseth
f0e43921f7
Merge pull request #12921 from ethereum/add_event_and_error_selector_fields_on_the_line_of_function_selector_field
Adding event and error selector fields
2022-05-23 11:34:13 +02:00
nishant-sachdeva
d4c06d2b4e Adding event and error selector fields on the lines of the function selector fields 2022-05-23 10:49:16 +02:00
Josep M Sobrepere
5575bb9d99
nit: ABI docs use canonical representation 2022-05-21 23:29:25 +02:00
Samuel Osewa
2dee5dcfae Removed notes section 2022-05-20 15:41:35 +02:00
chriseth
0bd0bf4c7d Set release date. 2022-05-17 13:50:26 +02:00
chriseth
f427247993 Bug list entry. 2022-05-17 13:04:06 +02:00
alpharush
93755fcb70
document that pop does not return last element
It's already documented for push and this would clarify my incorrect assumption (that pop returns a value as in other languages) that caused confusion with https://github.com/ethereum/solidity/issues/13017
2022-05-13 09:45:55 -05:00
Daniel Kirchner
aafda389ea
Merge pull request #12907 from ethereum/calldataReencodeValidationBug
Calldatasize-check during ABI encoding from calldata values with nested dynamic arrays.
2022-05-12 17:56:44 +02:00
Leo Alt
2fe143f7d0 add changelog entry and docs note 2022-05-12 13:43:28 +02:00
Daniel Kirchner
352a3c5f4b Bug list entry, changelog entry and tests. 2022-05-12 13:08:30 +02:00
Florian Sey
c7d57031b5 Improve wording on voting example
From a beginner perspective, it is the first time in the documentation
that the term wallets is used. Other terms such as accounts or addresses
are explained in the Introduction to smart contracts.
2022-05-06 01:01:37 +02:00
Nobuhiko Otoba
f6c0edc902 Add a require statement to the Ballot contract 2022-04-30 12:51:59 +02:00
aathan
43ff61f185
Update functions.rst 2022-04-15 12:24:48 -07:00
Kamil Śliwak
e684b36b25
Merge pull request #12908 from tharun634/move-docs
Moved `docs.sh` script to `docs/`
2022-04-11 13:51:05 +02:00
sourabh.xyz
9867fbcfb0
Update inheritance.rst
Fixed typo 'owned' → 'Owned'.
2022-04-09 13:17:07 +05:30
Kamil Śliwak
23e77e9a84 docs.sh: Fail on all errors, includding undefined variables and failures in piped commands 2022-04-08 20:41:31 +02:00
Kamil Śliwak
efd0024853 docs.sh: Make the script independent of the working directory 2022-04-08 20:41:31 +02:00
Tharun K
a608bc12f7 Moved docs.sh script to docs/ 2022-04-08 20:41:22 +02:00
chriseth
22d8c0aecd Some updates to gas and delegatecall. 2022-04-07 21:34:36 +02:00
Kamil Śliwak
e340cf6ca2
Merge pull request #12876 from aathan/why-is-this-inline-assembly-not-memory-safe
[Docs] clarify the reason for the memory-unsafe assembly example being unsafe
2022-04-07 18:41:41 +02:00
aathan
9e2b26e046 Clarify the reason for the memory-unsafe assembly example being unsafe 2022-04-07 18:03:02 +02:00
Kamil Śliwak
0dd7f9c871
Merge pull request #12901 from aathan/clarify-base-contract-constructors
Clarify base contract constructors (re request of PR #12872)
2022-04-07 13:33:05 +02:00
andreb0x
60416120af Update introduction-to-smart-contracts.rst
modifying "write" to "transactions"
2022-04-07 10:05:46 +05:30
andreb0x
39f3175a37 updates to gas section
small modifications for clarity

updates to delegatecall

Update introduction-to-smart-contracts.rst

modifying "write" to "transactions"

updates to gas section

small modifications for clarity

Update introduction-to-smart-contracts.rst

modifying "write" to "transactions"

updates to gas section

small modifications for clarity

updates to delegatecall
2022-04-07 10:05:46 +05:30
aathan
fd0df0b05d
Update inheritance.rst 2022-04-05 12:19:59 -07:00
aathan
6f4844648f abstract-contracts.rst: Clarify when a contract may or must be marked abstract 2022-04-04 14:21:49 +02:00
aathan
54fa215885
Update mapping-types.rst
typo
2022-03-23 17:15:17 -07:00
aathan
07c9384b44
Update value-types.rst 2022-03-22 23:06:23 -07:00
Hector Roussille
040c444a2a Fixed ambiguity in the create2 address computation doc
specify that arguments are encoded using abi.encode in the example code
2022-03-16 19:56:11 +01:00
chriseth
1be21e2670 Move state variable initialization to top. 2022-03-16 12:23:23 +01:00
chriseth
acd488532d Set release date. 2022-03-16 10:28:40 +01:00
chriseth
0bc29f2cb5 Using for at file level. 2022-03-15 12:07:28 +01:00
chriseth
c6ac1625bd
Merge pull request #12773 from ethereum/encodeCallBug
Fix encodeCall bug.
2022-03-15 10:52:13 +01:00
Daniel Kirchner
8cb01a9953 Fix and updated test. 2022-03-15 10:23:09 +01:00
Daniel Kirchner
353759c1d4
Merge pull request #12680 from devtooligan/fix/underscore-prefix
fix: corrects _ prefixes
2022-03-14 22:58:42 +01:00
chriseth
9188519f11 Using for with global binding. 2022-03-14 17:39:14 +01:00
Richie
beb51068bb
fix: corrects _ prefixes 2022-03-14 08:03:10 -07:00
Daniel Kirchner
e58c0b561d Mark viaIR code generation as non-experimental. 2022-03-14 14:48:00 +01:00
hrkrshnn
672951ccc7 Extend using-for. 2022-03-14 12:33:44 +01:00
nishant-sachdeva
b7a9daa2f8 Generate warning when rational numbers are converted to their mobile type without explicit requests 2022-03-14 14:04:46 +05:30
chriseth
356c83ad8e
Merge pull request #12763 from kanedaaaa/develop
doc: improve explanation of interfaces
2022-03-10 08:45:21 +01:00
kanedaaaa
1b93db7863 doc: improve explanation of interfaces 2022-03-09 18:35:14 +01:00
Daniel Kirchner
b57e856426 Adjust documentation. 2022-03-09 17:53:28 +01:00
chriseth
145186f68c
Merge pull request #12723 from ethereum/docs-translation-updates
[DOCS] Updated translation links / rewording of language influences
2022-03-07 18:09:29 +01:00
franzihei
4d9a078798 updates index with language links 2022-03-07 13:05:00 +01:00
chriseth
57e012da98
Merge pull request #12663 from ethereum/assemblyAnnotationDialectString
Assembly annotation as memory-safe using assembly flags.
2022-03-07 13:03:08 +01:00
chriseth
4f19d68ee9
Merge pull request #12620 from ethereum/assemblyAnnotation
Memory-safety annotation for inline assembly.
2022-03-07 12:48:41 +01:00
Leo
7c91dd05a7
Merge pull request #12741 from david-k/develop
[Doc] Fix leftover use of divModWithSlacks
2022-03-07 10:12:47 +01:00
Daniel Kirchner
198b705361
Merge pull request #12721 from ethereum/fixIterableMapping
Fix iterable mapping example.
2022-03-04 15:27:56 +01:00
david-k
cb4ffbfbb7
Fix leftover use of divModWithSlacks in doc
The option `divModWithSlacks` was previously changed to `divModNoSlacks`.
However, this was not reflected in the documentation.
2022-03-04 11:02:54 +01:00
Daniel Kirchner
46d8611e90 Adjust grammar. 2022-03-02 17:07:11 +01:00
Daniel Kirchner
0381de54c2 Update docs. 2022-03-02 17:07:11 +01:00
Daniel Kirchner
62a997ac97 Documentation. 2022-03-02 16:42:28 +01:00
chriseth
466251b5a0
Merge pull request #12689 from callezenwaka/develop
Fix typos on doc
2022-02-28 19:04:03 +01:00
Callis Ezenwaka
5134dafb8e Update typo in using-for.rst
Update typo in using-for.rst
2022-02-28 19:03:13 +01:00
chriseth
fb7cdda891 Fix iterable mapping example. 2022-02-28 17:57:19 +01:00
chriseth
5a94a7c9be
Merge pull request #12698 from Abdulkarim4u/develop
fixed grammar on doc.
2022-02-28 12:40:01 +01:00
Richie
49f06dacdf fix: remove lower_case_with_underscores and Capitalized_Words_With_Underscores from code examples 2022-02-21 10:53:35 -08:00
Abdul Karim Moro
2834003848
fixed grammar on doc.
If readers can gain additional pieces of  information on smart contracts, then  "more details" should be correct.
2022-02-19 08:31:26 +09:00
Wes Bouaziz
e9cc45b258
Fixing a typo in doc's EVM dialect in Yul's doc.
It's the tiniest typo but it's visible on the website.
2022-02-17 10:57:28 +01:00
Richie
635ca409f8 fix: shorten line length per code review 2022-02-16 12:06:33 -08:00
Sleepy
59f28d385a Added solidity visual auditor for VSCode 2022-02-16 11:05:41 +01:00
chriseth
49bc8206f1 Set release date. 2022-02-16 09:49:14 +01:00
Richie
e2d87c1bcc tweak: expand definition of suggested collision naming convention 2022-02-15 19:35:11 -08:00
William Entriken
9d94870770 Fix typos 2022-02-15 19:17:05 -05:00
chriseth
7a5be4a063
Merge pull request #12462 from semaraugusto/develop
[docs] fix issue with delegating votes to wallets who cannot vote.
2022-02-15 09:27:33 +01:00
Aleksey Bykhun
408b8e2f76 docs: note on invalid SPDX UNLICENSED
https://github.com/ethereum/solidity/issues/12251
2022-02-14 20:07:36 +01:00
Daniel Kirchner
88f624c352
Merge pull request #12660 from amsavarthan/patch-1
Highlighted "revert" command
2022-02-14 11:40:47 +01:00
Laurent
1188795449
Solve issue 12658 ; Solving wrong syntax.
Solve this issue : https://github.com/ethereum/solidity/issues/12658
2022-02-13 17:32:09 +01:00
Amsavarthan Lv
e3ebcd63cf
Highlighted "revert" command
When reading through the documentation, I found that highlighting was missed for the revert command and added that.
2022-02-13 15:17:37 +05:30
nishant-sachdeva
276851ff91 Added support for FunctionType::Kind::StringConcat and functions string.concat 2022-02-10 22:08:47 +05:30
William Entriken
c6c7f3525d Note about storage compatability mode 2022-02-09 21:30:11 -05:00
Kamil Śliwak
122ad0770a
Merge pull request #12632 from a3d4/symlinks-on-windows
Clarify symlink handling on Windows
2022-02-08 13:16:24 +01:00
chriseth
d744c0d617
Merge pull request #12637 from Hakeemmidan/patch-1
Update docs/cheatsheet.rst
2022-02-07 13:04:43 +01:00
chriseth
a9b9170a1b
Merge pull request #12636 from fulldecent/patch-25
Fix signature of pop member
2022-02-07 13:03:51 +01:00
Naveen Sahu
2e2094ad82 plain address can be sent Ether too
The docs state that a plain `address` cannot be sent Ether. But even though `send` and `transfer` members are not available for plain `address`, the `call` is. And `call` can be invoked upon a plain `address` type to send Ether to the address.

For instance, the `someone` (`address` type) can be sent Ether by invoking `sendSomeone()` method in the following `Dummy` contract:

```
contract Dummy {
    address someone = 0xAb8...cb2;

    function balanceOf(address addr) public view returns (uint) {
        return addr.balance;
    }

    function sendToSomeone() public payable returns (bool) {
        (bool sent, ) = someone.call{value: msg.value}("");
        return sent;
    }
}
```
2022-02-07 12:44:21 +01:00
Hakeem Almidan
c3145979fc
Update cheatsheet.rst
Add more description to the bullet point of 'block.timestamp' (under 'Global Variables')
2022-02-06 20:16:04 +03:00
William Entriken
6bd38aa4ef
Fix signature of pop member 2022-02-05 23:59:09 -05:00
a3d4
7634fc4ea9 Clarify symlink handling on Windows 2022-02-05 03:44:54 +01:00
Ayush Shukla
653c1e6842
Fix slot calculation for bytes/string mapping 2022-02-05 01:00:27 +05:30
Kamil Śliwak
93d5b79e5c
Merge pull request #12599 from ethereum/docs-resources
[DOCS] Adding a few resources to resources section
2022-02-04 15:06:34 +01:00
William Entriken
dcaa094f1f Add NatSpec note for libraries 2022-02-02 18:11:14 -05:00
franzihei
8bcc4ee7d1 Adding a few resources 2022-01-31 20:21:42 +01:00
chriseth
8728971354
Correct type of address.code 2022-01-31 19:07:01 +01:00
Nikita Stupin
0f7b69432e Separate visibility for state variables and functions 2022-01-29 00:36:06 +01:00
Kamil Śliwak
f386ed28a0
Merge pull request #12592 from Younghoon-Lee/Fix/style-guide
Add blank line to make it consistency
2022-01-29 00:07:19 +01:00
Younghoon-Lee
95f9289f2c Add blank line to make it consistency 2022-01-28 01:11:35 +09:00
William Entriken
8c6f80aa03 Document our version policy w/r/t SemVer 2022-01-27 09:45:31 -05:00
Markus Waas
8bfc9ad829 Add msg.sig to cheatsheet 2022-01-24 10:21:01 +01:00
Bruno Barbieri
9a13917049
Add modifiers to the order of layout 2022-01-20 20:20:30 -05:00
Daniel Kirchner
79e9d619a3
Merge pull request #12545 from ethereum/yulGrammarFluke
Allow builtins in yul identifier paths in antlr grammar.
2022-01-17 20:42:14 +01:00
Daniel Kirchner
2d0f6278bb Allow builtins as yul identifier paths in antlr grammar. 2022-01-17 18:42:54 +01:00
Daniel Kirchner
776c984cb0 Adjust documentation for linux packages not maintained by us. 2022-01-17 16:10:39 +01:00
William Entriken
78f0be56c3 Document address members code and codehash 2022-01-13 01:20:45 -05:00
Harikrishnan Mulackal
eee30b6ead
Merge pull request #12504 from brien-tech/patch-1
Fixing typo in "smart contracts"
2022-01-10 13:43:23 +05:30
Brien
790e7f42a1
Fixing typo in "smart contracts" 2022-01-10 02:29:51 -05:00
Mohamed Safouen Bouabid
4c20821e6d Explaining payable(msg.sender)
At this point of the documentation a new Solidity learner will not understand this line without further explanation:
if (!payable(msg.sender).send(amount)) {
It should explain how msg.sender is of type "address" and not "address payable" so it cannot send or receive Ether. Therefore it must be explicitly converted to payable.
2022-01-10 12:49:30 +05:30
Esquith Allen
b1ef5de496 fix typo 2022-01-05 21:58:41 -05:00
chriseth
c16867cb83
Merge pull request #12272 from ethereum/equalStoreEliminator
Equal store eliminator.
2022-01-05 11:24:59 +01:00
William Entriken
c798ac472e Typo: SemVer 2022-01-04 18:59:40 -05:00
Daniel Kirchner
cac0f203a2
Merge pull request #12467 from ethereum/fixMappingExample
Fix mapping example.
2022-01-04 18:23:57 +01:00
Braden Watling
bb16c1943c Fix gas retaining statement.
According to https://docs.soliditylang.org/en/v0.8.11/introduction-to-smart-contracts.html?highlight=63%2F64#message-calls, the caller forwards 63/64th of its gas, but here we seem to contradict that by saying the caller retains 63/64th of its gas.
2022-01-04 11:10:31 +01:00
Braden Watling
6fe1ee6a8a
Fix typo in control-structures.rst
I'm learning Solidity by reading these docs and found this statement confusing. I'm fairly certain that the correct description here is that the *callee* changes get reverted, but the caller is able to react to the failures.

I tested this with the following snippet in Remix, which resulted in a successful transaction when deployed:

```
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.7;

contract A {
    uint public value;

    function a(uint newValue, bool shouldRevert) external {
        value = newValue;
        if (shouldRevert) {
            revert();
        }
    }
}

contract B {
    function b() external {
        A a = new A();
        try a.a(50, false) {
            assert(a.value() == 50);
        } catch {
            assert(false);
        }
        a = new A();
        try a.a(50, true) {
            assert(false);
        } catch {
            assert(a.value() == 0);
        }
    }
}
```
2022-01-03 17:22:23 -05:00
chriseth
b354c81a63 Documentation 2022-01-03 15:52:05 +01:00
chriseth
57474917a0 Clarify which functions are added. 2022-01-03 15:38:39 +01:00
Pranay Reddy
f30130888e Added specificity to data location.
Added the specificity that bytes1[] and bytes differ because of padding only in memory data location. Added extra sentence that they are similar when used in storage data location.
2022-01-03 12:47:51 +05:30
chriseth
0010027e17 Fix mapping example. 2021-12-30 15:28:09 +01:00
Franziska Heintel
4456eeb6bb
[DOCS] update contributing section meeting link 2021-12-29 16:06:05 +01:00
Semar Augusto
6fbfa33486
Update docs/examples/voting.rst
Co-authored-by: Bhargava Shastry <bshastry@ethereum.org>
2021-12-29 07:04:13 -03:00
semaraugusto
942a3301dc fix issue with delegating votes to people who cannot vote. That made it so that if wallet A delegated to wallet B and B had no rights to vote, than B would lose out on its own vote 2021-12-29 00:17:15 -03:00
Kamil Śliwak
dece5f4de2 pylint: Enable and fix redefined-builtin warnings 2021-12-21 15:30:11 +01:00
Kamil Śliwak
5b10ff1216 pylint: Enable and fix singleton-comparison warnings 2021-12-21 15:30:11 +01:00
chriseth
25a3bf2df0 Set release date. 2021-12-20 13:15:58 +01:00
GitHubPang
1b0cef4624
Fix a few typos 2021-12-20 10:56:39 +08:00
Marenz
7a96953e78 Implement typechecked abi.encodeCall() 2021-12-16 17:35:58 +01:00
chriseth
c15ef45d29 Explanation about operators. 2021-12-15 18:37:18 +01:00
Alessandro Coglio
d17f7206ad Improve description of break/continue restrictions.
This is as discussed on Element, with enhancements discussed with @cameel.
2021-12-13 21:59:25 -08:00
dinah
f0aadcf577 Remove stale link. 2021-12-13 12:04:23 +01:00
Omkar Nikhal
01d45a1952 Remove redundant typo 2021-12-13 11:36:07 +01:00
chriseth
d414153258 Some clarifications on literals. 2021-12-06 17:36:34 +01:00
minami
6bafeca8a2 Fix yul 2021-12-05 16:58:03 +09:00
minami
907405e2e0 Fix units-and-global-variables 2021-12-05 16:57:59 +09:00
minami
25a26d2f8b Fix cheatsheet 2021-12-05 16:57:48 +09:00
Saska Karsi
105de2561a
rm trailing comma in style-guide.rst example 2021-12-03 01:11:04 +02:00
chriseth
829fe6615b Fix Yul example. 2021-12-01 16:23:26 +01:00
chriseth
d2585fd91d
Merge pull request #12322 from tzann/patch-1
Fix ExpressionSplitter example
2021-12-01 15:44:57 +01:00
Tynan Richards
d56fb3afff Fix ExpressionSplitter example
Fix error (0x123 and 0x456 were swapped) and split constants into expressions
2021-12-01 15:43:50 +01:00
Dallon Asnes
310f74302d Add fixed size type details to encodePacked doc 2021-11-29 15:31:52 -06:00
nishant-sachdeva
bd399e37e3 restoring the RTD section. Downloads section to still be above versions section 2021-11-30 00:20:27 +05:30
nishant-sachdeva
ecf6c8e122 trailing whitespace removed in index.rst as per the requirements of a syntax test 2021-11-26 09:29:27 +05:30
nishant-sachdeva
5e59325d06 relocated downloads section in versions flyout menu and added downloads Hint in index.html 2021-11-26 09:29:27 +05:30
Kamil Śliwak
9b6a687a24
Merge pull request #12308 from dallonasnes/docs-typo-fix
Fix typo in intro to smart contracts
2021-11-22 23:56:46 +01:00
Dallon Asnes
ef3c562160
Fix typo 2021-11-22 15:18:43 -06:00
Alex Beregszaszi
b36a3c6bf5
Fix documentation for valid ASCII string literals 2021-11-20 22:41:19 +00:00
Alessandro Coglio
d3b2463166 Improve description of literal evaluation. 2021-11-10 23:17:47 -08:00
Daniel Kirchner
f2d9a806e0 Document change to BlockFlattener. 2021-11-09 13:29:10 +01:00
chriseth
45c9dbe174 Sort changelog and set release date. 2021-11-08 17:28:53 +01:00
chriseth
df85d26406 Update ir-breaking-changes and make it visible. 2021-11-08 17:23:17 +01:00
chriseth
4f8719326c
Merge pull request #12205 from ethereum/optimizeextocedsizecheck
Skip extcodesize check if return data is expected.
2021-11-08 16:05:03 +01:00
chriseth
f320a95dd9 Update documentation. 2021-11-08 14:58:09 +01:00
chriseth
aa4d3cabf1 Clarify `pure`. 2021-11-08 13:22:35 +01:00
chriseth
ea3c34a082
Merge pull request #12254 from ethereum/optimizerDocsForLoopInitRewriter
Remove incorrect outer block from for loop init rewriter documentation.
2021-11-08 11:55:05 +01:00
Daniel Kirchner
be552683c9 Remove incorrect outer block from for loop init rewriter documentation. 2021-11-08 10:58:28 +01:00
Shivam Rajput
063d00adc8
0.y.z makes more sense than 0.x for the current version. 2021-11-07 10:41:48 +05:30
Daniel Kirchner
a0dee79ad2 Remove install_deps script. 2021-11-04 12:07:27 +01:00
José López
b4a527039f fixed example address payable 2021-11-03 20:21:31 -03:00
Marenz
61519da4f0 Fix wrong path to isoltest in docs 2021-10-27 14:16:50 +02:00
Leo Alt
d04ad57ee7 Docs 2021-10-26 11:30:30 +02:00
chriseth
719b70893f
Merge pull request #12144 from ethereum/clarify-linkersymbol-docs-regarding-fqln
Clarify that `linkersymbol()` accepts but does not require a fully qualified library name
2021-10-26 11:10:34 +02:00
Adam Bliss
3387e134d7
Fix typo compiler->constructor. 2021-10-24 08:22:34 -04:00
Gyeonghun Park
921d04451b
Fix typo in ir-breaking-changes.rst 2021-10-22 10:00:26 +09:00
William Entriken
2278673936 Fix formatting 2021-10-20 18:12:34 +02:00
William Entriken
121f9c3b74 More strongly recommend to use the latest version 2021-10-19 13:44:58 +02:00
chriseth
7fba9ab245
Merge pull request #11923 from miohtama/patch-4
Clarify `block.*` and `tx.*` values in off-chain calls
2021-10-19 13:36:22 +02:00
Marenz
8dfb390c7e Enhance documentation in regards to modifiers and return 2021-10-18 14:22:09 +02:00
Mikko Ohtamaa
025bbbad82 Clarify block.* and tx.* values in off-chain calls
Looks like this may vary between different EVM implementations and confuses users.
2021-10-15 19:15:12 +02:00
Mariela Mantle
d684494389 feat(docs): get mismatched Yul optimizer step lists back in sync 2021-10-15 18:47:25 +02:00
Kamil Śliwak
d846410172 yul.rst: Clarify that linkersymbol() accepts but does not require a fully qualified library name 2021-10-14 20:57:15 +02:00
chriseth
d443fe415d
Merge pull request #12126 from MrBrain295/patch-1
Minor rewording of ` docs/examples/micropayment.rst `
2021-10-14 15:15:16 +02:00
MrBrain295
ac64ae56a1 Minor rewording. 2021-10-14 15:09:18 +02:00
Kamil Śliwak
6aa9633a02 docs: Add more bottom padding to the menu to prevent the index link from being obscured by the toggle 2021-10-14 14:15:29 +02:00
Kamil Śliwak
ed722700cd docs: Put the index menu item into a list prevent it from being styled as unfolded 2021-10-14 14:05:14 +02:00
Kamil Śliwak
ac8020d4a7 contributing.rst: Tweak details about the location of evmone and hera 2021-10-13 17:31:52 +02:00
Christian Parpart
5b926bee3f [docs] contributing.rst: Documents evmone.so loading search paths.
Co-authored-by: Kamil Śliwak <kamil.sliwak@codepoets.it>
2021-10-13 12:05:16 +02:00
Christian Parpart
b1dd0d0d02 Properly compute source mappings for immutables. 2021-10-12 17:56:17 +02:00
Kamil Śliwak
a9e794c872 Expose --debug-info/settings.debug.debugInfo option 2021-10-11 20:34:48 +02:00
chriseth
b986c2151a Add inline assembly section to cleanup. 2021-10-11 14:25:03 +02:00
Kamil Śliwak
d22cd235cf Rename share-solid.svg to avoid it being blocked by adblockers 2021-10-08 13:57:49 +02:00
Kamil Śliwak
f245f8b473 footer.html: Put credits link in a paragraph to add more spacing 2021-10-07 21:22:12 +02:00
Kamil Śliwak
6adfe88211 custom.css: Restore braces that disappeared in a rebase 2021-10-07 21:20:51 +02:00
Kamil Śliwak
b7942219df Include language and compiler version in Remix code links 2021-10-07 18:25:01 +02:00
Kamil Śliwak
416b13850f Sphinx extension for adding Remix links to code snippets 2021-10-07 18:25:00 +02:00
Kamil Śliwak
cd7db7faeb Add an arrow icon for Remix link, with proper attribution 2021-10-07 18:23:56 +02:00
4molybdenum2
551c3ae17a Adjust Colors for the Solidity Docs 2021-10-07 16:23:30 +02:00
Kamil Śliwak
0043eca672 Consistent indentation in doc config, templates and static files 2021-10-07 16:23:27 +02:00
Marenz
98dd78362e Add `.address and .selector` in inside assembly for external function pointers 2021-10-04 18:05:57 +02:00
sgmoore
ca232142be
Update value-types.rst - fix typo
Fix typo at line 69.
2021-10-02 20:32:25 -07:00
Leonardo
6d806359be
Merge pull request #11873 from soroosh-sdi/cmake-check-z3-latest
Require latest Z3 by default and allow relaxing the requirement with `STRICT_Z3_VERSION=OFF`
2021-10-01 12:58:03 +02:00
chriseth
1a7faef0db Set release date. 2021-09-29 14:00:57 +02:00
hrkrshnn
9d8a0a6f82 Buglist entry for UserDefinedValueTypesBug 2021-09-29 11:54:00 +02:00
chriseth
ffe6e7dcf4 Bug list entry about the signed immutables bug. 2021-09-29 10:12:05 +02:00
chriseth
4e28020ff5 Set release date. 2021-09-27 15:43:59 +02:00
chriseth
321e362789
Merge pull request #12024 from ethereum/require-boost-1.77-on-windows
Require Boost 1.77 on Windows
2021-09-27 15:41:21 +02:00
Kamil Śliwak
e3a3829f97 Increase minimum Boost version to 1.77 on Windows 2021-09-27 13:15:57 +02:00
Kamil Śliwak
f909555022 Treat ambiguous imports as errors 2021-09-27 13:14:23 +02:00
Kamil Śliwak
9975b5e26b Detect source unit name collisions between paths specified on the command line 2021-09-27 13:14:23 +02:00
Kamil Śliwak
c8a7a1da7c Add --include-path option 2021-09-27 13:14:23 +02:00
Kamil Śliwak
60b2f2b913 Documentation for --allow-paths and changelog entry for fixes 2021-09-27 13:14:10 +02:00
chriseth
d5c869f5d6
Merge pull request #12026 from CrimsonGlory/CrimsonGlory-patch-3
[docs] Add bitwise assignment operators
2021-09-27 12:26:00 +02:00
CrimsonGlory
e2bb3a3347
[docs] Add bitwise assignment operators
Add bitwise assignment operators to the list of operators involving LValues [skip ci]
2021-09-25 21:48:20 -03:00
soroosh-sdi
8b04ac38ab Require latest Z3 by default and allow relaxing the requirement with STRICT_Z3_VERSION=OFF
Signed-off-by: soroosh-sdi <soroosh.sardari@gmail.com>
2021-09-24 22:09:56 +03:30
Kamil Śliwak
caccd0a3e0 Always refer to the latest version of Boost in URLs 2021-09-24 15:35:33 +02:00
Alessandro Coglio
0ac441ac73 Clarify interpretation of literals.
This is based on discussions on Gitter.
2021-09-20 11:59:59 +02:00
chriseth
ccfc306942
Merge pull request #11937 from istareatscreens/patch-1
Reword External Function Calls paragraph in docs to improve clarity
2021-09-15 12:44:37 +02:00
istareatscreens
d1465dd0f7 Reword External Function Calls paragraph in docs
Reword External Function Calls opening paragraph to improve clarity
2021-09-14 17:51:18 -04:00
chriseth
8735d3fb6c
Merge pull request #11930 from ethereum/calldataStructInlineAssembly
Fix inline assembly assignments to calldata structs and statically-sized calldata arrays.
2021-09-14 16:16:48 +02:00
chriseth
25fc0db417
Merge pull request #11926 from nikitastupin/develop
[docs] Add sections for state mutability and special functions
2021-09-14 16:12:27 +02:00
Leo Alt
e72fa7fc10 Add new info severity 2021-09-13 22:48:22 +02:00
Daniel Kirchner
9ff0cc0b8b Update docs. 2021-09-13 15:22:46 +02:00
Nikita Stupin
aedf29b9dd Add sections for state mutability and special functions 2021-09-10 11:27:55 +03:00
hrkrshnn
952540c3b5 User defined value type: changes in documentation and test case
Changed the name of a function from `truncate` to `floor`, since that is more appropriate; updated
the inaccurate description on the rounding behaviour. Also modified the respective semantic test.
2021-09-09 16:57:03 +02:00
hrkrshnn
7e95555325 Updated ANTLR grammar to include user defined value types. 2021-09-08 21:19:30 +02:00
hrkrshnn
fbb1b884b2 Documentation and Changelog 2021-09-08 21:19:30 +02:00
Paul Razvan Berg
8d1331a081
docs: delete stale note about reading code 2021-09-04 22:40:36 +03:00
Marenz
2b28f87abf Add type().min/max for enums 2021-09-01 15:02:02 +02:00
chriseth
208ba61ee6
Merge pull request #11866 from ethereum/clarifyExample
Clarify function call options example.
2021-08-31 17:08:25 +02:00
Kamil Śliwak
d07b796675 Disallow modifier declarations and definitions in interfaces 2021-08-31 15:25:08 +02:00
chriseth
9033660b22 Clarify function call options example. 2021-08-31 14:32:32 +02:00
chriseth
f7916f2940 Add override exception for interface functions. 2021-08-31 10:45:31 +02:00
Kamil Śliwak
13f46ebb1e FileReader: Normalize base path and strip it from normalized source paths 2021-08-27 15:10:46 +02:00
Harikrishnan Mulackal
7df33f0d61
Merge pull request #11777 from Ahmed-Ali/improving_naming_consistency
[DOCS] Improving the naming consistency in Solidity by Example documentation
2021-08-26 12:38:35 +02:00
Ahmed Ali
e09b0ae15f Updated some examples following the naming convention
According to Solidity naming convention:
https://docs.soliditylang.org/en/latest/style-guide.html#naming-conventions There is no need to use
underscore except when there is a naming collision. In which case, a trailing underscore is used to
avoid the collision. So in this change, I am removing all underscores, except for the ones that
could shadow other symbols in their context (none of the changed names is a reserved keyword:
https://docs.soliditylang.org/en/latest/cheatsheet.html?highlight=reserved#reserved-keywords )
2021-08-26 11:59:10 +02:00
Leo Alt
563469ac33 Docs 2021-08-25 21:10:08 +02:00
Kamil Śliwak
a6683e3226 Fix pylint warnings about encoding not being specified in open() calls 2021-08-23 19:24:35 +02:00
chriseth
45a910c2ca
Merge pull request #11750 from ethereum/immutables-10463
Allow reading of immutables during construction time
2021-08-19 14:39:03 +02:00
Marenz
121fd40f74 Allow reading of immutables during construction time 2021-08-19 13:59:05 +02:00
Kamil Śliwak
f794539628 optimizer.rst: Fix a code block with incorrectly set Bash highlighting 2021-08-18 13:07:22 +02:00
CrimsonGlory
e42ebcd612 Document pre-0.5.0 bytesX/uintY conversions
Document pre-0.5.0 compiler behavior on bytesX/uintY conversions when they have different size.
2021-08-16 14:24:26 +02:00
John Adler
a029b0ba67
Fix typo
Fix missing `s`.
2021-08-14 14:31:06 -04:00
Sreekesh V
9b9e52e53e updated public to external for the functions
changed public to external for the functions
2021-08-12 16:24:40 +02:00
chriseth
7977c8c7ce Authorized Proxies 2021-08-12 15:39:32 +02:00
hrkrshnn
2c0c27c6d4 Set the release date and updated bugs_by_version.json 2021-08-11 12:13:07 +02:00
Daniel Kirchner
7b5595b0ad
Merge pull request #11775 from ethereum/docs-resources
[DOCS] Update resources.rst
2021-08-11 11:43:10 +02:00
franzihei
a2e73d7896 Update resources.rst 2021-08-11 10:59:02 +02:00
Leo Alt
8ce878621a Make show unproved CLI a flag 2021-08-11 10:54:03 +02:00
hrkrshnn
79733fca48 Set default EVM version to London. 2021-08-11 09:54:14 +02:00
hrkrshnn
cb9b52c242 Docs for block.basefee and basefee() in Yul. 2021-08-11 09:27:36 +02:00
hrkrshnn
95091f6b58 Implemented block.basefee in Solidilty and basefee() in Yul.
Also added basefee to Yul grammar.
2021-08-09 16:18:08 +02:00
Leo Alt
ee6285d6d7 Do not create VCs for underoverflow by default for Sol >=0.8 2021-08-09 14:12:31 +02:00
Leo Alt
e9e3f1238f Add solvers to model checker json docs 2021-08-06 18:05:25 +02:00
Leo Alt
08c065ee04 Add option divModWithSlacks 2021-08-06 15:50:25 +02:00
Leo Alt
847dd5cf92 Docs 2021-08-04 13:54:50 +02:00
chriseth
363278d2ec Clarify Yul scoping rules. 2021-08-02 18:27:34 +02:00
Kamil Śliwak
c6fc9934fa Clarify optional parts in remappings 2021-07-30 12:30:17 +02:00
Harikrishnan Mulackal
5ff0811b99
Merge pull request #11717 from jaa2/develop
Handle --optimize-runs option in assembly mode
2021-07-29 18:56:22 +02:00
jaa2
c627e6af10 CommandLineParser: Handle --optimize-runs option in assembly mode
Fixes #11708.
2021-07-29 18:15:57 +02:00
chriseth
62727f322a
Merge pull request #11662 from ethereum/docs-fix-highlighting-and-upgrade-pygments
[Docs] Fix highlighting and always use latest packages
2021-07-29 11:29:38 +02:00
Bhargava Shastry
3a0d654dce Document free memory pointer overflow check in Sol->Yul.
Co-authored-by: chriseth <chris@ethereum.org>
2021-07-28 15:00:25 +02:00
Alex Beregszaszi
c018cdf419
Merge pull request #11706 from ethereum/update-evmone-part2
Update evmone part 2
2021-07-27 17:17:59 +01:00
Leo Alt
6c8ecfa82c Add option to choose solver 2021-07-27 17:14:21 +02:00
hrkrshnn
8bec0c8a6b Updated docs and evmc.h header file for evmone 0.8.0 release 2021-07-27 16:39:41 +02:00
qedk
3ea2854e97
Update list of reserved keywords in cheatsheet
- `unchecked` (added)
+ `var` (removed)
+ `byte` (removed)
2021-07-26 23:48:33 +05:30
chriseth
8ea31cf4e1
Use caret 2021-07-26 14:17:22 +02:00
Harikrishnan Mulackal
8f6c6eec27
Merge pull request #11683 from GuLiPing-Hz/patch-1
[Docs] Add `unchecked` to fix reverting `BigInt` example in `libraries.rst`
2021-07-26 14:02:40 +02:00
Harikrishnan Mulackal
e35b39b6fe
Merge pull request #11684 from j05u3/patch-1
[documentation improvement proposal] tx.origin pointing where exactly is the bug
2021-07-26 13:43:04 +02:00
Harikrishnan Mulackal
f0d7ed98a5
Merge pull request #11675 from TransmissionsDev/patch-1
Remove incorrect statement that calldata must be used for external functions
2021-07-26 13:32:22 +02:00
GuLiPing-Hz
997c014971 Update libraries.rst
add unchecked
2021-07-26 13:24:04 +02:00
Josué
71d6e8da2d tx.origin pointing where exactly is the bug
Clarification for preventing more bugs of this kind that have been shown recently.
2021-07-26 13:04:14 +02:00
qedk
6e18c6e7cd
Remove keyword already in use from cheatsheet 2021-07-25 20:23:29 +05:30
Kamil Śliwak
6d6c9e6e4f
Merge pull request #11660 from ethereum/docs-fix-badly-indented-lists-and-blocks
[Docs] Fix badly indented lists and blocks
2021-07-21 18:35:19 +02:00
t11s
c2dfbbf78c
New note about which data locations are allowed in which function types
Co-authored-by: Kamil Śliwak <cameel2@gmail.com>
2021-07-18 15:02:16 -07:00
t11s
61f33c53a0
Remove trailing whitespace 2021-07-18 10:16:51 -07:00
t11s
bc36dbf3b8
Fix extra space 2021-07-18 10:11:18 -07:00
t11s
61e4c29cf8
Update note about calldata 2021-07-18 10:10:07 -07:00
t11s
bb040e40ed
Fix rst syntax 2021-07-17 12:46:58 -07:00
t11s
e7324f660d
Update line about calldata use for external funcs 2021-07-17 12:45:03 -07:00
t11s
616933cd5f
Remove incorrect statement that calldata must be used for external functions 2021-07-16 22:33:48 -07:00
Kamil Śliwak
8c5ae508f9 Use html_extra_template_renderer to replace the current robots.txt rendering script 2021-07-15 13:29:27 +02:00
Kamil Śliwak
2bebc2f822 Create a local html_extra_template_renderer Sphinx extension 2021-07-15 13:29:27 +02:00
Kamil Śliwak
d4a86b2b10 docs/conf.py: Remove unused /utils directory from python path 2021-07-15 13:14:39 +02:00
Kamil Śliwak
693b88e5f8 docs: Force highlighter to work despite errors on snippets that it cannot parse 2021-07-15 10:14:00 +02:00
Kamil Śliwak
d8260a1e93 docs: Replace > with >= in pragmas to work around the highligher being unable to process the former 2021-07-15 10:14:00 +02:00
Kamil Śliwak
310a35185a docs: Fix some mislabeled bash and text blocks 2021-07-15 10:14:00 +02:00
Kamil Śliwak
235a39eaef docs: Fix syntax errors in JSON snippets and enable JavaScript highlighting for them 2021-07-15 10:14:00 +02:00
Kamil Śliwak
f3a5c27852 docs: Replace a few remaining :: blocks with .. code-block:: 2021-07-15 10:14:00 +02:00
Kamil Śliwak
b513ca1f7e ir-breaking-changes.rst: Fix too short header frame 2021-07-15 10:13:32 +02:00
Kamil Śliwak
42f982c063 docs: Fix indentation in some of the code snippets 2021-07-15 10:13:32 +02:00
Kamil Śliwak
ce79e2515b docs: Fix badly indented lists 2021-07-15 10:13:30 +02:00
Kamil Śliwak
312ac4a255 docs: Remove deprecated escape characters from the list of available escapes 2021-07-14 21:28:20 +02:00
Kamil Śliwak
0aeb1ef47e Require sphinx-rtd-theme>= 0.5.2; older 2021-07-14 13:50:03 +02:00
CrimsonGlory
ab5898f11c
RHS->right hand side 2021-07-12 21:18:46 -03:00
chriseth
c3fa520c75
Merge pull request #11636 from ethereum/docs-clarify-struct-members-omitted-by-getters
[Docs] Clarify that non-byte array struct members are omitted by getters
2021-07-08 15:39:31 +02:00
chriseth
fec01c112a
Merge pull request #11616 from ethereum/issue-8191-yul
Test yul code blocks in documentation.
2021-07-08 15:37:01 +02:00
Marenz
d844d84b51 Test yul code blocks in documentation. 2021-07-08 14:59:05 +02:00
Kamil Śliwak
a1ca12a0a8 Clarify that non-byte array struct members are omitted by getters 2021-07-08 14:31:30 +02:00
chriseth
62934b60ca
Merge pull request #11605 from ethereum/issue-8191
isolate_tests: Extract code blocks from documentation using code block header
2021-07-08 14:28:47 +02:00
Kamil Śliwak
ddccd73a4b Fix outdated references to byte[] type (it's now bytes1[]) 2021-07-08 13:16:23 +02:00
Tony
510d74c1cd
Fix a Typo describing Layout in Storage 2021-07-07 19:29:44 -04:00
Simon Tian
f0ec3dd6a2
Update smtchecker.rst 2021-07-06 23:24:37 +08:00
Marenz
5291ca2dd4 isolate_tests: Extract code blocks from documentation using code block header 2021-07-06 16:57:05 +02:00
Bhargava Shastry
3e275335c7 Document difference in evaluation order of arguments of addmod/mulmod by old and new code gens. 2021-07-05 13:39:14 +02:00
Marenz
7f65f1cc02 Fix code-start headers in documentation 2021-07-01 15:17:42 +02:00
Alex Beregszaszi
37db29e9f1 Set preferred host in robots.txt 2021-06-28 21:26:00 +01:00
hrkrshnn
4c216395c6 [DOCS] Change code block into proper JSON
Reran `solc --storage-layout`, so the AST ids changed.
2021-06-28 17:27:33 +02:00
Amid Moeinzadeh
16fdfdc4eb Replace reference to `require by if`. 2021-06-28 15:45:07 +02:00
chriseth
2567eb46ba
Merge pull request #11477 from iskanderandrews/feature/docs-highlight-solc
[Docs]: Highlighting code snippets in .rst docs
2021-06-28 14:40:43 +02:00
iskanderandrews
a8e9d7a80d docs/
Enhancing all the .rst doc files by adding highlighting for the code snippets, including the following langs:
1. Solidity

2. bash

3. javascript

4. assembly
2021-06-25 12:33:55 +02:00
Kamil Śliwak
cd0ccd099b installing-solidity.rst: Clarify that when using urls in Standard JSON with a dockerized compiler it might still be necessary to mount a volume 2021-06-24 19:14:38 +02:00
chriseth
11564f7ec2
Merge pull request #11566 from ethereum/prepare086
Prepare release of 0.8.6.
2021-06-22 13:30:55 +02:00
chriseth
c502158c69 Prepare release of 0.8.6. 2021-06-22 11:39:15 +02:00
Kamil Śliwak
98c4830f2a docs/requirements.txt: Add minimum version for Sphinx 2021-06-21 20:54:35 +02:00
Kamil Śliwak
056e0d3751 docs: Suppress highlighting errors for snippets that cause errors in pygments-lexer-solidity 2021-06-21 20:54:35 +02:00
Kamil Śliwak
570ecf1cf1 Replace deprecated Sphinx mehods with newer equivalents 2021-06-21 20:54:31 +02:00
Kamil Śliwak
b7bbf6bd07 docs/contributing.rst: Don't use the default Solidity highlighting for shell and text snippets 2021-06-21 20:54:31 +02:00
chriseth
0df8a38e55 Support metadata via IR. 2021-06-21 18:20:31 +02:00