Add ERC specs, licenses
This commit is contained in:
parent
689ad18025
commit
0a8ec989ef
674
LICENSE
Normal file
674
LICENSE
Normal file
@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
121
LICENSE.CC0
Normal file
121
LICENSE.CC0
Normal file
@ -0,0 +1,121 @@
|
|||||||
|
Creative Commons Legal Code
|
||||||
|
|
||||||
|
CC0 1.0 Universal
|
||||||
|
|
||||||
|
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
|
||||||
|
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
|
||||||
|
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
|
||||||
|
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
|
||||||
|
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
|
||||||
|
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
|
||||||
|
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
|
||||||
|
HEREUNDER.
|
||||||
|
|
||||||
|
Statement of Purpose
|
||||||
|
|
||||||
|
The laws of most jurisdictions throughout the world automatically confer
|
||||||
|
exclusive Copyright and Related Rights (defined below) upon the creator
|
||||||
|
and subsequent owner(s) (each and all, an "owner") of an original work of
|
||||||
|
authorship and/or a database (each, a "Work").
|
||||||
|
|
||||||
|
Certain owners wish to permanently relinquish those rights to a Work for
|
||||||
|
the purpose of contributing to a commons of creative, cultural and
|
||||||
|
scientific works ("Commons") that the public can reliably and without fear
|
||||||
|
of later claims of infringement build upon, modify, incorporate in other
|
||||||
|
works, reuse and redistribute as freely as possible in any form whatsoever
|
||||||
|
and for any purposes, including without limitation commercial purposes.
|
||||||
|
These owners may contribute to the Commons to promote the ideal of a free
|
||||||
|
culture and the further production of creative, cultural and scientific
|
||||||
|
works, or to gain reputation or greater distribution for their Work in
|
||||||
|
part through the use and efforts of others.
|
||||||
|
|
||||||
|
For these and/or other purposes and motivations, and without any
|
||||||
|
expectation of additional consideration or compensation, the person
|
||||||
|
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
|
||||||
|
is an owner of Copyright and Related Rights in the Work, voluntarily
|
||||||
|
elects to apply CC0 to the Work and publicly distribute the Work under its
|
||||||
|
terms, with knowledge of his or her Copyright and Related Rights in the
|
||||||
|
Work and the meaning and intended legal effect of CC0 on those rights.
|
||||||
|
|
||||||
|
1. Copyright and Related Rights. A Work made available under CC0 may be
|
||||||
|
protected by copyright and related or neighboring rights ("Copyright and
|
||||||
|
Related Rights"). Copyright and Related Rights include, but are not
|
||||||
|
limited to, the following:
|
||||||
|
|
||||||
|
i. the right to reproduce, adapt, distribute, perform, display,
|
||||||
|
communicate, and translate a Work;
|
||||||
|
ii. moral rights retained by the original author(s) and/or performer(s);
|
||||||
|
iii. publicity and privacy rights pertaining to a person's image or
|
||||||
|
likeness depicted in a Work;
|
||||||
|
iv. rights protecting against unfair competition in regards to a Work,
|
||||||
|
subject to the limitations in paragraph 4(a), below;
|
||||||
|
v. rights protecting the extraction, dissemination, use and reuse of data
|
||||||
|
in a Work;
|
||||||
|
vi. database rights (such as those arising under Directive 96/9/EC of the
|
||||||
|
European Parliament and of the Council of 11 March 1996 on the legal
|
||||||
|
protection of databases, and under any national implementation
|
||||||
|
thereof, including any amended or successor version of such
|
||||||
|
directive); and
|
||||||
|
vii. other similar, equivalent or corresponding rights throughout the
|
||||||
|
world based on applicable law or treaty, and any national
|
||||||
|
implementations thereof.
|
||||||
|
|
||||||
|
2. Waiver. To the greatest extent permitted by, but not in contravention
|
||||||
|
of, applicable law, Affirmer hereby overtly, fully, permanently,
|
||||||
|
irrevocably and unconditionally waives, abandons, and surrenders all of
|
||||||
|
Affirmer's Copyright and Related Rights and associated claims and causes
|
||||||
|
of action, whether now known or unknown (including existing as well as
|
||||||
|
future claims and causes of action), in the Work (i) in all territories
|
||||||
|
worldwide, (ii) for the maximum duration provided by applicable law or
|
||||||
|
treaty (including future time extensions), (iii) in any current or future
|
||||||
|
medium and for any number of copies, and (iv) for any purpose whatsoever,
|
||||||
|
including without limitation commercial, advertising or promotional
|
||||||
|
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
|
||||||
|
member of the public at large and to the detriment of Affirmer's heirs and
|
||||||
|
successors, fully intending that such Waiver shall not be subject to
|
||||||
|
revocation, rescission, cancellation, termination, or any other legal or
|
||||||
|
equitable action to disrupt the quiet enjoyment of the Work by the public
|
||||||
|
as contemplated by Affirmer's express Statement of Purpose.
|
||||||
|
|
||||||
|
3. Public License Fallback. Should any part of the Waiver for any reason
|
||||||
|
be judged legally invalid or ineffective under applicable law, then the
|
||||||
|
Waiver shall be preserved to the maximum extent permitted taking into
|
||||||
|
account Affirmer's express Statement of Purpose. In addition, to the
|
||||||
|
extent the Waiver is so judged Affirmer hereby grants to each affected
|
||||||
|
person a royalty-free, non transferable, non sublicensable, non exclusive,
|
||||||
|
irrevocable and unconditional license to exercise Affirmer's Copyright and
|
||||||
|
Related Rights in the Work (i) in all territories worldwide, (ii) for the
|
||||||
|
maximum duration provided by applicable law or treaty (including future
|
||||||
|
time extensions), (iii) in any current or future medium and for any number
|
||||||
|
of copies, and (iv) for any purpose whatsoever, including without
|
||||||
|
limitation commercial, advertising or promotional purposes (the
|
||||||
|
"License"). The License shall be deemed effective as of the date CC0 was
|
||||||
|
applied by Affirmer to the Work. Should any part of the License for any
|
||||||
|
reason be judged legally invalid or ineffective under applicable law, such
|
||||||
|
partial invalidity or ineffectiveness shall not invalidate the remainder
|
||||||
|
of the License, and in such case Affirmer hereby affirms that he or she
|
||||||
|
will not (i) exercise any of his or her remaining Copyright and Related
|
||||||
|
Rights in the Work or (ii) assert any associated claims and causes of
|
||||||
|
action with respect to the Work, in either case contrary to Affirmer's
|
||||||
|
express Statement of Purpose.
|
||||||
|
|
||||||
|
4. Limitations and Disclaimers.
|
||||||
|
|
||||||
|
a. No trademark or patent rights held by Affirmer are waived, abandoned,
|
||||||
|
surrendered, licensed or otherwise affected by this document.
|
||||||
|
b. Affirmer offers the Work as-is and makes no representations or
|
||||||
|
warranties of any kind concerning the Work, express, implied,
|
||||||
|
statutory or otherwise, including without limitation warranties of
|
||||||
|
title, merchantability, fitness for a particular purpose, non
|
||||||
|
infringement, or the absence of latent or other defects, accuracy, or
|
||||||
|
the present or absence of errors, whether or not discoverable, all to
|
||||||
|
the greatest extent permissible under applicable law.
|
||||||
|
c. Affirmer disclaims responsibility for clearing rights of other persons
|
||||||
|
that may apply to the Work or any use thereof, including without
|
||||||
|
limitation any person's Copyright and Related Rights in the Work.
|
||||||
|
Further, Affirmer disclaims responsibility for obtaining any necessary
|
||||||
|
consents, permissions or other rights required for any use of the
|
||||||
|
Work.
|
||||||
|
d. Affirmer understands and acknowledges that Creative Commons is not a
|
||||||
|
party to this document and has no duty or obligation with respect to
|
||||||
|
this CC0 or use of the Work.
|
235
spec/eip-165.md
Normal file
235
spec/eip-165.md
Normal file
@ -0,0 +1,235 @@
|
|||||||
|
---
|
||||||
|
eip: 165
|
||||||
|
title: Standard Interface Detection
|
||||||
|
author: Christian Reitwießner <chris@ethereum.org>, Nick Johnson <nick@ethereum.org>, Fabian Vogelsteller <fabian@lukso.network>, Jordi Baylina <jordi@baylina.cat>, Konrad Feldmeier <konrad.feldmeier@brainbot.com>, William Entriken <github.com@phor.net>
|
||||||
|
type: Standards Track
|
||||||
|
category: ERC
|
||||||
|
status: Final
|
||||||
|
created: 2018-01-23
|
||||||
|
requires: 214
|
||||||
|
---
|
||||||
|
|
||||||
|
## Simple Summary
|
||||||
|
|
||||||
|
Creates a standard method to publish and detect what interfaces a smart contract implements.
|
||||||
|
|
||||||
|
## Abstract
|
||||||
|
|
||||||
|
Herein, we standardize the following:
|
||||||
|
|
||||||
|
1. How interfaces are identified
|
||||||
|
2. How a contract will publish the interfaces it implements
|
||||||
|
3. How to detect if a contract implements ERC-165
|
||||||
|
4. How to detect if a contract implements any given interface
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
For some "standard interfaces" like [the ERC-20 token interface](./eip-20.md), it is sometimes useful to query whether a contract supports the interface and if yes, which version of the interface, in order to adapt the way in which the contract is to be interacted with. Specifically for ERC-20, a version identifier has already been proposed. This proposal standardizes the concept of interfaces and standardizes the identification (naming) of interfaces.
|
||||||
|
|
||||||
|
## Specification
|
||||||
|
|
||||||
|
### How Interfaces are Identified
|
||||||
|
|
||||||
|
For this standard, an *interface* is a set of [function selectors as defined by the Ethereum ABI](https://solidity.readthedocs.io/en/develop/abi-spec.html#function-selector). This a subset of [Solidity's concept of interfaces](https://solidity.readthedocs.io/en/develop/abi-spec.html) and the `interface` keyword definition which also defines return types, mutability and events.
|
||||||
|
|
||||||
|
We define the interface identifier as the XOR of all function selectors in the interface. This code example shows how to calculate an interface identifier:
|
||||||
|
|
||||||
|
```solidity
|
||||||
|
pragma solidity ^0.4.20;
|
||||||
|
|
||||||
|
interface Solidity101 {
|
||||||
|
function hello() external pure;
|
||||||
|
function world(int) external pure;
|
||||||
|
}
|
||||||
|
|
||||||
|
contract Selector {
|
||||||
|
function calculateSelector() public pure returns (bytes4) {
|
||||||
|
Solidity101 i;
|
||||||
|
return i.hello.selector ^ i.world.selector;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: interfaces do not permit optional functions, therefore, the interface identity will not include them.
|
||||||
|
|
||||||
|
### How a Contract will Publish the Interfaces it Implements
|
||||||
|
|
||||||
|
A contract that is compliant with ERC-165 shall implement the following interface (referred as `ERC165.sol`):
|
||||||
|
|
||||||
|
```solidity
|
||||||
|
pragma solidity ^0.4.20;
|
||||||
|
|
||||||
|
interface ERC165 {
|
||||||
|
/// @notice Query if a contract implements an interface
|
||||||
|
/// @param interfaceID The interface identifier, as specified in ERC-165
|
||||||
|
/// @dev Interface identification is specified in ERC-165. This function
|
||||||
|
/// uses less than 30,000 gas.
|
||||||
|
/// @return `true` if the contract implements `interfaceID` and
|
||||||
|
/// `interfaceID` is not 0xffffffff, `false` otherwise
|
||||||
|
function supportsInterface(bytes4 interfaceID) external view returns (bool);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The interface identifier for this interface is `0x01ffc9a7`. You can calculate this by running `bytes4(keccak256('supportsInterface(bytes4)'));` or using the `Selector` contract above.
|
||||||
|
|
||||||
|
Therefore the implementing contract will have a `supportsInterface` function that returns:
|
||||||
|
|
||||||
|
- `true` when `interfaceID` is `0x01ffc9a7` (EIP165 interface)
|
||||||
|
- `false` when `interfaceID` is `0xffffffff`
|
||||||
|
- `true` for any other `interfaceID` this contract implements
|
||||||
|
- `false` for any other `interfaceID`
|
||||||
|
|
||||||
|
This function must return a bool and use at most 30,000 gas.
|
||||||
|
|
||||||
|
Implementation note, there are several logical ways to implement this function. Please see the example implementations and the discussion on gas usage.
|
||||||
|
|
||||||
|
### How to Detect if a Contract Implements ERC-165
|
||||||
|
|
||||||
|
1. The source contract makes a `STATICCALL` to the destination address with input data: `0x01ffc9a701ffc9a700000000000000000000000000000000000000000000000000000000` and gas 30,000. This corresponds to `contract.supportsInterface(0x01ffc9a7)`.
|
||||||
|
2. If the call fails or return false, the destination contract does not implement ERC-165.
|
||||||
|
3. If the call returns true, a second call is made with input data `0x01ffc9a7ffffffff00000000000000000000000000000000000000000000000000000000`.
|
||||||
|
4. If the second call fails or returns true, the destination contract does not implement ERC-165.
|
||||||
|
5. Otherwise it implements ERC-165.
|
||||||
|
|
||||||
|
### How to Detect if a Contract Implements any Given Interface
|
||||||
|
|
||||||
|
1. If you are not sure if the contract implements ERC-165, use the above procedure to confirm.
|
||||||
|
2. If it does not implement ERC-165, then you will have to see what methods it uses the old-fashioned way.
|
||||||
|
3. If it implements ERC-165 then just call `supportsInterface(interfaceID)` to determine if it implements an interface you can use.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
We tried to keep this specification as simple as possible. This implementation is also compatible with the current Solidity version.
|
||||||
|
|
||||||
|
## Backwards Compatibility
|
||||||
|
|
||||||
|
The mechanism described above (with `0xffffffff`) should work with most of the contracts previous to this standard to determine that they do not implement ERC-165.
|
||||||
|
|
||||||
|
Also [the ENS](./eip-137.md) already implements this EIP.
|
||||||
|
|
||||||
|
## Test Cases
|
||||||
|
|
||||||
|
Following is a contract that detects which interfaces other contracts implement. From @fulldecent and @jbaylina.
|
||||||
|
|
||||||
|
```solidity
|
||||||
|
pragma solidity ^0.4.20;
|
||||||
|
|
||||||
|
contract ERC165Query {
|
||||||
|
bytes4 constant InvalidID = 0xffffffff;
|
||||||
|
bytes4 constant ERC165ID = 0x01ffc9a7;
|
||||||
|
|
||||||
|
function doesContractImplementInterface(address _contract, bytes4 _interfaceId) external view returns (bool) {
|
||||||
|
uint256 success;
|
||||||
|
uint256 result;
|
||||||
|
|
||||||
|
(success, result) = noThrowCall(_contract, ERC165ID);
|
||||||
|
if ((success==0)||(result==0)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
(success, result) = noThrowCall(_contract, InvalidID);
|
||||||
|
if ((success==0)||(result!=0)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
(success, result) = noThrowCall(_contract, _interfaceId);
|
||||||
|
if ((success==1)&&(result==1)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
function noThrowCall(address _contract, bytes4 _interfaceId) constant internal returns (uint256 success, uint256 result) {
|
||||||
|
bytes4 erc165ID = ERC165ID;
|
||||||
|
|
||||||
|
assembly {
|
||||||
|
let x := mload(0x40) // Find empty storage location using "free memory pointer"
|
||||||
|
mstore(x, erc165ID) // Place signature at beginning of empty storage
|
||||||
|
mstore(add(x, 0x04), _interfaceId) // Place first argument directly next to signature
|
||||||
|
|
||||||
|
success := staticcall(
|
||||||
|
30000, // 30k gas
|
||||||
|
_contract, // To addr
|
||||||
|
x, // Inputs are stored at location x
|
||||||
|
0x24, // Inputs are 36 bytes long
|
||||||
|
x, // Store output over input (saves space)
|
||||||
|
0x20) // Outputs are 32 bytes long
|
||||||
|
|
||||||
|
result := mload(x) // Load the result
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Implementation
|
||||||
|
|
||||||
|
This approach uses a `view` function implementation of `supportsInterface`. The execution cost is 586 gas for any input. But contract initialization requires storing each interface (`SSTORE` is 20,000 gas). The `ERC165MappingImplementation` contract is generic and reusable.
|
||||||
|
|
||||||
|
```solidity
|
||||||
|
pragma solidity ^0.4.20;
|
||||||
|
|
||||||
|
import "./ERC165.sol";
|
||||||
|
|
||||||
|
contract ERC165MappingImplementation is ERC165 {
|
||||||
|
/// @dev You must not set element 0xffffffff to true
|
||||||
|
mapping(bytes4 => bool) internal supportedInterfaces;
|
||||||
|
|
||||||
|
function ERC165MappingImplementation() internal {
|
||||||
|
supportedInterfaces[this.supportsInterface.selector] = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
function supportsInterface(bytes4 interfaceID) external view returns (bool) {
|
||||||
|
return supportedInterfaces[interfaceID];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Simpson {
|
||||||
|
function is2D() external returns (bool);
|
||||||
|
function skinColor() external returns (string);
|
||||||
|
}
|
||||||
|
|
||||||
|
contract Lisa is ERC165MappingImplementation, Simpson {
|
||||||
|
function Lisa() public {
|
||||||
|
supportedInterfaces[this.is2D.selector ^ this.skinColor.selector] = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
function is2D() external returns (bool){}
|
||||||
|
function skinColor() external returns (string){}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Following is a `pure` function implementation of `supportsInterface`. The worst-case execution cost is 236 gas, but increases linearly with a higher number of supported interfaces.
|
||||||
|
|
||||||
|
```solidity
|
||||||
|
pragma solidity ^0.4.20;
|
||||||
|
|
||||||
|
import "./ERC165.sol";
|
||||||
|
|
||||||
|
interface Simpson {
|
||||||
|
function is2D() external returns (bool);
|
||||||
|
function skinColor() external returns (string);
|
||||||
|
}
|
||||||
|
|
||||||
|
contract Homer is ERC165, Simpson {
|
||||||
|
function supportsInterface(bytes4 interfaceID) external view returns (bool) {
|
||||||
|
return
|
||||||
|
interfaceID == this.supportsInterface.selector || // ERC165
|
||||||
|
interfaceID == this.is2D.selector
|
||||||
|
^ this.skinColor.selector; // Simpson
|
||||||
|
}
|
||||||
|
|
||||||
|
function is2D() external returns (bool){}
|
||||||
|
function skinColor() external returns (string){}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
With three or more supported interfaces (including ERC165 itself as a required supported interface), the mapping approach (in every case) costs less gas than the pure approach (at worst case).
|
||||||
|
|
||||||
|
## Version history
|
||||||
|
* PR 1640, finalized 2019-01-23 -- This corrects the noThrowCall test case to use 36 bytes rather than the previous 32 bytes. The previous code was an error that still silently worked in Solidity 0.4.x but which was broken by new behavior introduced in Solidity 0.5.0. This change was discussed at [#1640](https://github.com/ethereum/EIPs/pull/1640).
|
||||||
|
|
||||||
|
* EIP 165, finalized 2018-04-20 -- Original published version.
|
||||||
|
|
||||||
|
## Copyright
|
||||||
|
|
||||||
|
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
|
109
spec/eip-173.md
Normal file
109
spec/eip-173.md
Normal file
@ -0,0 +1,109 @@
|
|||||||
|
---
|
||||||
|
eip: 173
|
||||||
|
title: Contract Ownership Standard
|
||||||
|
author: Nick Mudge <nick@perfectabstractions.com>, Dan Finlay <dan@danfinlay.com>
|
||||||
|
discussions-to: https://github.com/ethereum/EIPs/issues/173
|
||||||
|
type: Standards Track
|
||||||
|
category: ERC
|
||||||
|
status: Last Call
|
||||||
|
review-period-end: 2020-09-06
|
||||||
|
created: 2018-06-07
|
||||||
|
---
|
||||||
|
|
||||||
|
## Simple Summary
|
||||||
|
|
||||||
|
A standard interface for ownership of contracts.
|
||||||
|
|
||||||
|
## Abstract
|
||||||
|
|
||||||
|
This specification defines standard functions for owning or controlling a contract.
|
||||||
|
|
||||||
|
An implementation allows reading the current owner (`owner() returns (address)`) and transferring ownership (`transferOwnership(address newOwner)`) along with a standardized event for when ownership is changed (`OwnershipTransferred(address indexed previousOwner, address indexed newOwner)`).
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
Many smart contracts require that they be owned or controlled in some way. For example to withdraw funds or perform administrative actions. It is so common that the contract interface used to handle contract ownership should be standardized to allow compatibility with user interfaces and contracts that manage contracts.
|
||||||
|
|
||||||
|
Here are some examples of kinds of contracts and applications that can benefit from this standard:
|
||||||
|
1. Exchanges that buy/sell/auction ethereum contracts. This is only widely possible if there is a standard for getting the owner of a contract and transferring ownership.
|
||||||
|
2. Contract wallets that hold the ownership of contracts and that can transfer the ownership of contracts.
|
||||||
|
3. Contract registries. It makes sense for some registries to only allow the owners of contracts to add/remove their contracts. A standard must exist for these contract registries to verify that a contract is being submitted by the owner of it before accepting it.
|
||||||
|
4. User interfaces that show and transfer ownership of contracts.
|
||||||
|
|
||||||
|
## Specification
|
||||||
|
|
||||||
|
Every ERC-173 compliant contract must implement the `ERC173` interface. Contracts should also implement `ERC165` for the ERC-173 interface.
|
||||||
|
|
||||||
|
```solidity
|
||||||
|
|
||||||
|
/// @title ERC-173 Contract Ownership Standard
|
||||||
|
/// Note: the ERC-165 identifier for this interface is 0x7f5828d0
|
||||||
|
interface ERC173 /* is ERC165 */ {
|
||||||
|
/// @dev This emits when ownership of a contract changes.
|
||||||
|
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
|
||||||
|
|
||||||
|
/// @notice Get the address of the owner
|
||||||
|
/// @return The address of the owner.
|
||||||
|
function owner() view external returns(address);
|
||||||
|
|
||||||
|
/// @notice Set the address of the new owner of the contract
|
||||||
|
/// @dev Set _newOwner to address(0) to renounce any ownership.
|
||||||
|
/// @param _newOwner The address of the new owner of the contract
|
||||||
|
function transferOwnership(address _newOwner) external;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ERC165 {
|
||||||
|
/// @notice Query if a contract implements an interface
|
||||||
|
/// @param interfaceID The interface identifier, as specified in ERC-165
|
||||||
|
/// @dev Interface identification is specified in ERC-165. This function
|
||||||
|
/// uses less than 30,000 gas.
|
||||||
|
/// @return `true` if the contract implements `interfaceID` and
|
||||||
|
/// `interfaceID` is not 0xffffffff, `false` otherwise
|
||||||
|
function supportsInterface(bytes4 interfaceID) external view returns (bool);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `owner()` function may be implemented as `pure` or `view`.
|
||||||
|
|
||||||
|
The `transferOwnership(address _newOwner)` function may be implemented as `public` or `external`.
|
||||||
|
|
||||||
|
To renounce any ownership of a contract set `_newOwner` to the zero address: `transferOwnership(address(0))`. If this is done then a contract is no longer owned by anybody.
|
||||||
|
|
||||||
|
The OwnershipTransferred event should be emitted when a contract is created.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
Key factors influencing the standard:
|
||||||
|
- Keeping the number of functions in the interface to a minimum to prevent contract bloat.
|
||||||
|
- Backwards compatibility with existing contracts.
|
||||||
|
- Simplicity
|
||||||
|
- Gas efficient
|
||||||
|
|
||||||
|
Several ownership schemes were considered. The scheme chosen in this standard was chosen because of its simplicity, low gas cost and backwards compatibility with existing contracts.
|
||||||
|
|
||||||
|
Here are other schemes that were considered:
|
||||||
|
1. **Associating an Ethereum Name Service (ENS) domain name with a contract.** A contract's `owner()` function could look up the owner address of a particular ENS name and use that as the owning address of the contract. Using this scheme a contract could be transferred by transferring the ownership of the ENS domain name to a different address. Short comings to this approach are that it is not backwards compatible with existing contracts and requires gas to make external calls to ENS related contracts to get the owner address.
|
||||||
|
2. **Associating an ERC721-based non-fungible token (NFT) with a contract.** Ownership of a contract could be tied to the ownership of an NFT. The benefit of this approach is that the existing ERC721-based infrastructure could be used to sell/buy/auction contracts. Short comings to this approach are additional complexity and infrastructure required. A contract could be associated with a particular NFT but the NFT would not track that it had ownership of a contract unless it was programmed to track contracts. In addition handling ownership of contracts this way is not backwards compatible.
|
||||||
|
|
||||||
|
This standard does not exclude the above ownership schemes or other schemes from also being implemented in the same contract. For example a contract could implement this standard and also implement the other schemes so that ownership could be managed and transferred in multiple ways. This standard does provide a simple ownership scheme that is backwards compatible, is light-weight and simple to implement, and can be widely adopted and depended on.
|
||||||
|
|
||||||
|
This standard can be extended by other standards to add additional ownership functionality. For example [EIP-2767](./eip-2767.md) uses and extends this standard by adding decentralized contract ownership governance.
|
||||||
|
|
||||||
|
## Security Considerations
|
||||||
|
|
||||||
|
If the address returned by `owner()` is an externally owned account then its private key must not be lost or compromised.
|
||||||
|
|
||||||
|
## Backwards Compatibility
|
||||||
|
|
||||||
|
Many existing contracts already implement this standard.
|
||||||
|
|
||||||
|
## Implementations
|
||||||
|
|
||||||
|
* [OpenZeppelin's implementation of Ownable](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/access/Ownable.sol)
|
||||||
|
* [0xcert ownable](https://github.com/0xcert/ethereum-erc721/blob/master/src/contracts/ownership/ownable.sol)
|
||||||
|
* [FriendlyUser Ownable](https://github.com/FriendlyUser/solidity-smart-contracts//blob/v0.2.0/contracts/other/CredVert/Ownable.sol)
|
||||||
|
|
||||||
|
|
||||||
|
## Copyright
|
||||||
|
|
||||||
|
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
|
193
spec/eip-20.md
Normal file
193
spec/eip-20.md
Normal file
@ -0,0 +1,193 @@
|
|||||||
|
---
|
||||||
|
eip: 20
|
||||||
|
title: Token Standard
|
||||||
|
author: Fabian Vogelsteller <fabian@ethereum.org>, Vitalik Buterin <vitalik.buterin@ethereum.org>
|
||||||
|
type: Standards Track
|
||||||
|
category: ERC
|
||||||
|
status: Final
|
||||||
|
created: 2015-11-19
|
||||||
|
---
|
||||||
|
|
||||||
|
## Simple Summary
|
||||||
|
|
||||||
|
A standard interface for tokens.
|
||||||
|
|
||||||
|
|
||||||
|
## Abstract
|
||||||
|
|
||||||
|
The following standard allows for the implementation of a standard API for tokens within smart contracts.
|
||||||
|
This standard provides basic functionality to transfer tokens, as well as allow tokens to be approved so they can be spent by another on-chain third party.
|
||||||
|
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
A standard interface allows any tokens on Ethereum to be re-used by other applications: from wallets to decentralized exchanges.
|
||||||
|
|
||||||
|
|
||||||
|
## Specification
|
||||||
|
|
||||||
|
## Token
|
||||||
|
### Methods
|
||||||
|
|
||||||
|
**NOTES**:
|
||||||
|
- The following specifications use syntax from Solidity `0.4.17` (or above)
|
||||||
|
- Callers MUST handle `false` from `returns (bool success)`. Callers MUST NOT assume that `false` is never returned!
|
||||||
|
|
||||||
|
|
||||||
|
#### name
|
||||||
|
|
||||||
|
Returns the name of the token - e.g. `"MyToken"`.
|
||||||
|
|
||||||
|
OPTIONAL - This method can be used to improve usability,
|
||||||
|
but interfaces and other contracts MUST NOT expect these values to be present.
|
||||||
|
|
||||||
|
|
||||||
|
``` js
|
||||||
|
function name() public view returns (string)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### symbol
|
||||||
|
|
||||||
|
Returns the symbol of the token. E.g. "HIX".
|
||||||
|
|
||||||
|
OPTIONAL - This method can be used to improve usability,
|
||||||
|
but interfaces and other contracts MUST NOT expect these values to be present.
|
||||||
|
|
||||||
|
``` js
|
||||||
|
function symbol() public view returns (string)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### decimals
|
||||||
|
|
||||||
|
Returns the number of decimals the token uses - e.g. `8`, means to divide the token amount by `100000000` to get its user representation.
|
||||||
|
|
||||||
|
OPTIONAL - This method can be used to improve usability,
|
||||||
|
but interfaces and other contracts MUST NOT expect these values to be present.
|
||||||
|
|
||||||
|
``` js
|
||||||
|
function decimals() public view returns (uint8)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### totalSupply
|
||||||
|
|
||||||
|
Returns the total token supply.
|
||||||
|
|
||||||
|
``` js
|
||||||
|
function totalSupply() public view returns (uint256)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### balanceOf
|
||||||
|
|
||||||
|
Returns the account balance of another account with address `_owner`.
|
||||||
|
|
||||||
|
``` js
|
||||||
|
function balanceOf(address _owner) public view returns (uint256 balance)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### transfer
|
||||||
|
|
||||||
|
Transfers `_value` amount of tokens to address `_to`, and MUST fire the `Transfer` event.
|
||||||
|
The function SHOULD `throw` if the message caller's account balance does not have enough tokens to spend.
|
||||||
|
|
||||||
|
*Note* Transfers of 0 values MUST be treated as normal transfers and fire the `Transfer` event.
|
||||||
|
|
||||||
|
``` js
|
||||||
|
function transfer(address _to, uint256 _value) public returns (bool success)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### transferFrom
|
||||||
|
|
||||||
|
Transfers `_value` amount of tokens from address `_from` to address `_to`, and MUST fire the `Transfer` event.
|
||||||
|
|
||||||
|
The `transferFrom` method is used for a withdraw workflow, allowing contracts to transfer tokens on your behalf.
|
||||||
|
This can be used for example to allow a contract to transfer tokens on your behalf and/or to charge fees in sub-currencies.
|
||||||
|
The function SHOULD `throw` unless the `_from` account has deliberately authorized the sender of the message via some mechanism.
|
||||||
|
|
||||||
|
*Note* Transfers of 0 values MUST be treated as normal transfers and fire the `Transfer` event.
|
||||||
|
|
||||||
|
``` js
|
||||||
|
function transferFrom(address _from, address _to, uint256 _value) public returns (bool success)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### approve
|
||||||
|
|
||||||
|
Allows `_spender` to withdraw from your account multiple times, up to the `_value` amount. If this function is called again it overwrites the current allowance with `_value`.
|
||||||
|
|
||||||
|
**NOTE**: To prevent attack vectors like the one [described here](https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/) and discussed [here](https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729),
|
||||||
|
clients SHOULD make sure to create user interfaces in such a way that they set the allowance first to `0` before setting it to another value for the same spender.
|
||||||
|
THOUGH The contract itself shouldn't enforce it, to allow backwards compatibility with contracts deployed before
|
||||||
|
|
||||||
|
``` js
|
||||||
|
function approve(address _spender, uint256 _value) public returns (bool success)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### allowance
|
||||||
|
|
||||||
|
Returns the amount which `_spender` is still allowed to withdraw from `_owner`.
|
||||||
|
|
||||||
|
``` js
|
||||||
|
function allowance(address _owner, address _spender) public view returns (uint256 remaining)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Events
|
||||||
|
|
||||||
|
|
||||||
|
#### Transfer
|
||||||
|
|
||||||
|
MUST trigger when tokens are transferred, including zero value transfers.
|
||||||
|
|
||||||
|
A token contract which creates new tokens SHOULD trigger a Transfer event with the `_from` address set to `0x0` when tokens are created.
|
||||||
|
|
||||||
|
``` js
|
||||||
|
event Transfer(address indexed _from, address indexed _to, uint256 _value)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#### Approval
|
||||||
|
|
||||||
|
MUST trigger on any successful call to `approve(address _spender, uint256 _value)`.
|
||||||
|
|
||||||
|
``` js
|
||||||
|
event Approval(address indexed _owner, address indexed _spender, uint256 _value)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Implementation
|
||||||
|
|
||||||
|
There are already plenty of ERC20-compliant tokens deployed on the Ethereum network.
|
||||||
|
Different implementations have been written by various teams that have different trade-offs: from gas saving to improved security.
|
||||||
|
|
||||||
|
#### Example implementations are available at
|
||||||
|
- [OpenZeppelin implementation](https://github.com/OpenZeppelin/openzeppelin-solidity/blob/9b3710465583284b8c4c5d2245749246bb2e0094/contracts/token/ERC20/ERC20.sol)
|
||||||
|
- [ConsenSys implementation](https://github.com/ConsenSys/Tokens/blob/fdf687c69d998266a95f15216b1955a4965a0a6d/contracts/eip20/EIP20.sol)
|
||||||
|
|
||||||
|
|
||||||
|
## History
|
||||||
|
|
||||||
|
Historical links related to this standard:
|
||||||
|
|
||||||
|
- Original proposal from Vitalik Buterin: https://github.com/ethereum/wiki/wiki/Standardized_Contract_APIs/499c882f3ec123537fc2fccd57eaa29e6032fe4a
|
||||||
|
- Reddit discussion: https://www.reddit.com/r/ethereum/comments/3n8fkn/lets_talk_about_the_coin_standard/
|
||||||
|
- Original Issue #20: https://github.com/ethereum/EIPs/issues/20
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Copyright
|
||||||
|
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
|
447
spec/eip-721.md
Normal file
447
spec/eip-721.md
Normal file
@ -0,0 +1,447 @@
|
|||||||
|
---
|
||||||
|
eip: 721
|
||||||
|
title: Non-Fungible Token Standard
|
||||||
|
author: William Entriken (@fulldecent), Dieter Shirley <dete@axiomzen.co>, Jacob Evans <jacob@dekz.net>, Nastassia Sachs <nastassia.sachs@protonmail.com>
|
||||||
|
discussions-to: https://github.com/ethereum/eips/issues/721
|
||||||
|
type: Standards Track
|
||||||
|
category: ERC
|
||||||
|
status: Final
|
||||||
|
created: 2018-01-24
|
||||||
|
requires: 165
|
||||||
|
---
|
||||||
|
|
||||||
|
## Simple Summary
|
||||||
|
|
||||||
|
A standard interface for non-fungible tokens, also known as deeds.
|
||||||
|
|
||||||
|
## Abstract
|
||||||
|
|
||||||
|
The following standard allows for the implementation of a standard API for NFTs within smart contracts. This standard provides basic functionality to track and transfer NFTs.
|
||||||
|
|
||||||
|
We considered use cases of NFTs being owned and transacted by individuals as well as consignment to third party brokers/wallets/auctioneers ("operators"). NFTs can represent ownership over digital or physical assets. We considered a diverse universe of assets, and we know you will dream up many more:
|
||||||
|
|
||||||
|
- Physical property — houses, unique artwork
|
||||||
|
- Virtual collectables — unique pictures of kittens, collectable cards
|
||||||
|
- "Negative value" assets — loans, burdens and other responsibilities
|
||||||
|
|
||||||
|
In general, all houses are distinct and no two kittens are alike. NFTs are *distinguishable* and you must track the ownership of each one separately.
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
A standard interface allows wallet/broker/auction applications to work with any NFT on Ethereum. We provide for simple ERC-721 smart contracts as well as contracts that track an *arbitrarily large* number of NFTs. Additional applications are discussed below.
|
||||||
|
|
||||||
|
This standard is inspired by the ERC-20 token standard and builds on two years of experience since EIP-20 was created. EIP-20 is insufficient for tracking NFTs because each asset is distinct (non-fungible) whereas each of a quantity of tokens is identical (fungible).
|
||||||
|
|
||||||
|
Differences between this standard and EIP-20 are examined below.
|
||||||
|
|
||||||
|
## Specification
|
||||||
|
|
||||||
|
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
|
||||||
|
|
||||||
|
**Every ERC-721 compliant contract must implement the `ERC721` and `ERC165` interfaces** (subject to "caveats" below):
|
||||||
|
|
||||||
|
```solidity
|
||||||
|
pragma solidity ^0.4.20;
|
||||||
|
|
||||||
|
/// @title ERC-721 Non-Fungible Token Standard
|
||||||
|
/// @dev See https://eips.ethereum.org/EIPS/eip-721
|
||||||
|
/// Note: the ERC-165 identifier for this interface is 0x80ac58cd.
|
||||||
|
interface ERC721 /* is ERC165 */ {
|
||||||
|
/// @dev This emits when ownership of any NFT changes by any mechanism.
|
||||||
|
/// This event emits when NFTs are created (`from` == 0) and destroyed
|
||||||
|
/// (`to` == 0). Exception: during contract creation, any number of NFTs
|
||||||
|
/// may be created and assigned without emitting Transfer. At the time of
|
||||||
|
/// any transfer, the approved address for that NFT (if any) is reset to none.
|
||||||
|
event Transfer(address indexed _from, address indexed _to, uint256 indexed _tokenId);
|
||||||
|
|
||||||
|
/// @dev This emits when the approved address for an NFT is changed or
|
||||||
|
/// reaffirmed. The zero address indicates there is no approved address.
|
||||||
|
/// When a Transfer event emits, this also indicates that the approved
|
||||||
|
/// address for that NFT (if any) is reset to none.
|
||||||
|
event Approval(address indexed _owner, address indexed _approved, uint256 indexed _tokenId);
|
||||||
|
|
||||||
|
/// @dev This emits when an operator is enabled or disabled for an owner.
|
||||||
|
/// The operator can manage all NFTs of the owner.
|
||||||
|
event ApprovalForAll(address indexed _owner, address indexed _operator, bool _approved);
|
||||||
|
|
||||||
|
/// @notice Count all NFTs assigned to an owner
|
||||||
|
/// @dev NFTs assigned to the zero address are considered invalid, and this
|
||||||
|
/// function throws for queries about the zero address.
|
||||||
|
/// @param _owner An address for whom to query the balance
|
||||||
|
/// @return The number of NFTs owned by `_owner`, possibly zero
|
||||||
|
function balanceOf(address _owner) external view returns (uint256);
|
||||||
|
|
||||||
|
/// @notice Find the owner of an NFT
|
||||||
|
/// @dev NFTs assigned to zero address are considered invalid, and queries
|
||||||
|
/// about them do throw.
|
||||||
|
/// @param _tokenId The identifier for an NFT
|
||||||
|
/// @return The address of the owner of the NFT
|
||||||
|
function ownerOf(uint256 _tokenId) external view returns (address);
|
||||||
|
|
||||||
|
/// @notice Transfers the ownership of an NFT from one address to another address
|
||||||
|
/// @dev Throws unless `msg.sender` is the current owner, an authorized
|
||||||
|
/// operator, or the approved address for this NFT. Throws if `_from` is
|
||||||
|
/// not the current owner. Throws if `_to` is the zero address. Throws if
|
||||||
|
/// `_tokenId` is not a valid NFT. When transfer is complete, this function
|
||||||
|
/// checks if `_to` is a smart contract (code size > 0). If so, it calls
|
||||||
|
/// `onERC721Received` on `_to` and throws if the return value is not
|
||||||
|
/// `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`.
|
||||||
|
/// @param _from The current owner of the NFT
|
||||||
|
/// @param _to The new owner
|
||||||
|
/// @param _tokenId The NFT to transfer
|
||||||
|
/// @param data Additional data with no specified format, sent in call to `_to`
|
||||||
|
function safeTransferFrom(address _from, address _to, uint256 _tokenId, bytes data) external payable;
|
||||||
|
|
||||||
|
/// @notice Transfers the ownership of an NFT from one address to another address
|
||||||
|
/// @dev This works identically to the other function with an extra data parameter,
|
||||||
|
/// except this function just sets data to "".
|
||||||
|
/// @param _from The current owner of the NFT
|
||||||
|
/// @param _to The new owner
|
||||||
|
/// @param _tokenId The NFT to transfer
|
||||||
|
function safeTransferFrom(address _from, address _to, uint256 _tokenId) external payable;
|
||||||
|
|
||||||
|
/// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE
|
||||||
|
/// TO CONFIRM THAT `_to` IS CAPABLE OF RECEIVING NFTS OR ELSE
|
||||||
|
/// THEY MAY BE PERMANENTLY LOST
|
||||||
|
/// @dev Throws unless `msg.sender` is the current owner, an authorized
|
||||||
|
/// operator, or the approved address for this NFT. Throws if `_from` is
|
||||||
|
/// not the current owner. Throws if `_to` is the zero address. Throws if
|
||||||
|
/// `_tokenId` is not a valid NFT.
|
||||||
|
/// @param _from The current owner of the NFT
|
||||||
|
/// @param _to The new owner
|
||||||
|
/// @param _tokenId The NFT to transfer
|
||||||
|
function transferFrom(address _from, address _to, uint256 _tokenId) external payable;
|
||||||
|
|
||||||
|
/// @notice Change or reaffirm the approved address for an NFT
|
||||||
|
/// @dev The zero address indicates there is no approved address.
|
||||||
|
/// Throws unless `msg.sender` is the current NFT owner, or an authorized
|
||||||
|
/// operator of the current owner.
|
||||||
|
/// @param _approved The new approved NFT controller
|
||||||
|
/// @param _tokenId The NFT to approve
|
||||||
|
function approve(address _approved, uint256 _tokenId) external payable;
|
||||||
|
|
||||||
|
/// @notice Enable or disable approval for a third party ("operator") to manage
|
||||||
|
/// all of `msg.sender`'s assets
|
||||||
|
/// @dev Emits the ApprovalForAll event. The contract MUST allow
|
||||||
|
/// multiple operators per owner.
|
||||||
|
/// @param _operator Address to add to the set of authorized operators
|
||||||
|
/// @param _approved True if the operator is approved, false to revoke approval
|
||||||
|
function setApprovalForAll(address _operator, bool _approved) external;
|
||||||
|
|
||||||
|
/// @notice Get the approved address for a single NFT
|
||||||
|
/// @dev Throws if `_tokenId` is not a valid NFT.
|
||||||
|
/// @param _tokenId The NFT to find the approved address for
|
||||||
|
/// @return The approved address for this NFT, or the zero address if there is none
|
||||||
|
function getApproved(uint256 _tokenId) external view returns (address);
|
||||||
|
|
||||||
|
/// @notice Query if an address is an authorized operator for another address
|
||||||
|
/// @param _owner The address that owns the NFTs
|
||||||
|
/// @param _operator The address that acts on behalf of the owner
|
||||||
|
/// @return True if `_operator` is an approved operator for `_owner`, false otherwise
|
||||||
|
function isApprovedForAll(address _owner, address _operator) external view returns (bool);
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ERC165 {
|
||||||
|
/// @notice Query if a contract implements an interface
|
||||||
|
/// @param interfaceID The interface identifier, as specified in ERC-165
|
||||||
|
/// @dev Interface identification is specified in ERC-165. This function
|
||||||
|
/// uses less than 30,000 gas.
|
||||||
|
/// @return `true` if the contract implements `interfaceID` and
|
||||||
|
/// `interfaceID` is not 0xffffffff, `false` otherwise
|
||||||
|
function supportsInterface(bytes4 interfaceID) external view returns (bool);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
A wallet/broker/auction application MUST implement the **wallet interface** if it will accept safe transfers.
|
||||||
|
|
||||||
|
```solidity
|
||||||
|
/// @dev Note: the ERC-165 identifier for this interface is 0x150b7a02.
|
||||||
|
interface ERC721TokenReceiver {
|
||||||
|
/// @notice Handle the receipt of an NFT
|
||||||
|
/// @dev The ERC721 smart contract calls this function on the recipient
|
||||||
|
/// after a `transfer`. This function MAY throw to revert and reject the
|
||||||
|
/// transfer. Return of other than the magic value MUST result in the
|
||||||
|
/// transaction being reverted.
|
||||||
|
/// Note: the contract address is always the message sender.
|
||||||
|
/// @param _operator The address which called `safeTransferFrom` function
|
||||||
|
/// @param _from The address which previously owned the token
|
||||||
|
/// @param _tokenId The NFT identifier which is being transferred
|
||||||
|
/// @param _data Additional data with no specified format
|
||||||
|
/// @return `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`
|
||||||
|
/// unless throwing
|
||||||
|
function onERC721Received(address _operator, address _from, uint256 _tokenId, bytes _data) external returns(bytes4);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The **metadata extension** is OPTIONAL for ERC-721 smart contracts (see "caveats", below). This allows your smart contract to be interrogated for its name and for details about the assets which your NFTs represent.
|
||||||
|
|
||||||
|
```solidity
|
||||||
|
/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension
|
||||||
|
/// @dev See https://eips.ethereum.org/EIPS/eip-721
|
||||||
|
/// Note: the ERC-165 identifier for this interface is 0x5b5e139f.
|
||||||
|
interface ERC721Metadata /* is ERC721 */ {
|
||||||
|
/// @notice A descriptive name for a collection of NFTs in this contract
|
||||||
|
function name() external view returns (string _name);
|
||||||
|
|
||||||
|
/// @notice An abbreviated name for NFTs in this contract
|
||||||
|
function symbol() external view returns (string _symbol);
|
||||||
|
|
||||||
|
/// @notice A distinct Uniform Resource Identifier (URI) for a given asset.
|
||||||
|
/// @dev Throws if `_tokenId` is not a valid NFT. URIs are defined in RFC
|
||||||
|
/// 3986. The URI may point to a JSON file that conforms to the "ERC721
|
||||||
|
/// Metadata JSON Schema".
|
||||||
|
function tokenURI(uint256 _tokenId) external view returns (string);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This is the "ERC721 Metadata JSON Schema" referenced above.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"title": "Asset Metadata",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"name": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Identifies the asset to which this NFT represents"
|
||||||
|
},
|
||||||
|
"description": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Describes the asset to which this NFT represents"
|
||||||
|
},
|
||||||
|
"image": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "A URI pointing to a resource with mime type image/* representing the asset to which this NFT represents. Consider making any images at a width between 320 and 1080 pixels and aspect ratio between 1.91:1 and 4:5 inclusive."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The **enumeration extension** is OPTIONAL for ERC-721 smart contracts (see "caveats", below). This allows your contract to publish its full list of NFTs and make them discoverable.
|
||||||
|
|
||||||
|
```solidity
|
||||||
|
/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension
|
||||||
|
/// @dev See https://eips.ethereum.org/EIPS/eip-721
|
||||||
|
/// Note: the ERC-165 identifier for this interface is 0x780e9d63.
|
||||||
|
interface ERC721Enumerable /* is ERC721 */ {
|
||||||
|
/// @notice Count NFTs tracked by this contract
|
||||||
|
/// @return A count of valid NFTs tracked by this contract, where each one of
|
||||||
|
/// them has an assigned and queryable owner not equal to the zero address
|
||||||
|
function totalSupply() external view returns (uint256);
|
||||||
|
|
||||||
|
/// @notice Enumerate valid NFTs
|
||||||
|
/// @dev Throws if `_index` >= `totalSupply()`.
|
||||||
|
/// @param _index A counter less than `totalSupply()`
|
||||||
|
/// @return The token identifier for the `_index`th NFT,
|
||||||
|
/// (sort order not specified)
|
||||||
|
function tokenByIndex(uint256 _index) external view returns (uint256);
|
||||||
|
|
||||||
|
/// @notice Enumerate NFTs assigned to an owner
|
||||||
|
/// @dev Throws if `_index` >= `balanceOf(_owner)` or if
|
||||||
|
/// `_owner` is the zero address, representing invalid NFTs.
|
||||||
|
/// @param _owner An address where we are interested in NFTs owned by them
|
||||||
|
/// @param _index A counter less than `balanceOf(_owner)`
|
||||||
|
/// @return The token identifier for the `_index`th NFT assigned to `_owner`,
|
||||||
|
/// (sort order not specified)
|
||||||
|
function tokenOfOwnerByIndex(address _owner, uint256 _index) external view returns (uint256);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Caveats
|
||||||
|
|
||||||
|
The 0.4.20 Solidity interface grammar is not expressive enough to document the ERC-721 standard. A contract which complies with ERC-721 MUST also abide by the following:
|
||||||
|
|
||||||
|
- Solidity issue #3412: The above interfaces include explicit mutability guarantees for each function. Mutability guarantees are, in order weak to strong: `payable`, implicit nonpayable, `view`, and `pure`. Your implementation MUST meet the mutability guarantee in this interface and you MAY meet a stronger guarantee. For example, a `payable` function in this interface may be implemented as nonpayable (no state mutability specified) in your contract. We expect a later Solidity release will allow your stricter contract to inherit from this interface, but a workaround for version 0.4.20 is that you can edit this interface to add stricter mutability before inheriting from your contract.
|
||||||
|
- Solidity issue #3419: A contract that implements `ERC721Metadata` or `ERC721Enumerable` SHALL also implement `ERC721`. ERC-721 implements the requirements of interface ERC-165.
|
||||||
|
- Solidity issue #2330: If a function is shown in this specification as `external` then a contract will be compliant if it uses `public` visibility. As a workaround for version 0.4.20, you can edit this interface to switch to `public` before inheriting from your contract.
|
||||||
|
- Solidity issues #3494, #3544: Use of `this.*.selector` is marked as a warning by Solidity, a future version of Solidity will not mark this as an error.
|
||||||
|
|
||||||
|
*If a newer version of Solidity allows the caveats to be expressed in code, then this EIP MAY be updated and the caveats removed, such will be equivalent to the original specification.*
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
There are many proposed uses of Ethereum smart contracts that depend on tracking distinguishable assets. Examples of existing or planned NFTs are LAND in Decentraland, the eponymous punks in CryptoPunks, and in-game items using systems like DMarket or EnjinCoin. Future uses include tracking real-world assets, like real-estate (as envisioned by companies like Ubitquity or Propy). It is critical in each of these cases that these items are not "lumped together" as numbers in a ledger, but instead each asset must have its ownership individually and atomically tracked. Regardless of the nature of these assets, the ecosystem will be stronger if we have a standardized interface that allows for cross-functional asset management and sales platforms.
|
||||||
|
|
||||||
|
**"NFT" Word Choice**
|
||||||
|
|
||||||
|
"NFT" was satisfactory to nearly everyone surveyed and is widely applicable to a broad universe of distinguishable digital assets. We recognize that "deed" is very descriptive for certain applications of this standard (notably, physical property).
|
||||||
|
|
||||||
|
*Alternatives considered: distinguishable asset, title, token, asset, equity, ticket*
|
||||||
|
|
||||||
|
**NFT Identifiers**
|
||||||
|
|
||||||
|
Every NFT is identified by a unique `uint256` ID inside the ERC-721 smart contract. This identifying number SHALL NOT change for the life of the contract. The pair `(contract address, uint256 tokenId)` will then be a globally unique and fully-qualified identifier for a specific asset on an Ethereum chain. While some ERC-721 smart contracts may find it convenient to start with ID 0 and simply increment by one for each new NFT, callers SHALL NOT assume that ID numbers have any specific pattern to them, and MUST treat the ID as a "black box". Also note that a NFTs MAY become invalid (be destroyed). Please see the enumeration functions for a supported enumeration interface.
|
||||||
|
|
||||||
|
The choice of `uint256` allows a wide variety of applications because UUIDs and sha3 hashes are directly convertible to `uint256`.
|
||||||
|
|
||||||
|
**Transfer Mechanism**
|
||||||
|
|
||||||
|
ERC-721 standardizes a safe transfer function `safeTransferFrom` (overloaded with and without a `bytes` parameter) and an unsafe function `transferFrom`. Transfers may be initiated by:
|
||||||
|
|
||||||
|
- The owner of an NFT
|
||||||
|
- The approved address of an NFT
|
||||||
|
- An authorized operator of the current owner of an NFT
|
||||||
|
|
||||||
|
Additionally, an authorized operator may set the approved address for an NFT. This provides a powerful set of tools for wallet, broker and auction applications to quickly use a *large* number of NFTs.
|
||||||
|
|
||||||
|
The transfer and accept functions' documentation only specify conditions when the transaction MUST throw. Your implementation MAY also throw in other situations. This allows implementations to achieve interesting results:
|
||||||
|
|
||||||
|
- **Disallow transfers if the contract is paused** — prior art, CryptoKitties deployed contract, line 611
|
||||||
|
- **Blocklist certain address from receiving NFTs** — prior art, CryptoKitties deployed contract, lines 565, 566
|
||||||
|
- **Disallow unsafe transfers** — `transferFrom` throws unless `_to` equals `msg.sender` or `countOf(_to)` is non-zero or was non-zero previously (because such cases are safe)
|
||||||
|
- **Charge a fee to both parties of a transaction** — require payment when calling `approve` with a non-zero `_approved` if it was previously the zero address, refund payment if calling `approve` with the zero address if it was previously a non-zero address, require payment when calling any transfer function, require transfer parameter `_to` to equal `msg.sender`, require transfer parameter `_to` to be the approved address for the NFT
|
||||||
|
- **Read only NFT registry** — always throw from `unsafeTransfer`, `transferFrom`, `approve` and `setApprovalForAll`
|
||||||
|
|
||||||
|
Failed transactions will throw, a best practice identified in ERC-223, ERC-677, ERC-827 and OpenZeppelin's implementation of SafeERC20.sol. ERC-20 defined an `allowance` feature, this caused a problem when called and then later modified to a different amount, as on OpenZeppelin issue \#438. In ERC-721, there is no allowance because every NFT is unique, the quantity is none or one. Therefore we receive the benefits of ERC-20's original design without problems that have been later discovered.
|
||||||
|
|
||||||
|
Creation of NFTs ("minting") and destruction of NFTs ("burning") is not included in the specification. Your contract may implement these by other means. Please see the `event` documentation for your responsibilities when creating or destroying NFTs.
|
||||||
|
|
||||||
|
We questioned if the `operator` parameter on `onERC721Received` was necessary. In all cases we could imagine, if the operator was important then that operator could transfer the token to themself and then send it -- then they would be the `from` address. This seems contrived because we consider the operator to be a temporary owner of the token (and transferring to themself is redundant). When the operator sends the token, it is the operator acting on their own accord, NOT the operator acting on behalf of the token holder. This is why the operator and the previous token owner are both significant to the token recipient.
|
||||||
|
|
||||||
|
*Alternatives considered: only allow two-step ERC-20 style transaction, require that transfer functions never throw, require all functions to return a boolean indicating the success of the operation.*
|
||||||
|
|
||||||
|
**ERC-165 Interface**
|
||||||
|
|
||||||
|
We chose Standard Interface Detection (ERC-165) to expose the interfaces that a ERC-721 smart contract supports.
|
||||||
|
|
||||||
|
A future EIP may create a global registry of interfaces for contracts. We strongly support such an EIP and it would allow your ERC-721 implementation to implement `ERC721Enumerable`, `ERC721Metadata`, or other interfaces by delegating to a separate contract.
|
||||||
|
|
||||||
|
**Gas and Complexity** (regarding the enumeration extension)
|
||||||
|
|
||||||
|
This specification contemplates implementations that manage a few and *arbitrarily large* numbers of NFTs. If your application is able to grow then avoid using for/while loops in your code (see CryptoKitties bounty issue \#4). These indicate your contract may be unable to scale and gas costs will rise over time without bound.
|
||||||
|
|
||||||
|
We have deployed a contract, XXXXERC721, to Testnet which instantiates and tracks 340282366920938463463374607431768211456 different deeds (2^128). That's enough to assign every IPV6 address to an Ethereum account owner, or to track ownership of nanobots a few micron in size and in aggregate totalling half the size of Earth. You can query it from the blockchain. And every function takes less gas than querying the ENS.
|
||||||
|
|
||||||
|
This illustration makes clear: the ERC-721 standard scales.
|
||||||
|
|
||||||
|
*Alternatives considered: remove the asset enumeration function if it requires a for-loop, return a Solidity array type from enumeration functions.*
|
||||||
|
|
||||||
|
**Privacy**
|
||||||
|
|
||||||
|
Wallets/brokers/auctioneers identified in the motivation section have a strong need to identify which NFTs an owner owns.
|
||||||
|
|
||||||
|
It may be interesting to consider a use case where NFTs are not enumerable, such as a private registry of property ownership, or a partially-private registry. However, privacy cannot be attained because an attacker can simply (!) call `ownerOf` for every possible `tokenId`.
|
||||||
|
|
||||||
|
**Metadata Choices** (metadata extension)
|
||||||
|
|
||||||
|
We have required `name` and `symbol` functions in the metadata extension. Every token EIP and draft we reviewed (ERC-20, ERC-223, ERC-677, ERC-777, ERC-827) included these functions.
|
||||||
|
|
||||||
|
We remind implementation authors that the empty string is a valid response to `name` and `symbol` if you protest to the usage of this mechanism. We also remind everyone that any smart contract can use the same name and symbol as *your* contract. How a client may determine which ERC-721 smart contracts are well-known (canonical) is outside the scope of this standard.
|
||||||
|
|
||||||
|
A mechanism is provided to associate NFTs with URIs. We expect that many implementations will take advantage of this to provide metadata for each NFT. The image size recommendation is taken from Instagram, they probably know much about image usability. The URI MAY be mutable (i.e. it changes from time to time). We considered an NFT representing ownership of a house, in this case metadata about the house (image, occupants, etc.) can naturally change.
|
||||||
|
|
||||||
|
Metadata is returned as a string value. Currently this is only usable as calling from `web3`, not from other contracts. This is acceptable because we have not considered a use case where an on-blockchain application would query such information.
|
||||||
|
|
||||||
|
*Alternatives considered: put all metadata for each asset on the blockchain (too expensive), use URL templates to query metadata parts (URL templates do not work with all URL schemes, especially P2P URLs), multiaddr network address (not mature enough)*
|
||||||
|
|
||||||
|
**Community Consensus**
|
||||||
|
|
||||||
|
A significant amount of discussion occurred on the original ERC-721 issue, additionally we held a first live meeting on Gitter that had good representation and well advertised (on Reddit, in the Gitter #ERC channel, and the original ERC-721 issue). Thank you to the participants:
|
||||||
|
|
||||||
|
- [@ImAllInNow](https://github.com/imallinnow) Rob from DEC Gaming / Presenting Michigan Ethereum Meetup Feb 7
|
||||||
|
- [@Arachnid](https://github.com/arachnid) Nick Johnson
|
||||||
|
- [@jadhavajay](https://github.com/jadhavajay) Ajay Jadhav from AyanWorks
|
||||||
|
- [@superphly](https://github.com/superphly) Cody Marx Bailey - XRAM Capital / Sharing at hackathon Jan 20 / UN Future of Finance Hackathon.
|
||||||
|
- [@fulldecent](https://github.com/fulldecent) William Entriken
|
||||||
|
|
||||||
|
A second event was held at ETHDenver 2018 to discuss distinguishable asset standards (notes to be published).
|
||||||
|
|
||||||
|
We have been very inclusive in this process and invite anyone with questions or contributions into our discussion. However, this standard is written only to support the identified use cases which are listed herein.
|
||||||
|
|
||||||
|
## Backwards Compatibility
|
||||||
|
|
||||||
|
We have adopted `balanceOf`, `totalSupply`, `name` and `symbol` semantics from the ERC-20 specification. An implementation may also include a function `decimals` that returns `uint8(0)` if its goal is to be more compatible with ERC-20 while supporting this standard. However, we find it contrived to require all ERC-721 implementations to support the `decimals` function.
|
||||||
|
|
||||||
|
Example NFT implementations as of February 2018:
|
||||||
|
|
||||||
|
- CryptoKitties -- Compatible with an earlier version of this standard.
|
||||||
|
- CryptoPunks -- Partially ERC-20 compatible, but not easily generalizable because it includes auction functionality directly in the contract and uses function names that explicitly refer to the assets as "punks".
|
||||||
|
- Auctionhouse Asset Interface -- The author needed a generic interface for the Auctionhouse ÐApp (currently ice-boxed). His "Asset" contract is very simple, but is missing ERC-20 compatibility, `approve()` functionality, and metadata. This effort is referenced in the discussion for EIP-173.
|
||||||
|
|
||||||
|
Note: "Limited edition, collectible tokens" like Curio Cards and Rare Pepe are *not* distinguishable assets. They're actually a collection of individual fungible tokens, each of which is tracked by its own smart contract with its own total supply (which may be `1` in extreme cases).
|
||||||
|
|
||||||
|
The `onERC721Received` function specifically works around old deployed contracts which may inadvertently return 1 (`true`) in certain circumstances even if they don't implement a function (see Solidity DelegateCallReturnValue bug). By returning and checking for a magic value, we are able to distinguish actual affirmative responses versus these vacuous `true`s.
|
||||||
|
|
||||||
|
## Test Cases
|
||||||
|
|
||||||
|
0xcert ERC-721 Token includes test cases written using Truffle.
|
||||||
|
|
||||||
|
## Implementations
|
||||||
|
|
||||||
|
0xcert ERC721 -- a reference implementation
|
||||||
|
|
||||||
|
- MIT licensed, so you can freely use it for your projects
|
||||||
|
- Includes test cases
|
||||||
|
- Active bug bounty, you will be paid if you find errors
|
||||||
|
|
||||||
|
Su Squares -- an advertising platform where you can rent space and place images
|
||||||
|
|
||||||
|
- Complete the Su Squares Bug Bounty Program to seek problems with this standard or its implementation
|
||||||
|
- Implements the complete standard and all optional interfaces
|
||||||
|
|
||||||
|
ERC721ExampleDeed -- an example implementation
|
||||||
|
|
||||||
|
- Implements using the OpenZeppelin project format
|
||||||
|
|
||||||
|
XXXXERC721, by William Entriken -- a scalable example implementation
|
||||||
|
|
||||||
|
- Deployed on testnet with 1 billion assets and supporting all lookups with the metadata extension. This demonstrates that scaling is NOT a problem.
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
**Standards**
|
||||||
|
|
||||||
|
1. [ERC-20](./eip-20.md) Token Standard.
|
||||||
|
1. [ERC-165](./eip-165.md) Standard Interface Detection.
|
||||||
|
1. [ERC-173](./eip-173.md) Owned Standard.
|
||||||
|
1. [ERC-223](https://github.com/ethereum/EIPs/issues/223) Token Standard.
|
||||||
|
1. [ERC-677](https://github.com/ethereum/EIPs/issues/677) `transferAndCall` Token Standard.
|
||||||
|
1. [ERC-827](https://github.com/ethereum/EIPs/issues/827) Token Standard.
|
||||||
|
1. Ethereum Name Service (ENS). https://ens.domains
|
||||||
|
1. Instagram -- What's the Image Resolution? https://help.instagram.com/1631821640426723
|
||||||
|
1. JSON Schema. https://json-schema.org/
|
||||||
|
1. Multiaddr. https://github.com/multiformats/multiaddr
|
||||||
|
1. RFC 2119 Key words for use in RFCs to Indicate Requirement Levels. https://www.ietf.org/rfc/rfc2119.txt
|
||||||
|
|
||||||
|
**Issues**
|
||||||
|
|
||||||
|
1. The Original ERC-721 Issue. https://github.com/ethereum/eips/issues/721
|
||||||
|
1. Solidity Issue \#2330 -- Interface Functions are External. https://github.com/ethereum/solidity/issues/2330
|
||||||
|
1. Solidity Issue \#3412 -- Implement Interface: Allow Stricter Mutability. https://github.com/ethereum/solidity/issues/3412
|
||||||
|
1. Solidity Issue \#3419 -- Interfaces Can't Inherit. https://github.com/ethereum/solidity/issues/3419
|
||||||
|
1. Solidity Issue \#3494 -- Compiler Incorrectly Reasons About the `selector` Function. https://github.com/ethereum/solidity/issues/3494
|
||||||
|
1. Solidity Issue \#3544 -- Cannot Calculate Selector of Function Named `transfer`. https://github.com/ethereum/solidity/issues/3544
|
||||||
|
1. CryptoKitties Bounty Issue \#4 -- Listing all Kitties Owned by a User is `O(n^2)`. https://github.com/axiomzen/cryptokitties-bounty/issues/4
|
||||||
|
1. OpenZeppelin Issue \#438 -- Implementation of `approve` method violates ERC20 standard. https://github.com/OpenZeppelin/zeppelin-solidity/issues/438
|
||||||
|
1. Solidity DelegateCallReturnValue Bug. https://solidity.readthedocs.io/en/develop/bugs.html#DelegateCallReturnValue
|
||||||
|
|
||||||
|
**Discussions**
|
||||||
|
|
||||||
|
1. Reddit (announcement of first live discussion). https://www.reddit.com/r/ethereum/comments/7r2ena/friday_119_live_discussion_on_erc_nonfungible/
|
||||||
|
1. Gitter #EIPs (announcement of first live discussion). https://gitter.im/ethereum/EIPs?at=5a5f823fb48e8c3566f0a5e7
|
||||||
|
1. ERC-721 (announcement of first live discussion). https://github.com/ethereum/eips/issues/721#issuecomment-358369377
|
||||||
|
1. ETHDenver 2018. https://ethdenver.com
|
||||||
|
|
||||||
|
**NFT Implementations and Other Projects**
|
||||||
|
|
||||||
|
1. CryptoKitties. https://www.cryptokitties.co
|
||||||
|
1. 0xcert ERC-721 Token. https://github.com/0xcert/ethereum-erc721
|
||||||
|
1. Su Squares. https://tenthousandsu.com
|
||||||
|
1. Decentraland. https://decentraland.org
|
||||||
|
1. CryptoPunks. https://www.larvalabs.com/cryptopunks
|
||||||
|
1. DMarket. https://www.dmarket.io
|
||||||
|
1. Enjin Coin. https://enjincoin.io
|
||||||
|
1. Ubitquity. https://www.ubitquity.io
|
||||||
|
1. Propy. https://tokensale.propy.com
|
||||||
|
1. CryptoKitties Deployed Contract. https://etherscan.io/address/0x06012c8cf97bead5deae237070f9587f8e7a266d#code
|
||||||
|
1. Su Squares Bug Bounty Program. https://github.com/fulldecent/su-squares-bounty
|
||||||
|
1. XXXXERC721. https://github.com/fulldecent/erc721-example
|
||||||
|
1. ERC721ExampleDeed. https://github.com/nastassiasachs/ERC721ExampleDeed
|
||||||
|
1. Curio Cards. https://mycuriocards.com
|
||||||
|
1. Rare Pepe. https://rarepepewallet.com
|
||||||
|
1. Auctionhouse Asset Interface. https://github.com/dob/auctionhouse/blob/master/contracts/Asset.sol
|
||||||
|
1. OpenZeppelin SafeERC20.sol Implementation. https://github.com/OpenZeppelin/zeppelin-solidity/blob/master/contracts/token/ERC20/SafeERC20.sol
|
||||||
|
|
||||||
|
## Copyright
|
||||||
|
|
||||||
|
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
|
Loading…
Reference in New Issue
Block a user