NEP: NeoContract ABI #12

erikzhang · 2017-09-13T11:18:50Z

An application binary interface (ABI) is the interface between two program modules, one of which is often a library and/or operating system and the other one is usually an application created by a regular programmer.

This NEP describes the ABI standards for NEO smart contracts.

revett · 2017-09-13T11:34:01Z

Really nice 👌

totalvm

Some minor spelling/grammar errors

totalvm · 2017-09-13T11:28:23Z

NeoContractABI.mediawiki

+
+==Abstract==
+
+An application binary interface (ABI) is the interface between two program modules, one of which is often a library and/or operating system and the other one is usually an application created by a regular programmer.


Application Binary Interface

totalvm · 2017-09-13T11:43:15Z

NeoContractABI.mediawiki

+
+<code>entrypoint</code> indicates that which is the entry point of the contract in <code>functions</code>.
+
+<code>functions</code> is an array of Function object which describes the details of each function in the contract.


Function objects which describe

totalvm · 2017-09-13T11:43:37Z

NeoContractABI.mediawiki

+
+<code>functions</code> is an array of Function object which describes the details of each function in the contract.
+
+<code>events</code> is an array of Event object which describes the details of each event in the contract.


Event objects which describe

totalvm · 2017-09-13T11:43:52Z

NeoContractABI.mediawiki

+<pre>
+{
+  "name": "transfer",
+  "paramaters": [],


totalvm · 2017-09-13T11:44:14Z

NeoContractABI.mediawiki

+<pre>
+{
+  "name": "refund",
+  "paramaters": []


totalvm · 2017-09-13T11:57:18Z

NeoContractABI.mediawiki

+}
+</pre>
+
+<code>name</code> is the name of the paramater, which can be any valid identifier.


totalvm · 2017-09-13T11:57:27Z

NeoContractABI.mediawiki

+
+<code>name</code> is the name of the paramater, which can be any valid identifier.
+
+<code>type</code> indicates the type of the paramater. It can be one of the following values: <code>Signature</code>, <code>Boolean</code>, <code>Integer</code>, <code>Hash160</code>, <code>Hash256</code>, <code>ByteArray</code>, <code>PublicKey</code>, <code>String</code>, <code>Array</code>, <code>InteropInterface</code>.


totalvm · 2017-09-13T11:57:39Z

NeoContractABI.mediawiki

+
+<code>type</code> indicates the type of the paramater. It can be one of the following values: <code>Signature</code>, <code>Boolean</code>, <code>Integer</code>, <code>Hash160</code>, <code>Hash256</code>, <code>ByteArray</code>, <code>PublicKey</code>, <code>String</code>, <code>Array</code>, <code>InteropInterface</code>.
+
+===ParamaterType===


ParameterType

totalvm · 2017-09-13T11:57:50Z

NeoContractABI.mediawiki

+
+===ParamaterType===
+
+ParamaterType enum has the following values:


ParameterType

totalvm · 2017-09-13T11:59:01Z

NeoContractABI.mediawiki

+!description
+|-
+| Signature
+| A signature of transaction or block which is generated by user.


A signature of a transaction or block which is generated by the user.

Sajjon

Maybe this sentence can be rephrased in a more easy to read manner?

Sajjon · 2017-09-13T13:14:03Z

NeoContractABI.mediawiki

+
+==Rationale==
+
+We assume the Application Binary Interface (ABI) is strongly typed, known at compilation time and static. No introspection mechanism will be provided. We assert that all contracts will have the interface definitions of any contracts they call available at compile-time.


How about changing:

We assert that all contracts will have the interface definitions of any contracts they call available at compile-time.

To:

At compile-time, we assert that all contracts will have the same interface definition. This is also true for any potential other contracts said contracts call.

Of course I meant "compile-time", I updated my comment...

Sajjon · 2017-09-13T13:17:27Z

NeoContractABI.mediawiki

+  Author: Erik Zhang <erik@neo.org>
+  Type: Standard
+  Status: Draft
+  Created: 2017-9-13


How about using YYYY-MM-DD format? :) Thus changing 2017-9-13 to 2017-09-13 if this date ever were to be parsed by some program?

totalvm

👍

neotracker · 2017-09-16T18:29:47Z

