Commit Graph

117 Commits

Author SHA1 Message Date
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
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
Jim McDonald
6e521d59b0 Fix Solidity warnings 2017-12-12 18:47:30 +00:00
Alex Beregszaszi
134cc73e8e Enable struct abi example with experimental pragma 2017-12-01 16:20:23 +00:00
chriseth
88e1b68aaf More explanation about the packed encoding. 2017-11-22 12:29:16 +00:00
Alex Beregszaszi
23379e1061 Ensure each code snippet in the docs can be extracted for tests 2017-11-22 04:08:35 +00:00
walter-weinmann
fcf66721da abi-spec: example code doesn't fit grammar.txt. 2017-10-29 11:58:00 +01:00
Giovanni Casinelli
550653300b Update abi-spec.rst 2017-10-16 19:48:04 +08:00
Alex Beregszaszi
a7592fa801 Document packed ABI 2017-09-26 22:48:49 +01:00
Alex Beregszaszi
a061e8db34 Clarify shorthand notation in ABI 2017-09-19 11:02:14 +01:00
chriseth
32965807a7 Fix ABI spec regarding arrays. 2017-09-19 11:01:41 +01:00
Alex Beregszaszi
923373b41e Clarify ABI & Solidity types 2017-09-16 12:31:12 +01:00
chriseth
c5063d3155 Use "tuple" for struct types in ABI JSON.
Only use tuple as a type in the ABI (and remove all "anonymous struct" references too)
2017-09-16 12:31:12 +01:00
chriseth
e4bb767dcd Document structs in ABI 2017-09-16 12:12:44 +01:00
Alex Beregszaszi
e1f90f0ad6 Fix nested lists in the ABI documentation 2017-09-13 17:39:48 +01:00
Alex Beregszaszi
c70ebfd241 Document function selectors 2017-09-13 11:40:57 +01:00
Alex Beregszaszi
bdafce3e4f Convert ABI spec from Markdwon to RST 2017-09-05 14:50:27 +01:00
Alex Beregszaszi
dd2cc899bb Fix lists and links 2017-08-28 11:59:35 +01:00
Alex Beregszaszi
f791ca3957 Clarify ABI regarding constant 2017-08-25 12:37:23 +01:00
Alex Beregszaszi
deeac7e2e0 Rename statemutability to stateMutability in ABI/AST 2017-08-24 15:23:00 +01:00
Alex Beregszaszi
504e6285f3 Add pure to ABI spec 2017-08-24 13:46:18 +01:00
Alex Beregszaszi
b1cdf81506 Document view functions 2017-08-22 18:25:46 +01:00
Alex Beregszaszi
80ee7c2b36 Fix ABI for fixed types 2017-08-16 16:47:11 +01:00
Alex Beregszaszi
12f3257e7d Add statemutability field to the ABI 2017-08-15 11:35:50 +01:00
Alex Beregszaszi
cffe52d6d9 Enable more examples in the documentation for testing 2017-07-19 00:05:05 +01:00
Alex Beregszaszi
b2fcd59ee6 Add version pragma to docs examples 2017-07-13 17:10:37 +02:00
Yoichi Hirai
6307a12651
Borrow a sentence from @axic
and edit the phrase "following its type", which sounded like the data follows the type in the call data.
2017-07-12 14:37:12 +02:00
Yoichi Hirai
d5c3ef4605
Nitpicking abi-spec.rst 2017-07-12 13:27:47 +02:00
RJ Catalano
1d644bed31
try to get rid of warning
Signed-off-by: RJ Catalano <rj@monax.io>
2017-06-14 08:06:03 -05:00
chriseth
ca70d82b96 Include abi specs in index and fix styling. 2017-06-12 18:33:23 +02:00
chriseth
3170fd9a93 Formatting of heading. 2017-06-12 17:50:03 +02:00
chriseth
c66c5d4a21 Change fixed number example. 2017-06-12 17:49:11 +02:00
chriseth
a0777a7ffb Include structs. 2017-06-12 17:43:48 +02:00
RJ Catalano
3525280a72
some small fixes to the names and underlining; still need to fix the fixed point bytecode representation
Signed-off-by: RJ Catalano <rj@monax.io>
2017-06-09 14:49:59 -05:00
RJ Catalano
548ae18dfd
begin abi spec translation into solidity docs
Signed-off-by: RJ Catalano <rj@monax.io>
2017-06-09 13:58:55 -05:00