Commit Graph

108 Commits

Author SHA1 Message Date
ethers
91f4ae12a9
remove SHA-3 as Keccak-256 is clearer
Reduce confusion as Keccak-256 is clear enough
2020-06-08 19:16:24 -07:00
chriseth
d33b67b3c2 Add license tags to documentation snippets. 2020-05-13 22:16:34 +02:00
chriseth
615668bfb4
Explain nonpayable
Fixes https://github.com/ethereum/solidity/issues/8736
2020-04-23 01:35:21 +02:00
Evan Saulpaugh
1a67b86f24
clarify description of padding for int<M> types 2020-04-10 02:23:13 -05:00
Evan Saulpaugh
1ef24562a9
change positive to non-negative 2020-04-10 02:17:57 -05:00
Erik Kundt
50c22f0800 Adds script which compiles docs example with minimum compiler version. 2020-03-18 19:27:38 +01:00
chriseth
7b950f8e9e Update ABI docs. 2019-12-13 14:49:09 +01:00
Daniel Kirchner
c33d233d88 Update docs. 2019-12-03 10:50:53 +01:00
Daniel Kirchner
3321fc56ea Split fallback function and introduce "fallback()" and "receive()" syntax. 2019-11-04 17:17:58 +01:00
Alexander Arlt
cd3ad73b5a Update tests. 2019-11-01 14:54:47 -05:00
chriseth
f884373142 Merge branch 'origin/develop' into develop_060 2019-10-02 16:29:36 +02:00
Micah Zoltu
ae84782d0e
Removes the optionality on output in ABI docs.
I _believe_ (someone more knowledgable than I should verify this claim) that Solidity will always write out an `output` member.  If there are no return parameters, then the array will be empty, but the `output` property will be present.

If this is not correct, I will withdraw this PR, but if the assertion is correct then the docs should reflect that so people can rely on the `output` property being present when writing ABI processors.

I also fixed some inconsistency in line termination character.  It was sometimes `.` and sometimes `;`.  I picked `.`, but don't really care which as long as it is consistent.
2019-09-23 16:42:34 +08:00
Daniel Kirchner
793b1890e8 `type field in ABI JSON no longer defaults to function` 2019-09-06 15:35:01 +02:00
Daniel Kirchner
f4d990e5be Drop constant and payable fields from ABI. 2019-09-06 14:42:09 +02:00
Mathias Baumann
7234e59e07 ABI documentation clarifications 2019-08-07 15:53:53 +02:00
Chris Ward
5305dd6eac Confirm to style guide 2019-05-23 14:46:59 +02:00
chriseth
8d401ba936 Update pragmas. 2019-03-05 18:10:09 +01:00
chriseth
4eb48dd6b7 Specify packed encoding and add warning. 2019-02-05 16:49:24 +01:00
Evan Saulpaugh
bda0bc8f08
improve packed encoding test vector
packed byte length of ints now unambiguously shown to be type-dependent, not value dependent e.g. uint16(0x03) is 0x0003 not 0x03
2019-01-18 02:30:15 -06:00
Chris Ward
cefc6c433e Update non-existant pragma 0.4.99 to 0.5.0
Use correct syntax for pragma

Change pragma syntax

One more change to pragma syntax
2019-01-07 14:20:10 +01:00
chriseth
96d220163d
Merge pull request #5731 from poiresel/docs_spelling_fixes
resolve spelling issues in the docs folder
2019-01-07 12:26:50 +01:00
poiresel
bf93665ad8 resolve spelling issues in the docs folder 2018-12-21 10:49:11 -05:00
chriseth
ac6f80b4e9 [DOC] More details about packed encoding. 2018-12-20 14:49:52 +01:00
chriseth
3d1ca07e9b
Merge pull request #3047 from ethereum/abi-strict
Add strict encoding mode to the ABI spec
2018-10-17 19:14:00 +02:00
Chris Ward
973d91ec89 Update docs on event data and logs
Updates from comments