The spec should probably specify the structure of the entry point parameters for Smart Contracts that are compliant with the spec. Currently the spec describes a set of functions and their expected parameters, but it's not clear from the ABI how one would actually invoke the entry point for a given function. Should the function name be the first parameter? The last? Seems like it should be the first parameter, but it would be good to call that out explicitly.

notatestuser · 2017-09-17T10:05:18Z

nep-3.mediawiki

+| A string which is encoded in UTF-8.
+|-
+| Array
+| An array of objects.


Could you elaborate on what "objects" means here? It doesn't seem to refer to a standard type

igormcoelho · 2018-06-30T16:30:21Z

@erikzhang I have a question perhaps in the scope of NEP-3, I don't know if people are already actually using it for automated processes, but we are (at Eco platform: https://eco.neocompiler.io). One small thing is causing a big issue to us (@vncoelho), perhaps it's just a mistake in C# ICO_Template (I will propose a fix for it), or perhaps we need to put more emphasis on a point here at NEP-3. When we compile C# ICO_Template and generate the ABI, method names are automatically listed (following the same C# syntax), for example, "Deploy" ABI is generated for C# "Deploy()" method. I think the compiler and ABI is doing the right job, however, when I try to invoke the method "Deploy" (our platform does this automatically), it won't work, because the actual string operation is "deploy". So, the ABI becomes useless to us. In my opinion, in the scope of NEP-3 we should emphasize (no need to change the text it's perfect, just a public understanding), that:

Method names in ABI should match exactly the correspondent string operations in a smart contract

So, a proper fix would be to have the C# ICO_template having functions with the same capitalization as the op string names (which are already consistent to NEP-5 spec), just to allow the compiler to correctly and automatically generate the ABI. Do you agree?

RavenXce · 2018-07-01T02:10:32Z

Method names in ABI should match exactly the correspondent string operations in a smart contract

This is correct.

So, a proper fix would be to have the C# ICO_template having functions with the same capitalization as the op string names (which are already consistent to NEP-5 spec), just to allow the compiler to correctly and automatically generate the ABI. Do you agree?

But I think the C# compiler should be improved instead (to use code annotations / comments, or have smarter derivation of operation name through code analysis) instead of forcing functions to have same naming as operation string?

igormcoelho · 2018-07-01T10:55:07Z

It already allows some annotations, however, they also do not exist on ICO template... ok, I'll propose some changes (one or the other). I will see if that conflicts with event names as well.

erikzhang · 2018-07-02T05:32:09Z

Maybe we should make the compiler automatically turn the first letter of the method name into lowercase when generating the ABI?

igormcoelho · 2018-07-02T15:56:58Z

@erikzhang I thought about that haha I'm not a C# dev, but C++ and Java "standard" require methods to start lower case (and classes upper case). Isnt that the same for C#?

erikzhang · 2018-07-02T15:59:52Z

I thought about that haha I'm not a C# dev, but C++ and Java "standard" require methods to start lower case (and classes upper case). Isnt that the same for C#?

C# methods starts with upper case.

According to neo-project/proposals#12 display names for functions must match string abi calls.

igormcoelho · 2018-07-03T02:48:45Z

@RavenXce and @erikzhang, it seems the better option is to use DisplayName to adjust function names, so C# programmers can keep C# standard, while making everything 100% compatible with ABI signatures :)

draft

f4cbabe

totalvm suggested changes Sep 13, 2017

View reviewed changes

Sajjon reviewed Sep 13, 2017

View reviewed changes

fix spelling

f89269c

erikzhang added accepted NEP-Standard labels Sep 14, 2017

update status for accepting NEP-3

14438b7

totalvm approved these changes Sep 14, 2017

View reviewed changes

notatestuser reviewed Sep 17, 2017

View reviewed changes

Erik Zhang added 2 commits October 1, 2017 08:58

add recommended entry point

c5df0bd

Update nep-3.mediawiki

748db75

erikzhang removed the accepted label Nov 28, 2017

erikzhang added the accepted label Dec 20, 2017

Erik Zhang added 2 commits December 20, 2017 16:18

Merge branch 'master' into NeoContractABI

c7441ba

change state to final

f01bf49

erikzhang merged commit bc3a4aa into master Dec 20, 2017

erikzhang deleted the NeoContractABI branch December 20, 2017 08:23

