Commit Graph

83 Commits

Author SHA1 Message Date
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
Erik Kundt
2031e8e0c1 Adds review suggestions. 2018-07-02 16:46:54 +02:00
Erik Kundt
e16e37f507 Updates docs to new constructor syntax. 2018-07-02 16:25:54 +02:00
chriseth
4a842ecc82
Merge pull request #4097 from ethereum/noPackedExceptForPacked
[BREAKING] call only takes a single argument and does not pad
2018-06-27 18:29:01 +02:00
chriseth
b55d9aacff Add emit keyword to documentation. 2018-06-27 10:38:59 +02:00
chriseth
17493e64ed Documentation. 2018-06-25 17:17:18 +02:00
chriseth
3e9b4383cc
Merge pull request #4200 from biboran/3961
#3961 - added an example of two-dimensional array encoding
2018-06-21 14:09:53 +02:00
Timofey Solonin
6553b1114b #3961 - added a more detailed description to the calculation of offsets 2018-06-17 21:20:11 +03:00
feliam
765241a154
Update abi-spec.rst
An infinite number of items in the sequence of types? ??
A negative number of type in the sequence ??
2018-06-06 18:40:26 -03:00
Timofey Solonin
0d25ba1649 #3961 - rewritten encoding example in a logical order instead of a sequential order 2018-06-02 19:04:37 +03:00
Timofey Solonin
32443f5705 #3961 - added an example of abi encoding of a function with two-dimensional dynamic arrays 2018-05-29 13:18:23 +03:00
chriseth
29572bdc48 Clarify components of X 2018-05-04 15:44:45 +02:00
nisdas
7db4166f77 Fixed typos in abi-spec documentation 2018-05-04 15:41:23 +02:00
David Sanders
d72624ecb9
Make index notation more consistent 2018-04-24 18:17:44 -06:00
David Sanders
287ec8addb
Add note about zero-tuples 2018-04-24 17:55:39 -06:00
Jason Cobb
e37b619593 Set default fixed point decimal places to 18 2018-03-31 00:56:36 +01:00
Grzegorz Hasse
7ebd580954 Fix a typo. 2018-03-07 21:27:24 -08:00
Elena Dimitrova
c9840c98f4 Documentation updates for internal constructors and function signature (#3365)
* Add a note explaining return values not included in function signature

* Add section on Constructors in documentation

* Improve documented definition for abstract contract

* Add benefits of abstraction to documentation
2018-03-01 16:59:47 +01:00
chriseth
2ada9683dd
Use the term "trailing zero-bytes". 2018-02-22 15:24:14 +01:00
chriseth
29d40ad42a
Clarify padding direction. 2018-02-20 12:19:19 +01:00
William Entriken
360009c376
Typo 2018-02-19 15:38:55 -05:00
William Entriken
1cc31bacef
Remove useless self assignment 2018-01-28 17:41:09 -05:00
William Entriken
053e634276
Add mutability declaration to example, for #3379 2018-01-23 21:52:58 -05:00
chriseth
b24de1c29c
Some more clarifications. 2018-01-23 17:53:13 +01:00
Li Xuanji
d555c82db4
clarify address in function selector
I found that the canonical form for `address` in computing the function selector calldata tag is `uint160`. Update the abi specs to explicitly mention this.
2018-01-22 17:34:58 -05:00
Steve Waldman
75dd416c6e [Docs] Note that events can contain both indexed and unindexed arguments for values of dynamic-length types. 2017-12-19 03:09:13 -08:00
Steve Waldman
bae913368a [Docs] Include explanation of how indexed dynamic-length event args are encoded 2017-12-19 01:51:57 -08:00