Clarify code comments and add an event output example

Clarification from review

Updated with information from @gumb0

Add clarifier

Updates from review

Remove link

Update example code
2018-10-05 11:25:48 +02:00
chriseth
1305bf34f0
Merge pull request #5073 from IIIIllllIIIIllllIIIIllllIIIIllllIIIIll/patch-4
separate out a new "Design Criteria" section from "Formal Specification"
2018-10-04 13:02:33 +02:00
Li Xuanji
26d36e1faa separate out a new "Design Criteria" section from "Formal Specification" 2018-10-04 13:00:33 +02:00
Alex Beregszaszi
608f36d77b
Merge pull request #5082 from ethereum/abiUpdate
[DOCS] Update abi.
2018-09-25 20:31:17 +01:00
Alex Beregszaszi
e3e9ce53d7 Set 0.5.x specific example code to be compilable with >0.4.99 <0.6.0 (e.g. 0.5.x only) 2018-09-25 19:04:34 +01:00
Alex Beregszaszi
3ca00c73f9 Update version pragma in all documentation examples 2018-09-25 19:03:25 +01:00
chriseth
e470408cf4 [DOCS] Update abi. 2018-09-25 19:01:02 +02:00
Leonardo Alt
e785fe0c07 Add struct->tuple to the Solidity->ABI types table 2018-09-20 15:08:52 +02:00
Leonardo Alt
1770e9c02f Explaining how Solidity types map to ABI types 2018-09-19 14:28:45 +02:00
chriseth
62d6ec9b04
Merge pull request #4792 from ethereum/someABIDocFixes
Some style fixes to the ABI documentation.
2018-08-14 16:44:13 +02:00
chriseth
6cf299bec6 Update documentation examples. 2018-08-14 15:50:46 +02:00
Daniel Kirchner
7d7abeb149 Disallow ambiguous conversions between number literals and bytesXX types. 2018-08-13 14:27:01 +02:00
chriseth
8509769927 Some style fixes to the ABI documentation. 2018-08-09 20:21:19 +02:00
chriseth
0197d05cf2 Use code-block when using a different language. 2018-08-09 20:04:47 +02:00
chriseth
f01689ac77
Clarify packed encoding. 2018-08-08 21:47:40 +02:00
Dylan Wilson
d6d1a41286
Update doc referencing packed mode encoding for dynamic typed topic args 2018-07-25 15:28:53 -07:00
Alex Beregszaszi
61a8b098e6 Mention that constant and payable are deprecated in the ABI spec 2018-07-25 11:23:44 +01:00
Alex Beregszaszi
76bc04244a Clarify relation between stateMutability and payable/constant 2018-07-25 11:23:41 +01:00
Chase McDermott
3267adcd14 Added default data locations to docs and other external tests. 2018-07-14 16:42:43 -05:00
Cryptomental
eb92d5f760 docs: Fix typos.
Used codespell and manual fixes.

Refs: #4442
2018-07-10 22:57:59 +02:00
Alex Beregszaszi
5c404fcfac
Merge pull request #4460 from ethereum/docs-contract-abi
Rename ABI to Contract ABI
2018-07-10 11:04:10 +01:00
Alex Beregszaszi
314fefbc05 Rename ABI to Contract ABI
It has been called as the "Contract ABI" on the original wiki page too and it seems to make more sense.
2018-07-09 23:48:44 +01:00
Alex Beregszaszi
8dc7609257
Merge pull request #4395 from xinbenlv/patch-1
Indicating abbr.
2018-07-09 13:28:27 +02:00
xinbenlv
1e7d44d31c Indicate what the abbreviation ABI stands for in the ABI documentation 2018-07-09 12:24:54 +01:00
Alex Beregszaszi
127eaab312 Add strict encoding mode to the ABI spec 2018-07-05 18:22:37 +02:00
Erik Kundt
2031e8e0c1 Adds review suggestions. 2018-07-02 16:46:54 +02:00