igormcoelho added a commit to igormcoelho/examples-csharp that referenced this pull request Jul 2, 2018

lower case names for functions in ABI

3b19223

According to neo-project/proposals#12 display names for functions must match string abi calls.

igormcoelho mentioned this pull request Jul 3, 2018

Using DisplayName for function name compatibility with ABI neo-project/examples#25

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NEP: NeoContract ABI #12

NEP: NeoContract ABI #12

erikzhang commented Sep 13, 2017

revett commented Sep 13, 2017

totalvm left a comment

totalvm Sep 13, 2017

totalvm Sep 13, 2017

totalvm Sep 13, 2017

totalvm Sep 13, 2017

totalvm Sep 13, 2017

totalvm Sep 13, 2017

totalvm Sep 13, 2017

totalvm Sep 13, 2017

totalvm Sep 13, 2017

totalvm Sep 13, 2017

Sajjon left a comment

Sajjon Sep 13, 2017 •

edited

Loading

Sajjon Sep 13, 2017

Sajjon Sep 13, 2017

totalvm left a comment

neotracker commented Sep 16, 2017

notatestuser Sep 17, 2017 •

edited

Loading

igormcoelho commented Jun 30, 2018 •

edited

Loading

RavenXce commented Jul 1, 2018 •

edited

Loading

igormcoelho commented Jul 1, 2018 •

edited

Loading

erikzhang commented Jul 2, 2018

igormcoelho commented Jul 2, 2018 •

edited

Loading

erikzhang commented Jul 2, 2018

igormcoelho commented Jul 3, 2018


		==Abstract==

		An application binary interface (ABI) is the interface between two program modules, one of which is often a library and/or operating system and the other one is usually an application created by a regular programmer.


		<code>entrypoint</code> indicates that which is the entry point of the contract in <code>functions</code>.

		<code>functions</code> is an array of Function object which describes the details of each function in the contract.


		<code>functions</code> is an array of Function object which describes the details of each function in the contract.

		<code>events</code> is an array of Event object which describes the details of each event in the contract.


		<code>name</code> is the name of the paramater, which can be any valid identifier.

		<code>type</code> indicates the type of the paramater. It can be one of the following values: <code>Signature</code>, <code>Boolean</code>, <code>Integer</code>, <code>Hash160</code>, <code>Hash256</code>, <code>ByteArray</code>, <code>PublicKey</code>, <code>String</code>, <code>Array</code>, <code>InteropInterface</code>.


		<code>type</code> indicates the type of the paramater. It can be one of the following values: <code>Signature</code>, <code>Boolean</code>, <code>Integer</code>, <code>Hash160</code>, <code>Hash256</code>, <code>ByteArray</code>, <code>PublicKey</code>, <code>String</code>, <code>Array</code>, <code>InteropInterface</code>.

		===ParamaterType===


		===ParamaterType===

		ParamaterType enum has the following values:


		==Rationale==

		We assume the Application Binary Interface (ABI) is strongly typed, known at compilation time and static. No introspection mechanism will be provided. We assert that all contracts will have the interface definitions of any contracts they call available at compile-time.

NEP: NeoContract ABI #12

NEP: NeoContract ABI #12

Conversation

erikzhang commented Sep 13, 2017

revett commented Sep 13, 2017

totalvm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sajjon left a comment

Choose a reason for hiding this comment

Sajjon Sep 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

totalvm left a comment

Choose a reason for hiding this comment

neotracker commented Sep 16, 2017

notatestuser Sep 17, 2017 • edited Loading

Choose a reason for hiding this comment

igormcoelho commented Jun 30, 2018 • edited Loading

RavenXce commented Jul 1, 2018 • edited Loading

igormcoelho commented Jul 1, 2018 • edited Loading

erikzhang commented Jul 2, 2018

igormcoelho commented Jul 2, 2018 • edited Loading

erikzhang commented Jul 2, 2018

igormcoelho commented Jul 3, 2018

Sajjon Sep 13, 2017 •

edited

Loading

notatestuser Sep 17, 2017 •

edited

Loading

igormcoelho commented Jun 30, 2018 •

edited

Loading

RavenXce commented Jul 1, 2018 •

edited

Loading

igormcoelho commented Jul 1, 2018 •

edited

Loading

igormcoelho commented Jul 2, 2018 •

edited

Loading