diff --git a/.changeset/smooth-dodos-exist.md b/.changeset/smooth-dodos-exist.md
new file mode 100644
index 0000000..f85a36d
--- /dev/null
+++ b/.changeset/smooth-dodos-exist.md
@@ -0,0 +1,5 @@
+---
+"reverse-mirage": patch
+---
+
+Support weth, erc1155, erc721
diff --git a/contracts/src/ERC1155.sol b/contracts/src/ERC1155.sol
new file mode 100644
index 0000000..21fce98
--- /dev/null
+++ b/contracts/src/ERC1155.sol
@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+pragma solidity >=0.8.0;
+
+import {solmateERC1155} from "./solmateERC1155.sol";
+
+contract ERC1155 is solmateERC1155 {
+ string private baseURI;
+
+ constructor(string memory _baseURI) {
+ baseURI = _baseURI;
+ }
+
+ function mint(address to, uint256 id, uint256 amount, bytes memory data) external {
+ _mint(to, id, amount, data);
+ }
+
+ function burn(address from, uint256 id, uint256 amount) external {
+ _burn(from, id, amount);
+ }
+
+ function uri(uint256) public view virtual override returns (string memory) {
+ return baseURI;
+ }
+}
diff --git a/contracts/src/ERC721.sol b/contracts/src/ERC721.sol
new file mode 100644
index 0000000..f84d286
--- /dev/null
+++ b/contracts/src/ERC721.sol
@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+pragma solidity >=0.8.0;
+
+import {solmateERC721} from "./solmateERC721.sol";
+
+contract ERC721 is solmateERC721 {
+ string private baseTokenURI;
+
+ constructor(string memory _name, string memory _symbol, string memory _baseTokenURI)
+ solmateERC721(_name, _symbol)
+ {
+ baseTokenURI = _baseTokenURI;
+ }
+
+ function mint(address to, uint256 id) external {
+ _mint(to, id);
+ }
+
+ function burn(uint256 id) external {
+ _burn(id);
+ }
+
+ function tokenURI(uint256) public view virtual override returns (string memory) {
+ return baseTokenURI;
+ }
+}
diff --git a/contracts/src/ERC721MaxBalance.sol b/contracts/src/ERC721MaxBalance.sol
new file mode 100644
index 0000000..3f07a50
--- /dev/null
+++ b/contracts/src/ERC721MaxBalance.sol
@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+pragma solidity >=0.8.0;
+
+import {solmateERC721} from "./solmateERC721.sol";
+
+contract ERC721MaxBalance is solmateERC721 {
+ string private baseTokenURI;
+
+ constructor(string memory _name, string memory _symbol, string memory _baseTokenURI)
+ solmateERC721(_name, _symbol)
+ {
+ baseTokenURI = _baseTokenURI;
+ }
+
+ function tokenURI(uint256) public view virtual override returns (string memory) {
+ return baseTokenURI;
+ }
+
+ function balanceOf(address) public view virtual override returns (uint256) {
+ return 2 ** 53;
+ }
+}
diff --git a/contracts/src/WETH9.sol b/contracts/src/WETH9.sol
new file mode 100644
index 0000000..bc1129d
--- /dev/null
+++ b/contracts/src/WETH9.sol
@@ -0,0 +1,758 @@
+/**
+ * Submitted for verification at Etherscan.io on 2017-12-12
+ */
+
+// Copyright (C) 2015, 2016, 2017 Dapphub
+
+// 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 .
+
+pragma solidity ^0.4.18;
+
+contract WETH9 {
+ string public name = "Wrapped Ether";
+ string public symbol = "WETH";
+ uint8 public decimals = 18;
+
+ event Approval(address indexed src, address indexed guy, uint256 wad);
+ event Transfer(address indexed src, address indexed dst, uint256 wad);
+ event Deposit(address indexed dst, uint256 wad);
+ event Withdrawal(address indexed src, uint256 wad);
+
+ mapping(address => uint256) public balanceOf;
+ mapping(address => mapping(address => uint256)) public allowance;
+
+ function() public payable {
+ deposit();
+ }
+
+ function deposit() public payable {
+ balanceOf[msg.sender] += msg.value;
+ Deposit(msg.sender, msg.value);
+ }
+
+ function withdraw(uint256 wad) public {
+ require(balanceOf[msg.sender] >= wad);
+ balanceOf[msg.sender] -= wad;
+ msg.sender.transfer(wad);
+ Withdrawal(msg.sender, wad);
+ }
+
+ function totalSupply() public view returns (uint256) {
+ return this.balance;
+ }
+
+ function approve(address guy, uint256 wad) public returns (bool) {
+ allowance[msg.sender][guy] = wad;
+ Approval(msg.sender, guy, wad);
+ return true;
+ }
+
+ function transfer(address dst, uint256 wad) public returns (bool) {
+ return transferFrom(msg.sender, dst, wad);
+ }
+
+ function transferFrom(address src, address dst, uint256 wad) public returns (bool) {
+ require(balanceOf[src] >= wad);
+
+ if (src != msg.sender && allowance[src][msg.sender] != uint256(-1)) {
+ require(allowance[src][msg.sender] >= wad);
+ allowance[src][msg.sender] -= wad;
+ }
+
+ balanceOf[src] -= wad;
+ balanceOf[dst] += wad;
+
+ Transfer(src, dst, wad);
+
+ return true;
+ }
+}
+
+/*
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ 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.
+
+
+ Copyright (C)
+
+ 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 .
+
+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:
+
+ Copyright (C)
+ 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
+.
+
+ 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
+.
+
+*/
diff --git a/contracts/src/solmateERC1155.sol b/contracts/src/solmateERC1155.sol
new file mode 100644
index 0000000..dd9dfcf
--- /dev/null
+++ b/contracts/src/solmateERC1155.sol
@@ -0,0 +1,222 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+pragma solidity >=0.8.0;
+
+/// @notice Minimalist and gas efficient standard ERC1155 implementation.
+/// @author Solmate (https://github.com/transmissions11/solmate/blob/main/src/tokens/ERC1155.sol)
+abstract contract solmateERC1155 {
+ /*//////////////////////////////////////////////////////////////
+ EVENTS
+ //////////////////////////////////////////////////////////////*/
+
+ event TransferSingle(
+ address indexed operator, address indexed from, address indexed to, uint256 id, uint256 amount
+ );
+
+ event TransferBatch(
+ address indexed operator, address indexed from, address indexed to, uint256[] ids, uint256[] amounts
+ );
+
+ event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
+
+ event URI(string value, uint256 indexed id);
+
+ /*//////////////////////////////////////////////////////////////
+ ERC1155 STORAGE
+ //////////////////////////////////////////////////////////////*/
+
+ mapping(address => mapping(uint256 => uint256)) public balanceOf;
+
+ mapping(address => mapping(address => bool)) public isApprovedForAll;
+
+ /*//////////////////////////////////////////////////////////////
+ METADATA LOGIC
+ //////////////////////////////////////////////////////////////*/
+
+ function uri(uint256 id) public view virtual returns (string memory);
+
+ /*//////////////////////////////////////////////////////////////
+ ERC1155 LOGIC
+ //////////////////////////////////////////////////////////////*/
+
+ function setApprovalForAll(address operator, bool approved) public virtual {
+ isApprovedForAll[msg.sender][operator] = approved;
+
+ emit ApprovalForAll(msg.sender, operator, approved);
+ }
+
+ function safeTransferFrom(address from, address to, uint256 id, uint256 amount, bytes calldata data)
+ public
+ virtual
+ {
+ require(msg.sender == from || isApprovedForAll[from][msg.sender], "NOT_AUTHORIZED");
+
+ balanceOf[from][id] -= amount;
+ balanceOf[to][id] += amount;
+
+ emit TransferSingle(msg.sender, from, to, id, amount);
+
+ require(
+ to.code.length == 0
+ ? to != address(0)
+ : ERC1155TokenReceiver(to).onERC1155Received(msg.sender, from, id, amount, data)
+ == ERC1155TokenReceiver.onERC1155Received.selector,
+ "UNSAFE_RECIPIENT"
+ );
+ }
+
+ function safeBatchTransferFrom(
+ address from,
+ address to,
+ uint256[] calldata ids,
+ uint256[] calldata amounts,
+ bytes calldata data
+ ) public virtual {
+ require(ids.length == amounts.length, "LENGTH_MISMATCH");
+
+ require(msg.sender == from || isApprovedForAll[from][msg.sender], "NOT_AUTHORIZED");
+
+ // Storing these outside the loop saves ~15 gas per iteration.
+ uint256 id;
+ uint256 amount;
+
+ for (uint256 i = 0; i < ids.length;) {
+ id = ids[i];
+ amount = amounts[i];
+
+ balanceOf[from][id] -= amount;
+ balanceOf[to][id] += amount;
+
+ // An array can't have a total length
+ // larger than the max uint256 value.
+ unchecked {
+ ++i;
+ }
+ }
+
+ emit TransferBatch(msg.sender, from, to, ids, amounts);
+
+ require(
+ to.code.length == 0
+ ? to != address(0)
+ : ERC1155TokenReceiver(to).onERC1155BatchReceived(msg.sender, from, ids, amounts, data)
+ == ERC1155TokenReceiver.onERC1155BatchReceived.selector,
+ "UNSAFE_RECIPIENT"
+ );
+ }
+
+ function balanceOfBatch(address[] calldata owners, uint256[] calldata ids)
+ public
+ view
+ virtual
+ returns (uint256[] memory balances)
+ {
+ require(owners.length == ids.length, "LENGTH_MISMATCH");
+
+ balances = new uint256[](owners.length);
+
+ // Unchecked because the only math done is incrementing
+ // the array index counter which cannot possibly overflow.
+ unchecked {
+ for (uint256 i = 0; i < owners.length; ++i) {
+ balances[i] = balanceOf[owners[i]][ids[i]];
+ }
+ }
+ }
+
+ /*//////////////////////////////////////////////////////////////
+ ERC165 LOGIC
+ //////////////////////////////////////////////////////////////*/
+
+ function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
+ return interfaceId == 0x01ffc9a7 // ERC165 Interface ID for ERC165
+ || interfaceId == 0xd9b67a26 // ERC165 Interface ID for ERC1155
+ || interfaceId == 0x0e89341c; // ERC165 Interface ID for ERC1155MetadataURI
+ }
+
+ /*//////////////////////////////////////////////////////////////
+ INTERNAL MINT/BURN LOGIC
+ //////////////////////////////////////////////////////////////*/
+
+ function _mint(address to, uint256 id, uint256 amount, bytes memory data) internal virtual {
+ balanceOf[to][id] += amount;
+
+ emit TransferSingle(msg.sender, address(0), to, id, amount);
+
+ require(
+ to.code.length == 0
+ ? to != address(0)
+ : ERC1155TokenReceiver(to).onERC1155Received(msg.sender, address(0), id, amount, data)
+ == ERC1155TokenReceiver.onERC1155Received.selector,
+ "UNSAFE_RECIPIENT"
+ );
+ }
+
+ function _batchMint(address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data)
+ internal
+ virtual
+ {
+ uint256 idsLength = ids.length; // Saves MLOADs.
+
+ require(idsLength == amounts.length, "LENGTH_MISMATCH");
+
+ for (uint256 i = 0; i < idsLength;) {
+ balanceOf[to][ids[i]] += amounts[i];
+
+ // An array can't have a total length
+ // larger than the max uint256 value.
+ unchecked {
+ ++i;
+ }
+ }
+
+ emit TransferBatch(msg.sender, address(0), to, ids, amounts);
+
+ require(
+ to.code.length == 0
+ ? to != address(0)
+ : ERC1155TokenReceiver(to).onERC1155BatchReceived(msg.sender, address(0), ids, amounts, data)
+ == ERC1155TokenReceiver.onERC1155BatchReceived.selector,
+ "UNSAFE_RECIPIENT"
+ );
+ }
+
+ function _batchBurn(address from, uint256[] memory ids, uint256[] memory amounts) internal virtual {
+ uint256 idsLength = ids.length; // Saves MLOADs.
+
+ require(idsLength == amounts.length, "LENGTH_MISMATCH");
+
+ for (uint256 i = 0; i < idsLength;) {
+ balanceOf[from][ids[i]] -= amounts[i];
+
+ // An array can't have a total length
+ // larger than the max uint256 value.
+ unchecked {
+ ++i;
+ }
+ }
+
+ emit TransferBatch(msg.sender, from, address(0), ids, amounts);
+ }
+
+ function _burn(address from, uint256 id, uint256 amount) internal virtual {
+ balanceOf[from][id] -= amount;
+
+ emit TransferSingle(msg.sender, from, address(0), id, amount);
+ }
+}
+
+/// @notice A generic interface for a contract which properly accepts ERC1155 tokens.
+/// @author Solmate (https://github.com/transmissions11/solmate/blob/main/src/tokens/ERC1155.sol)
+abstract contract ERC1155TokenReceiver {
+ function onERC1155Received(address, address, uint256, uint256, bytes calldata) external virtual returns (bytes4) {
+ return ERC1155TokenReceiver.onERC1155Received.selector;
+ }
+
+ function onERC1155BatchReceived(address, address, uint256[] calldata, uint256[] calldata, bytes calldata)
+ external
+ virtual
+ returns (bytes4)
+ {
+ return ERC1155TokenReceiver.onERC1155BatchReceived.selector;
+ }
+}
diff --git a/contracts/src/solmateERC721.sol b/contracts/src/solmateERC721.sol
new file mode 100644
index 0000000..6364cf9
--- /dev/null
+++ b/contracts/src/solmateERC721.sol
@@ -0,0 +1,207 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+pragma solidity >=0.8.0;
+
+/// @notice Modern, minimalist, and gas efficient ERC-721 implementation.
+/// @author Solmate (https://github.com/transmissions11/solmate/blob/main/src/tokens/ERC721.sol)
+abstract contract solmateERC721 {
+ /*//////////////////////////////////////////////////////////////
+ EVENTS
+ //////////////////////////////////////////////////////////////*/
+
+ event Transfer(address indexed from, address indexed to, uint256 indexed id);
+
+ event Approval(address indexed owner, address indexed spender, uint256 indexed id);
+
+ event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
+
+ /*//////////////////////////////////////////////////////////////
+ METADATA STORAGE/LOGIC
+ //////////////////////////////////////////////////////////////*/
+
+ string public name;
+
+ string public symbol;
+
+ function tokenURI(uint256 id) public view virtual returns (string memory);
+
+ /*//////////////////////////////////////////////////////////////
+ ERC721 BALANCE/OWNER STORAGE
+ //////////////////////////////////////////////////////////////*/
+
+ mapping(uint256 => address) internal _ownerOf;
+
+ mapping(address => uint256) internal _balanceOf;
+
+ function ownerOf(uint256 id) public view virtual returns (address owner) {
+ require((owner = _ownerOf[id]) != address(0), "NOT_MINTED");
+ }
+
+ function balanceOf(address owner) public view virtual returns (uint256) {
+ require(owner != address(0), "ZERO_ADDRESS");
+
+ return _balanceOf[owner];
+ }
+
+ /*//////////////////////////////////////////////////////////////
+ ERC721 APPROVAL STORAGE
+ //////////////////////////////////////////////////////////////*/
+
+ mapping(uint256 => address) public getApproved;
+
+ mapping(address => mapping(address => bool)) public isApprovedForAll;
+
+ /*//////////////////////////////////////////////////////////////
+ CONSTRUCTOR
+ //////////////////////////////////////////////////////////////*/
+
+ constructor(string memory _name, string memory _symbol) {
+ name = _name;
+ symbol = _symbol;
+ }
+
+ /*//////////////////////////////////////////////////////////////
+ ERC721 LOGIC
+ //////////////////////////////////////////////////////////////*/
+
+ function approve(address spender, uint256 id) public virtual {
+ address owner = _ownerOf[id];
+
+ require(msg.sender == owner || isApprovedForAll[owner][msg.sender], "NOT_AUTHORIZED");
+
+ getApproved[id] = spender;
+
+ emit Approval(owner, spender, id);
+ }
+
+ function setApprovalForAll(address operator, bool approved) public virtual {
+ isApprovedForAll[msg.sender][operator] = approved;
+
+ emit ApprovalForAll(msg.sender, operator, approved);
+ }
+
+ function transferFrom(address from, address to, uint256 id) public virtual {
+ require(from == _ownerOf[id], "WRONG_FROM");
+
+ require(to != address(0), "INVALID_RECIPIENT");
+
+ require(
+ msg.sender == from || isApprovedForAll[from][msg.sender] || msg.sender == getApproved[id], "NOT_AUTHORIZED"
+ );
+
+ // Underflow of the sender's balance is impossible because we check for
+ // ownership above and the recipient's balance can't realistically overflow.
+ unchecked {
+ _balanceOf[from]--;
+
+ _balanceOf[to]++;
+ }
+
+ _ownerOf[id] = to;
+
+ delete getApproved[id];
+
+ emit Transfer(from, to, id);
+ }
+
+ function safeTransferFrom(address from, address to, uint256 id) public virtual {
+ transferFrom(from, to, id);
+
+ require(
+ to.code.length == 0
+ || ERC721TokenReceiver(to).onERC721Received(msg.sender, from, id, "")
+ == ERC721TokenReceiver.onERC721Received.selector,
+ "UNSAFE_RECIPIENT"
+ );
+ }
+
+ function safeTransferFrom(address from, address to, uint256 id, bytes calldata data) public virtual {
+ transferFrom(from, to, id);
+
+ require(
+ to.code.length == 0
+ || ERC721TokenReceiver(to).onERC721Received(msg.sender, from, id, data)
+ == ERC721TokenReceiver.onERC721Received.selector,
+ "UNSAFE_RECIPIENT"
+ );
+ }
+
+ /*//////////////////////////////////////////////////////////////
+ ERC165 LOGIC
+ //////////////////////////////////////////////////////////////*/
+
+ function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
+ return interfaceId == 0x01ffc9a7 // ERC165 Interface ID for ERC165
+ || interfaceId == 0x80ac58cd // ERC165 Interface ID for ERC721
+ || interfaceId == 0x5b5e139f; // ERC165 Interface ID for ERC721Metadata
+ }
+
+ /*//////////////////////////////////////////////////////////////
+ INTERNAL MINT/BURN LOGIC
+ //////////////////////////////////////////////////////////////*/
+
+ function _mint(address to, uint256 id) internal virtual {
+ require(to != address(0), "INVALID_RECIPIENT");
+
+ require(_ownerOf[id] == address(0), "ALREADY_MINTED");
+
+ // Counter overflow is incredibly unrealistic.
+ unchecked {
+ _balanceOf[to]++;
+ }
+
+ _ownerOf[id] = to;
+
+ emit Transfer(address(0), to, id);
+ }
+
+ function _burn(uint256 id) internal virtual {
+ address owner = _ownerOf[id];
+
+ require(owner != address(0), "NOT_MINTED");
+
+ // Ownership check above ensures no underflow.
+ unchecked {
+ _balanceOf[owner]--;
+ }
+
+ delete _ownerOf[id];
+
+ delete getApproved[id];
+
+ emit Transfer(owner, address(0), id);
+ }
+
+ /*//////////////////////////////////////////////////////////////
+ INTERNAL SAFE MINT LOGIC
+ //////////////////////////////////////////////////////////////*/
+
+ function _safeMint(address to, uint256 id) internal virtual {
+ _mint(to, id);
+
+ require(
+ to.code.length == 0
+ || ERC721TokenReceiver(to).onERC721Received(msg.sender, address(0), id, "")
+ == ERC721TokenReceiver.onERC721Received.selector,
+ "UNSAFE_RECIPIENT"
+ );
+ }
+
+ function _safeMint(address to, uint256 id, bytes memory data) internal virtual {
+ _mint(to, id);
+
+ require(
+ to.code.length == 0
+ || ERC721TokenReceiver(to).onERC721Received(msg.sender, address(0), id, data)
+ == ERC721TokenReceiver.onERC721Received.selector,
+ "UNSAFE_RECIPIENT"
+ );
+ }
+}
+
+/// @notice A generic interface for a contract which properly accepts ERC721 tokens.
+/// @author Solmate (https://github.com/transmissions11/solmate/blob/main/src/tokens/ERC721.sol)
+abstract contract ERC721TokenReceiver {
+ function onERC721Received(address, address, uint256, bytes calldata) external virtual returns (bytes4) {
+ return ERC721TokenReceiver.onERC721Received.selector;
+ }
+}
diff --git a/examples/next-interface/hooks/useSetup.ts b/examples/next-interface/hooks/useSetup.ts
index b40a7bd..233985b 100644
--- a/examples/next-interface/hooks/useSetup.ts
+++ b/examples/next-interface/hooks/useSetup.ts
@@ -2,7 +2,7 @@ import { ALICE } from "@/constants";
import { useEnvironment } from "@/contexts/environment";
import { testClient, walletClient } from "@/pages/_app";
import { useMutation, useQueryClient } from "@tanstack/react-query";
-import { createErc20 } from "reverse-mirage";
+import { createERC20 } from "reverse-mirage";
import invariant from "tiny-invariant";
import { type Hex, parseEther } from "viem";
import { useChainId, usePublicClient } from "wagmi";
@@ -32,7 +32,7 @@ export const useSetup = () => {
invariant(contractAddress);
setToken({
- ...createErc20(contractAddress, "Mock ERC", "MOCK", 18, chainID),
+ ...createERC20(contractAddress, "Mock ERC", "MOCK", 18, chainID),
logoURI:
"https://assets.coingecko.com/coins/images/23784/small/mri.png?1647693409",
});
diff --git a/packages/core/package.json b/packages/core/package.json
index 201c918..36d45ba 100644
--- a/packages/core/package.json
+++ b/packages/core/package.json
@@ -26,12 +26,7 @@
"test:ci": "CI=true vitest --coverage",
"test:cov": "vitest --coverage"
},
- "keywords": [
- "eth",
- "ethereum",
- "dapps",
- "web3"
- ],
+ "keywords": ["eth", "ethereum", "dapps", "web3"],
"author": "Kyle Scott",
"license": "MIT",
"repository": "kyscott18/reverse-mirage",
@@ -42,19 +37,6 @@
"default": "./dist/index.cjs"
}
},
- "size-limit": [
- {
- "name": "reverse-mirage (cjs)",
- "path": "./dist/index.cjs",
- "limit": "25 kB"
- },
- {
- "name": "reverse-mirage",
- "path": "./dist/index.js",
- "limit": "20 kB",
- "import": "*"
- }
- ],
"dependencies": {
"tiny-invariant": "^1.3.1"
},
diff --git a/packages/core/src/_test/constants.ts b/packages/core/src/_test/constants.ts
index 35adb1e..a33dde5 100644
--- a/packages/core/src/_test/constants.ts
+++ b/packages/core/src/_test/constants.ts
@@ -14,8 +14,6 @@ export const [ALICE, BOB] = ACCOUNTS;
export const mockToken = {
type: "token",
chainID: foundry.id,
- name: "Mock ERC20",
- symbol: "MOCK",
} as const satisfies Token;
export const anvilEther = {
diff --git a/packages/core/src/amountUtils.bench.ts b/packages/core/src/amountUtils.bench.ts
index 842c8f5..d62532e 100644
--- a/packages/core/src/amountUtils.bench.ts
+++ b/packages/core/src/amountUtils.bench.ts
@@ -22,8 +22,8 @@ const uniswapMockERC20 = new UniswapToken(
mockToken.chainID,
zeroAddress,
18,
- mockToken.name,
- mockToken.symbol,
+ "name",
+ "symbol",
);
const rmAmount = createAmountFromString(mockToken, "52");
const uniAmount = UniswapCurrencyAmount.fromFractionalAmount(
diff --git a/packages/core/src/amountUtils.test.ts b/packages/core/src/amountUtils.test.ts
index 2992130..2b6263a 100644
--- a/packages/core/src/amountUtils.test.ts
+++ b/packages/core/src/amountUtils.test.ts
@@ -18,15 +18,11 @@ import type { Token, TokenData } from "./types.js";
const mockToken = {
type: "token",
- name: "mock token",
- symbol: "mt",
chainID: 1,
} as const satisfies Token;
const mockTokenDecimals = {
type: "token",
- name: "mock token decimals",
- symbol: "mtd",
decimals: 18,
chainID: 1,
} as const satisfies Token & { decimals: number };
diff --git a/packages/core/src/erc1155/reads.test.ts b/packages/core/src/erc1155/reads.test.ts
new file mode 100644
index 0000000..384ae62
--- /dev/null
+++ b/packages/core/src/erc1155/reads.test.ts
@@ -0,0 +1,100 @@
+import invariant from "tiny-invariant";
+import { type Hex, getAddress } from "viem";
+import { foundry } from "viem/chains";
+import { beforeEach, describe, expect, test } from "vitest";
+import ERC1155Bytecode from "../../../../contracts/out/ERC1155.sol/ERC1155.json";
+import { ALICE, BOB } from "../_test/constants.js";
+import { publicClient, testClient, walletClient } from "../_test/utils.js";
+import { erc1155ABI } from "../generated.js";
+import { readAndParse } from "../readUtils.js";
+import {
+ erc1155BalanceOf,
+ erc1155IsApprovedForAll,
+ erc1155URI,
+ getERC1155,
+} from "./reads.js";
+import type { ERC1155 } from "./types.js";
+import { createERC1155 } from "./utils.js";
+import { erc1155SetApprovalForAll } from "./writes.js";
+
+let id: Hex | undefined = undefined;
+
+let erc1155: ERC1155;
+
+beforeEach(async () => {
+ if (id === undefined) {
+ const deployHash = await walletClient.deployContract({
+ abi: erc1155ABI,
+ bytecode: ERC1155Bytecode.bytecode.object as Hex,
+ args: ["https://mitch.com"],
+ });
+
+ const { contractAddress } = await publicClient.waitForTransactionReceipt({
+ hash: deployHash,
+ });
+ invariant(contractAddress);
+ erc1155 = createERC1155(
+ contractAddress,
+ 0n,
+ "https://mitch.com",
+ foundry.id,
+ );
+
+ const mintHash = await walletClient.writeContract({
+ abi: erc1155ABI,
+ functionName: "mint",
+ address: getAddress(contractAddress!),
+ args: [ALICE, 0n, 10n, "0x"],
+ });
+ await publicClient.waitForTransactionReceipt({ hash: mintHash });
+
+ const { hash } = await erc1155SetApprovalForAll(
+ publicClient,
+ walletClient,
+ ALICE,
+ {
+ erc1155,
+ spender: BOB,
+ approved: true,
+ },
+ );
+ await publicClient.waitForTransactionReceipt({ hash });
+ } else {
+ await testClient.revert({ id });
+ }
+
+ id = await testClient.snapshot();
+});
+
+describe("erc1155 reads", async () => {
+ test("isApprovedForAll", async () => {
+ const isApprovedForAll = await readAndParse(
+ publicClient,
+ erc1155IsApprovedForAll({ erc1155, owner: ALICE, spender: BOB }),
+ );
+
+ expect(isApprovedForAll).toBe(true);
+ });
+
+ test("uri", async () => {
+ const uri = await readAndParse(publicClient, erc1155URI({ erc1155 }));
+
+ expect(uri).toBe("https://mitch.com");
+ });
+
+ test("balanceOf", async () => {
+ const balance = await readAndParse(
+ publicClient,
+ erc1155BalanceOf({ erc1155, owner: ALICE }),
+ );
+
+ expect(balance.amount).toBe(10n);
+ expect(balance.token).toBe(erc1155);
+ });
+
+ test("getERC1155", async () => {
+ expect(
+ await readAndParse(publicClient, getERC1155({ erc1155 })),
+ ).toStrictEqual(erc1155);
+ });
+});
diff --git a/packages/core/src/erc1155/reads.ts b/packages/core/src/erc1155/reads.ts
new file mode 100644
index 0000000..0f87e24
--- /dev/null
+++ b/packages/core/src/erc1155/reads.ts
@@ -0,0 +1,71 @@
+import type { Address, PublicClient } from "viem";
+import { solmateErc1155ABI } from "../generated.js";
+import type { ReverseMirageRead } from "../types.js";
+import type { ERC1155, ERC1155Data } from "./types.js";
+import { createERC1155, createERC1155Data } from "./utils.js";
+
+export const erc1155IsApprovedForAll = (args: {
+ erc1155: Pick;
+ owner: Address;
+ spender: Address;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateErc1155ABI,
+ address: args.erc1155.address,
+ functionName: "isApprovedForAll",
+ args: [args.owner, args.spender],
+ }),
+ parse: (data) => data,
+ }) as const satisfies ReverseMirageRead;
+
+export const erc1155URI = (args: {
+ erc1155: Pick;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateErc1155ABI,
+ address: args.erc1155.address,
+ functionName: "uri",
+ args: [args.erc1155.id],
+ }),
+ parse: (data) => data,
+ }) as const satisfies ReverseMirageRead;
+
+export const erc1155BalanceOf = (args: {
+ erc1155: TERC1155;
+ owner: Address;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateErc1155ABI,
+ address: args.erc1155.address,
+ functionName: "balanceOf",
+ args: [args.owner, args.erc1155.id],
+ }),
+ parse: (data): ERC1155Data =>
+ createERC1155Data(args.erc1155, data),
+ }) as const satisfies ReverseMirageRead;
+
+export const getERC1155 = (args: {
+ erc1155: Pick;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateErc1155ABI,
+ address: args.erc1155.address,
+ functionName: "uri",
+ args: [args.erc1155.id],
+ }),
+ parse: (data): ERC1155 =>
+ createERC1155(
+ args.erc1155.address,
+ args.erc1155.id,
+ data,
+ args.erc1155.chainID,
+ ),
+ }) as const satisfies ReverseMirageRead;
diff --git a/packages/core/src/erc1155/types.ts b/packages/core/src/erc1155/types.ts
new file mode 100644
index 0000000..6e5c866
--- /dev/null
+++ b/packages/core/src/erc1155/types.ts
@@ -0,0 +1,14 @@
+import type { Address } from "viem";
+import type { Amount } from "../amountUtils.js";
+import type { Token } from "../types.js";
+
+export type ERC1155 = Token<"erc1155"> & {
+ address: Address;
+ id: bigint;
+ uri: string;
+};
+
+export type ERC1155Data = Amount<
+ TERC1155,
+ `${TERC1155["type"]}Data`
+>;
diff --git a/packages/core/src/erc1155/utils.test.ts b/packages/core/src/erc1155/utils.test.ts
new file mode 100644
index 0000000..6b9b862
--- /dev/null
+++ b/packages/core/src/erc1155/utils.test.ts
@@ -0,0 +1,28 @@
+import { zeroAddress } from "viem";
+import { foundry } from "viem/chains";
+import { describe, expect, test } from "vitest";
+import { createERC1155, createERC1155Data } from "./utils.js";
+
+const erc1155 = {
+ type: "erc1155",
+ address: zeroAddress,
+ id: 0n,
+ uri: "https://mitch.com",
+ chainID: foundry.id,
+} as const;
+
+describe("utils", () => {
+ test("can create erc1155", () => {
+ expect(
+ createERC1155(zeroAddress, 0n, "https://mitch.com", foundry.id),
+ ).toStrictEqual(erc1155);
+ });
+
+ test("can create erc1155 data", () => {
+ const data = createERC1155Data(erc1155, 10n);
+
+ expect(data.token).toBe(erc1155);
+ expect(data.amount).toBe(10n);
+ expect(data.type).toBe("erc1155Data");
+ });
+});
diff --git a/packages/core/src/erc1155/utils.ts b/packages/core/src/erc1155/utils.ts
new file mode 100644
index 0000000..44f3159
--- /dev/null
+++ b/packages/core/src/erc1155/utils.ts
@@ -0,0 +1,30 @@
+import { type Address, getAddress } from "viem";
+import type { ERC1155, ERC1155Data } from "./types.js";
+
+/**
+ * Creates an {@link ERC1155}
+ */
+export const createERC1155 = (
+ address: Address,
+ id: bigint,
+ uri: string,
+ chainID: number,
+): ERC1155 => ({
+ type: "erc1155",
+ address: getAddress(address),
+ id,
+ uri,
+ chainID,
+});
+
+/**
+ * Creates an {@link ERC1155Data}
+ */
+export const createERC1155Data = (
+ erc1155: TERC1155,
+ amount: bigint,
+): ERC1155Data => ({
+ type: `${erc1155.type as TERC1155["type"]}Data`,
+ token: erc1155,
+ amount,
+});
diff --git a/packages/core/src/erc1155/writes.test.ts b/packages/core/src/erc1155/writes.test.ts
new file mode 100644
index 0000000..3c3f48d
--- /dev/null
+++ b/packages/core/src/erc1155/writes.test.ts
@@ -0,0 +1,140 @@
+import invariant from "tiny-invariant";
+import { type Hex, getAddress, zeroAddress } from "viem";
+import { foundry } from "viem/chains";
+import { beforeEach, describe, expect, test } from "vitest";
+import ERC1155Bytecode from "../../../../contracts/out/ERC1155.sol/ERC1155.json";
+import { ALICE, BOB } from "../_test/constants.js";
+import { publicClient, testClient, walletClient } from "../_test/utils.js";
+import { erc1155ABI } from "../generated.js";
+import { readAndParse } from "../readUtils.js";
+import { erc1155BalanceOf, erc1155IsApprovedForAll } from "./reads.js";
+import type { ERC1155 } from "./types.js";
+import { createERC1155, createERC1155Data } from "./utils.js";
+import {
+ erc1155SetApprovalForAll,
+ erc1155Transfer,
+ erc1155TransferBatch,
+} from "./writes.js";
+
+let id: Hex | undefined = undefined;
+
+let erc1155: ERC1155;
+
+beforeEach(async () => {
+ if (id === undefined) {
+ const deployHash = await walletClient.deployContract({
+ abi: erc1155ABI,
+ bytecode: ERC1155Bytecode.bytecode.object as Hex,
+ args: ["https://mitch.com"],
+ });
+
+ const { contractAddress } = await publicClient.waitForTransactionReceipt({
+ hash: deployHash,
+ });
+ invariant(contractAddress);
+ erc1155 = createERC1155(
+ contractAddress,
+ 0n,
+ "https://mitch.com",
+ foundry.id,
+ );
+
+ const mintHash = await walletClient.writeContract({
+ abi: erc1155ABI,
+ functionName: "mint",
+ address: getAddress(contractAddress!),
+ args: [ALICE, 0n, 10n, "0x"],
+ });
+ await publicClient.waitForTransactionReceipt({ hash: mintHash });
+ } else {
+ await testClient.revert({ id });
+ }
+
+ id = await testClient.snapshot();
+});
+
+describe("erc1155 writes", async () => {
+ test("can transfer", async () => {
+ const { hash } = await erc1155Transfer(publicClient, walletClient, ALICE, {
+ from: ALICE,
+ to: BOB,
+ erc1155: createERC1155Data(erc1155, 5n),
+ });
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ const balanceALICE = await readAndParse(
+ publicClient,
+ erc1155BalanceOf({ erc1155, owner: ALICE }),
+ );
+ expect(balanceALICE.amount).toBe(5n);
+
+ const balanceBOB = await readAndParse(
+ publicClient,
+ erc1155BalanceOf({ erc1155, owner: BOB }),
+ );
+ expect(balanceBOB.amount).toBe(5n);
+ });
+
+ test("can transfer batch", async () => {
+ await expect(() =>
+ erc1155TransferBatch(publicClient, walletClient, ALICE, {
+ from: ALICE,
+ to: BOB,
+ erc1155: [],
+ }),
+ ).rejects.toThrowError();
+
+ await expect(() =>
+ erc1155TransferBatch(publicClient, walletClient, ALICE, {
+ from: ALICE,
+ to: BOB,
+ erc1155: [
+ createERC1155Data(erc1155, 5n),
+ createERC1155Data({ ...erc1155, address: zeroAddress }, 5n),
+ ],
+ }),
+ ).rejects.toThrowError();
+
+ const { hash } = await erc1155TransferBatch(
+ publicClient,
+ walletClient,
+ ALICE,
+ {
+ from: ALICE,
+ to: BOB,
+ erc1155: [
+ createERC1155Data(erc1155, 5n),
+ createERC1155Data(erc1155, 5n),
+ ],
+ },
+ );
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ const balanceBOB = await readAndParse(
+ publicClient,
+ erc1155BalanceOf({ erc1155, owner: BOB }),
+ );
+ expect(balanceBOB.amount).toBe(10n);
+ });
+
+ test("can approve for all", async () => {
+ const { hash } = await erc1155SetApprovalForAll(
+ publicClient,
+ walletClient,
+ ALICE,
+ {
+ erc1155,
+ spender: BOB,
+ approved: true,
+ },
+ );
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ expect(
+ await readAndParse(
+ publicClient,
+ erc1155IsApprovedForAll({ erc1155, owner: ALICE, spender: BOB }),
+ ),
+ ).toBe(true);
+ });
+});
diff --git a/packages/core/src/erc1155/writes.ts b/packages/core/src/erc1155/writes.ts
new file mode 100644
index 0000000..e51d203
--- /dev/null
+++ b/packages/core/src/erc1155/writes.ts
@@ -0,0 +1,103 @@
+import {
+ type Account,
+ type Address,
+ type Hex,
+ type PublicClient,
+ type WalletClient,
+ getAddress,
+} from "viem";
+import { solmateErc1155ABI } from "../generated.js";
+import type { ReverseMirageWrite } from "../types.js";
+import type { ERC1155, ERC1155Data } from "./types.js";
+
+export const erc1155SetApprovalForAll = async (
+ publicClient: PublicClient,
+ walletClient: WalletClient,
+ account: Account | Address,
+ args: {
+ erc1155: Pick;
+ spender: Address;
+ approved: boolean;
+ },
+): Promise<
+ ReverseMirageWrite
+> => {
+ const { request, result } = await publicClient.simulateContract({
+ address: args.erc1155.address,
+ abi: solmateErc1155ABI,
+ functionName: "setApprovalForAll",
+ args: [args.spender, args.approved],
+ account,
+ });
+ const hash = await walletClient.writeContract(request);
+ return { hash, result, request };
+};
+
+export const erc1155Transfer = async (
+ publicClient: PublicClient,
+ walletClient: WalletClient,
+ account: Account | Address,
+ args: {
+ erc1155: ERC1155Data;
+ from: Address;
+ to: Address;
+ data?: Hex;
+ },
+): Promise<
+ ReverseMirageWrite
+> => {
+ const { request, result } = await publicClient.simulateContract({
+ address: args.erc1155.token.address,
+ abi: solmateErc1155ABI,
+ functionName: "safeTransferFrom",
+ args: [
+ args.from,
+ args.to,
+ args.erc1155.token.id,
+ args.erc1155.amount,
+ args.data ?? "0x",
+ ],
+ account,
+ });
+ const hash = await walletClient.writeContract(request);
+ return { hash, result, request };
+};
+
+export const erc1155TransferBatch = async (
+ publicClient: PublicClient,
+ walletClient: WalletClient,
+ account: Account | Address,
+ args: {
+ erc1155: ERC1155Data[];
+ from: Address;
+ to: Address;
+ data?: Hex;
+ },
+): Promise<
+ ReverseMirageWrite
+> => {
+ const address = args.erc1155.reduce((addr: Address | undefined, cur) => {
+ if (addr === undefined) return getAddress(cur.token.address);
+ else if (addr !== getAddress(cur.token.address))
+ throw Error("Tokens refering to different addresses");
+ else return addr;
+ }, undefined);
+
+ if (address === undefined) throw Error("No tokens passed to transfer");
+
+ const { request, result } = await publicClient.simulateContract({
+ address,
+ abi: solmateErc1155ABI,
+ functionName: "safeBatchTransferFrom",
+ args: [
+ args.from,
+ args.to,
+ args.erc1155.map((t) => t.token.id),
+ args.erc1155.map((t) => t.amount),
+ args.data ?? "0x",
+ ],
+ account,
+ });
+ const hash = await walletClient.writeContract(request);
+ return { hash, result, request };
+};
diff --git a/packages/core/src/erc20/reads.test.ts b/packages/core/src/erc20/reads.test.ts
index 8e3f093..e3d595f 100644
--- a/packages/core/src/erc20/reads.test.ts
+++ b/packages/core/src/erc20/reads.test.ts
@@ -19,11 +19,11 @@ import {
erc20PermitNonce,
erc20Symbol,
erc20TotalSupply,
- getErc20,
- getErc20Permit,
+ getERC20,
+ getERC20Permit,
} from "./reads.js";
import type { ERC20Permit } from "./types.js";
-import { createErc20, createErc20Permit } from "./utils.js";
+import { createERC20, createERC20Permit } from "./utils.js";
let id: Hex | undefined = undefined;
@@ -42,7 +42,7 @@ beforeAll(async () => {
hash: deployHash,
});
invariant(contractAddress);
- mockERC20 = createErc20Permit(
+ mockERC20 = createERC20Permit(
contractAddress,
"Mock ERC20",
"MOCK",
@@ -186,7 +186,7 @@ describe("erc20 reads", () => {
test("can get token", async () => {
const token = await readAndParse(
publicClient,
- getErc20({
+ getERC20({
erc20: mockERC20,
}),
);
@@ -201,7 +201,7 @@ describe("erc20 reads", () => {
test("can get permit token", async () => {
const token = await readAndParse(
publicClient,
- getErc20Permit({
+ getERC20Permit({
erc20: mockERC20,
}),
);
@@ -217,8 +217,8 @@ describe("erc20 reads", () => {
test("can get permit token no version", async () => {
const token = await readAndParse(
publicClient,
- getErc20Permit({
- erc20: createErc20(
+ getERC20Permit({
+ erc20: createERC20(
mockERC20.address,
mockERC20.name,
mockERC20.symbol,
diff --git a/packages/core/src/erc20/reads.ts b/packages/core/src/erc20/reads.ts
index 0a7b4ab..082dc47 100644
--- a/packages/core/src/erc20/reads.ts
+++ b/packages/core/src/erc20/reads.ts
@@ -1,27 +1,28 @@
import { type Address, type Hex, type PublicClient } from "viem";
import { createAmountFromRaw } from "../amountUtils.js";
-import { solmateErc20ABI } from "../generated.js";
+import { solmateErc20ABI as solmateERC20ABI } from "../generated.js";
import type { ReverseMirageRead } from "../types.js";
import type {
+ BaseERC20,
ERC20,
ERC20Amount,
ERC20Permit,
ERC20PermitData,
} from "./types.js";
import {
+ createERC20,
+ createERC20Permit,
createERC20PermitDataFromRaw,
- createErc20,
- createErc20Permit,
} from "./utils.js";
-export const erc20BalanceOf = (args: {
+export const erc20BalanceOf = (args: {
erc20: TERC20;
address: Address;
}) =>
({
read: (publicClient: PublicClient) =>
publicClient.readContract({
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
address: args.erc20.address,
functionName: "balanceOf",
args: [args.address],
@@ -29,7 +30,7 @@ export const erc20BalanceOf = (args: {
parse: (data): ERC20Amount => createAmountFromRaw(args.erc20, data),
}) as const satisfies ReverseMirageRead;
-export const erc20Allowance = (args: {
+export const erc20Allowance = (args: {
erc20: TERC20;
address: Address;
spender: Address;
@@ -37,7 +38,7 @@ export const erc20Allowance = (args: {
({
read: (publicClient: PublicClient) =>
publicClient.readContract({
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
address: args.erc20.address,
functionName: "allowance",
args: [args.address, args.spender],
@@ -45,13 +46,13 @@ export const erc20Allowance = (args: {
parse: (data): ERC20Amount => createAmountFromRaw(args.erc20, data),
}) as const satisfies ReverseMirageRead;
-export const erc20TotalSupply = (args: {
+export const erc20TotalSupply = (args: {
erc20: TERC20;
}) =>
({
read: (publicClient: PublicClient) =>
publicClient.readContract({
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
address: args.erc20.address,
functionName: "totalSupply",
}),
@@ -59,12 +60,12 @@ export const erc20TotalSupply = (args: {
}) as const satisfies ReverseMirageRead;
export const erc20Name = (args: {
- erc20: Pick;
+ erc20: Pick;
}) =>
({
read: (publicClient: PublicClient) =>
publicClient.readContract({
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
address: args.erc20.address,
functionName: "name",
}),
@@ -72,12 +73,12 @@ export const erc20Name = (args: {
}) as const satisfies ReverseMirageRead;
export const erc20Symbol = (args: {
- erc20: Pick;
+ erc20: Pick;
}) =>
({
read: (publicClient: PublicClient) =>
publicClient.readContract({
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
address: args.erc20.address,
functionName: "symbol",
}),
@@ -85,12 +86,12 @@ export const erc20Symbol = (args: {
}) as const satisfies ReverseMirageRead;
export const erc20Decimals = (args: {
- erc20: Pick;
+ erc20: Pick;
}) =>
({
read: (publicClient: PublicClient) =>
publicClient.readContract({
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
address: args.erc20.address,
functionName: "decimals",
}),
@@ -104,7 +105,7 @@ export const erc20PermitNonce = (args: {
({
read: (publicClient: PublicClient) =>
publicClient.readContract({
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
address: args.erc20.address,
functionName: "nonces",
args: [args.address],
@@ -120,13 +121,13 @@ export const erc20PermitData = (args: {
read: (publicClient: PublicClient) =>
Promise.all([
publicClient.readContract({
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
address: args.erc20.address,
functionName: "balanceOf",
args: [args.address],
}),
publicClient.readContract({
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
address: args.erc20.address,
functionName: "nonces",
args: [args.address],
@@ -142,14 +143,14 @@ export const erc20PermitDomainSeparator = (args: {
({
read: (publicClient: PublicClient) =>
publicClient.readContract({
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
address: args.erc20.address,
functionName: "DOMAIN_SEPARATOR",
}),
parse: (data) => data,
}) as const satisfies ReverseMirageRead;
-export const getErc20 = (args: {
+export const getERC20 = (args: {
erc20: Pick;
}) =>
({
@@ -160,7 +161,7 @@ export const getErc20 = (args: {
erc20Decimals(args).read(publicClient),
]),
parse: (data): ERC20 =>
- createErc20(
+ createERC20(
args.erc20.address,
data[0],
data[1],
@@ -169,7 +170,7 @@ export const getErc20 = (args: {
),
}) as const satisfies ReverseMirageRead<[string, string, number]>;
-export const getErc20Permit = (args: {
+export const getERC20Permit = (args: {
erc20: Pick &
Partial>;
}) =>
@@ -181,7 +182,7 @@ export const getErc20Permit = (args: {
erc20Decimals(args).read(publicClient),
]),
parse: (data): ERC20Permit =>
- createErc20Permit(
+ createERC20Permit(
args.erc20.address,
data[0],
data[1],
@@ -204,23 +205,23 @@ export const erc20IsPermit = (args: {
read: async (publicClient: PublicClient) => {
try {
return await Promise.all([
- getErc20(args).read(publicClient),
+ getERC20(args).read(publicClient),
erc20PermitDomainSeparator(args).read(publicClient),
]);
} catch {
- return await Promise.all([getErc20(args).read(publicClient)]);
+ return await Promise.all([getERC20(args).read(publicClient)]);
}
},
parse: (data): ERC20 | ERC20Permit =>
data.length === 1
- ? createErc20(
+ ? createERC20(
args.erc20.address,
data[0][0],
data[0][1],
data[0][2],
args.erc20.chainID,
)
- : createErc20Permit(
+ : createERC20Permit(
args.erc20.address,
data[0][0],
data[0][1],
diff --git a/packages/core/src/erc20/types.ts b/packages/core/src/erc20/types.ts
index e61c9b8..a9b0471 100644
--- a/packages/core/src/erc20/types.ts
+++ b/packages/core/src/erc20/types.ts
@@ -2,23 +2,25 @@ import type { Address } from "viem/accounts";
import type { Amount } from "../amountUtils.js";
import type { Token, TokenData } from "../types.js";
-export type ERC20 = Token<"erc20"> & {
+export type BaseERC20 = Token & {
address: Address;
+ name: string;
+ symbol: string;
decimals: number;
};
-export type ERC20Permit = Token<"erc20Permit"> & {
- address: Address;
- decimals: number;
+export type ERC20 = BaseERC20<"erc20">;
+
+export type ERC20Permit = BaseERC20<"erc20Permit"> & {
version: string;
};
-export type ERC20Data = Amount<
+export type ERC20Data = Amount<
TERC20,
`${TERC20["type"]}Amount`
>;
-export type ERC20Amount = Amount<
+export type ERC20Amount = Amount<
TERC20,
`${TERC20["type"]}Amount`
>;
diff --git a/packages/core/src/erc20/utils.test.ts b/packages/core/src/erc20/utils.test.ts
index 93f5772..4f4a1e7 100644
--- a/packages/core/src/erc20/utils.test.ts
+++ b/packages/core/src/erc20/utils.test.ts
@@ -9,11 +9,11 @@ import { amountEqualTo } from "../amountUtils.js";
import { createFraction } from "../fractionUtils.js";
import { erc20PermitHashTypedDataABI } from "../generated.js";
import {
+ createERC20,
+ createERC20Permit,
createERC20PermitDataFromFraction,
createERC20PermitDataFromRaw,
createERC20PermitDataFromString,
- createErc20,
- createErc20Permit,
erc20PermitTypedDataHash,
} from "./utils.js";
@@ -30,7 +30,7 @@ const erc20Permit = {
describe("utils", () => {
test("can create erc20", () => {
expect(
- createErc20(zeroAddress, "name", "symbol", 18, foundry.id),
+ createERC20(zeroAddress, "name", "symbol", 18, foundry.id),
).toStrictEqual({
type: "erc20",
address: zeroAddress,
@@ -43,7 +43,7 @@ describe("utils", () => {
test("can create erc20permit", () => {
expect(
- createErc20Permit(zeroAddress, "name", "symbol", 18, "1", foundry.id),
+ createERC20Permit(zeroAddress, "name", "symbol", 18, "1", foundry.id),
).toStrictEqual(erc20Permit);
});
@@ -94,7 +94,7 @@ describe("utils", () => {
});
invariant(contractAddress);
- const erc20Permit = createErc20Permit(
+ const erc20Permit = createERC20Permit(
contractAddress,
"Mock ERC20",
"MOCK",
diff --git a/packages/core/src/erc20/utils.ts b/packages/core/src/erc20/utils.ts
index bcb3226..678bcac 100644
--- a/packages/core/src/erc20/utils.ts
+++ b/packages/core/src/erc20/utils.ts
@@ -10,7 +10,7 @@ import type { ERC20, ERC20Permit, ERC20PermitData } from "./types.js";
/**
* Creates an {@link ERC20}
*/
-export const createErc20 = (
+export const createERC20 = (
address: Address,
name: string,
symbol: string,
@@ -28,7 +28,7 @@ export const createErc20 = (
/**
* Creates an {@link ERC20Permit}
*/
-export const createErc20Permit = (
+export const createERC20Permit = (
address: Address,
name: string,
symbol: string,
diff --git a/packages/core/src/erc20/writes.test.ts b/packages/core/src/erc20/writes.test.ts
index d935be6..cf1180c 100644
--- a/packages/core/src/erc20/writes.test.ts
+++ b/packages/core/src/erc20/writes.test.ts
@@ -3,14 +3,14 @@ import { type Hex, getAddress, parseEther } from "viem";
import { foundry } from "viem/chains";
import { beforeEach, describe, expect, test } from "vitest";
import ERC20PermitBytecode from "../../../../contracts/out/ERC20Permit.sol/ERC20Permit.json";
-import { ALICE, BOB, mockToken } from "../_test/constants.js";
+import { ALICE, BOB } from "../_test/constants.js";
import { publicClient, testClient, walletClient } from "../_test/utils.js";
import { amountEqualTo, createAmountFromString } from "../amountUtils.js";
import { erc20PermitABI } from "../generated.js";
import { readAndParse } from "../readUtils.js";
import { erc20Allowance, erc20BalanceOf } from "./reads.js";
import type { ERC20Permit } from "./types.js";
-import { createERC20PermitDataFromString, createErc20Permit } from "./utils.js";
+import { createERC20Permit, createERC20PermitDataFromString } from "./utils.js";
import {
erc20Approve,
erc20Permit,
@@ -28,17 +28,17 @@ beforeEach(async () => {
const deployHash = await walletClient.deployContract({
abi: erc20PermitABI,
bytecode: ERC20PermitBytecode.bytecode.object as Hex,
- args: [mockToken.name, mockToken.symbol, 18],
+ args: ["name", "symbol", 18],
});
const { contractAddress } = await publicClient.waitForTransactionReceipt({
hash: deployHash,
});
invariant(contractAddress);
- mockERC20 = createErc20Permit(
+ mockERC20 = createERC20Permit(
contractAddress,
- "Mock ERC20",
- "MOCK",
+ "name",
+ "symbol",
18,
"1",
foundry.id,
diff --git a/packages/core/src/erc20/writes.ts b/packages/core/src/erc20/writes.ts
index 7bcc616..a076796 100644
--- a/packages/core/src/erc20/writes.ts
+++ b/packages/core/src/erc20/writes.ts
@@ -7,7 +7,7 @@ import {
getAddress,
} from "viem";
import type { Address } from "viem/accounts";
-import { solmateErc20ABI } from "../generated.js";
+import { solmateErc20ABI as solmateERC20ABI } from "../generated.js";
import type { ReverseMirageWrite } from "../types.js";
import type {
ERC20,
@@ -25,10 +25,10 @@ export const erc20Transfer = async (
to: Address;
amount: ERC20Amount;
},
-): Promise> => {
+): Promise> => {
const { request, result } = await publicClient.simulateContract({
address: args.amount.token.address,
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
functionName: "transfer",
args: [args.to, args.amount.amount],
account,
@@ -45,10 +45,10 @@ export const erc20Approve = async (
spender: Address;
amount: ERC20Amount;
},
-): Promise> => {
+): Promise> => {
const { request, result } = await publicClient.simulateContract({
address: args.amount.token.address,
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
functionName: "approve",
args: [args.spender, args.amount.amount],
account,
@@ -66,10 +66,10 @@ export const erc20TransferFrom = async (
to: Address;
amount: ERC20Amount;
},
-): Promise> => {
+): Promise> => {
const { request, result } = await publicClient.simulateContract({
address: args.amount.token.address,
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
functionName: "transferFrom",
args: [args.from, args.to, args.amount.amount],
account,
@@ -78,6 +78,7 @@ export const erc20TransferFrom = async (
return { hash, result, request };
};
+// TODO: owner is an unnecessary parameter
export const erc20SignPermit = async (
walletClient: WalletClient,
account: Account | Address,
@@ -121,7 +122,7 @@ export const erc20Permit = async (
deadline: bigint;
signature: Hex;
},
-): Promise> => {
+): Promise> => {
invariant(args.signature.length === 132, "Invalid signature length");
const r = `0x${args.signature.substring(2, 2 + 64)}` as const;
@@ -130,7 +131,7 @@ export const erc20Permit = async (
const { request, result } = await publicClient.simulateContract({
address: args.permitData.token.address,
- abi: solmateErc20ABI,
+ abi: solmateERC20ABI,
functionName: "permit",
args: [
args.owner,
diff --git a/packages/core/src/erc721/erc721MaxBalance.test.ts b/packages/core/src/erc721/erc721MaxBalance.test.ts
new file mode 100644
index 0000000..1f67b08
--- /dev/null
+++ b/packages/core/src/erc721/erc721MaxBalance.test.ts
@@ -0,0 +1,35 @@
+import invariant from "tiny-invariant";
+import type { Hex } from "viem";
+import { foundry } from "viem/chains";
+import { expect, test } from "vitest";
+import ERC721Bytecode from "../../../../contracts/out/ERC721MaxBalance.sol/ERC721MaxBalance.json";
+import { ALICE } from "../_test/constants.js";
+import { publicClient, walletClient } from "../_test/utils.js";
+import { erc721ABI } from "../generated.js";
+import { readAndParse } from "../readUtils.js";
+import { erc721Data } from "./reads.js";
+import { createERC721 } from "./utils.js";
+
+test("erc721 max balance", async () => {
+ const deployHash = await walletClient.deployContract({
+ abi: erc721ABI,
+ bytecode: ERC721Bytecode.bytecode.object as Hex,
+ args: ["name", "symbol", "https://mitch.com"],
+ });
+
+ const { contractAddress } = await publicClient.waitForTransactionReceipt({
+ hash: deployHash,
+ });
+ invariant(contractAddress);
+ const erc721 = createERC721(
+ contractAddress,
+ "name",
+ "symbol",
+ 0n,
+ "https://mitch.com",
+ foundry.id,
+ );
+ await expect(() =>
+ readAndParse(publicClient, erc721Data({ erc721, owner: ALICE })),
+ ).rejects.toThrowError();
+});
diff --git a/packages/core/src/erc721/reads.test.ts b/packages/core/src/erc721/reads.test.ts
new file mode 100644
index 0000000..1151fe9
--- /dev/null
+++ b/packages/core/src/erc721/reads.test.ts
@@ -0,0 +1,181 @@
+import invariant from "tiny-invariant";
+import { type Hex, getAddress } from "viem";
+import { foundry } from "viem/chains";
+import { beforeEach, describe, expect, test } from "vitest";
+import ERC721Bytecode from "../../../../contracts/out/ERC721.sol/ERC721.json";
+import { ALICE, BOB } from "../_test/constants.js";
+import { publicClient, testClient, walletClient } from "../_test/utils.js";
+import { erc721ABI } from "../generated.js";
+import { readAndParse } from "../readUtils.js";
+import {
+ erc721BalanceOf,
+ erc721Data,
+ erc721GetApproved,
+ erc721IDData,
+ erc721IsApprovedForAll,
+ erc721Name,
+ erc721OwnerOf,
+ erc721SupportsInterface,
+ erc721Symbol,
+ erc721TokenURI,
+ getERC721,
+} from "./reads.js";
+import type { ERC721 } from "./types.js";
+import { createERC721 } from "./utils.js";
+import { erc721Approve, erc721SetApprovalForAll } from "./writes.js";
+
+let id: Hex | undefined = undefined;
+
+let erc721: ERC721;
+
+beforeEach(async () => {
+ if (id === undefined) {
+ const deployHash = await walletClient.deployContract({
+ abi: erc721ABI,
+ bytecode: ERC721Bytecode.bytecode.object as Hex,
+ args: ["name", "symbol", "https://mitch.com"],
+ });
+
+ const { contractAddress } = await publicClient.waitForTransactionReceipt({
+ hash: deployHash,
+ });
+ invariant(contractAddress);
+ erc721 = createERC721(
+ contractAddress,
+ "name",
+ "symbol",
+ 0n,
+ "https://mitch.com",
+ foundry.id,
+ );
+
+ const mintHash = await walletClient.writeContract({
+ abi: erc721ABI,
+ functionName: "mint",
+ address: getAddress(contractAddress!),
+ args: [ALICE, 0n],
+ });
+ await publicClient.waitForTransactionReceipt({ hash: mintHash });
+
+ const { hash: approveHash } = await erc721Approve(
+ publicClient,
+ walletClient,
+ ALICE,
+ {
+ erc721,
+ spender: BOB,
+ },
+ );
+ await publicClient.waitForTransactionReceipt({ hash: approveHash });
+
+ const { hash } = await erc721SetApprovalForAll(
+ publicClient,
+ walletClient,
+ ALICE,
+ {
+ erc721,
+ spender: BOB,
+ approved: true,
+ },
+ );
+ await publicClient.waitForTransactionReceipt({ hash });
+ } else {
+ await testClient.revert({ id });
+ }
+
+ id = await testClient.snapshot();
+});
+
+describe("erc721 reads", async () => {
+ test("name", async () => {
+ const name = await readAndParse(publicClient, erc721Name({ erc721 }));
+
+ expect(name).toBe("name");
+ });
+
+ test("symbol", async () => {
+ const symbol = await readAndParse(publicClient, erc721Symbol({ erc721 }));
+
+ expect(symbol).toBe("symbol");
+ });
+
+ test("tokenURI", async () => {
+ const tokenURI = await readAndParse(
+ publicClient,
+ erc721TokenURI({ erc721 }),
+ );
+
+ expect(tokenURI).toBe("https://mitch.com");
+ });
+
+ test("ownerOf", async () => {
+ const owner = await readAndParse(publicClient, erc721OwnerOf({ erc721 }));
+
+ expect(owner).toBe(ALICE);
+ });
+
+ test("balanceOf", async () => {
+ const balance = await readAndParse(
+ publicClient,
+ erc721BalanceOf({ erc721, owner: ALICE }),
+ );
+
+ expect(balance).toBe(1n);
+ });
+
+ test("getApproved", async () => {
+ const approved = await readAndParse(
+ publicClient,
+ erc721GetApproved({ erc721 }),
+ );
+
+ expect(approved).toBe(BOB);
+ });
+
+ test("isApprovedForAll", async () => {
+ const approved = await readAndParse(
+ publicClient,
+ erc721IsApprovedForAll({ erc721, owner: ALICE, spender: BOB }),
+ );
+
+ expect(approved).toBe(true);
+ });
+
+ test("supportsInterface", async () => {
+ const supportsInterface = await readAndParse(
+ publicClient,
+ erc721SupportsInterface({ erc721, interfaceID: "0x01ffc9a7" }),
+ );
+
+ expect(supportsInterface).toBe(true);
+ });
+
+ test("getERC721", async () => {
+ expect(
+ await readAndParse(publicClient, getERC721({ erc721 })),
+ ).toStrictEqual(erc721);
+ });
+
+ test("erc721IDData", async () => {
+ const idData = await readAndParse(
+ publicClient,
+ erc721IDData({ erc721, owner: ALICE }),
+ );
+
+ expect(idData.owned).toBe(true);
+ expect(idData.token).toStrictEqual(erc721);
+ expect(idData.type).toBe("erc721IDData");
+ });
+
+ test("erc721Data", async () => {
+ const data = await readAndParse(
+ publicClient,
+ erc721Data({ erc721, owner: ALICE }),
+ );
+
+ expect(data.balance).toBe(1);
+ expect(data.token).toStrictEqual(erc721);
+ expect(data.type).toBe("erc721Data");
+ expect(data.ids).toBe(undefined);
+ });
+});
diff --git a/packages/core/src/erc721/reads.ts b/packages/core/src/erc721/reads.ts
new file mode 100644
index 0000000..8484d69
--- /dev/null
+++ b/packages/core/src/erc721/reads.ts
@@ -0,0 +1,168 @@
+import { type Address, type Hex, type PublicClient, getAddress } from "viem";
+import { solmateErc721ABI as solmateERC721ABI } from "../generated.js";
+import type { ReverseMirageRead } from "../types.js";
+import type { ERC721, ERC721Data, ERC721IDData } from "./types.js";
+import { createERC721, createERC721Data, createERC721IDData } from "./utils.js";
+
+export const erc721Name = (args: {
+ erc721: Pick;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateERC721ABI,
+ address: args.erc721.address,
+ functionName: "name",
+ }),
+ parse: (data) => data,
+ }) as const satisfies ReverseMirageRead;
+
+export const erc721Symbol = (args: {
+ erc721: Pick;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateERC721ABI,
+ address: args.erc721.address,
+ functionName: "symbol",
+ }),
+ parse: (data) => data,
+ }) as const satisfies ReverseMirageRead;
+
+export const erc721TokenURI = (args: {
+ erc721: Pick;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateERC721ABI,
+ address: args.erc721.address,
+ functionName: "tokenURI",
+ args: [args.erc721.id],
+ }),
+ parse: (data) => data,
+ }) as const satisfies ReverseMirageRead;
+
+export const erc721OwnerOf = (args: {
+ erc721: Pick;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateERC721ABI,
+ address: args.erc721.address,
+ functionName: "ownerOf",
+ args: [args.erc721.id],
+ }),
+ parse: (data) => data,
+ }) as const satisfies ReverseMirageRead;
+
+export const erc721BalanceOf = (args: {
+ erc721: Pick;
+ owner: Address;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateERC721ABI,
+ address: args.erc721.address,
+ functionName: "balanceOf",
+ args: [args.owner],
+ }),
+ parse: (data) => data,
+ }) as const satisfies ReverseMirageRead;
+
+export const erc721GetApproved = (args: {
+ erc721: Pick;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateERC721ABI,
+ address: args.erc721.address,
+ functionName: "getApproved",
+ args: [args.erc721.id],
+ }),
+ parse: (data) => data,
+ }) as const satisfies ReverseMirageRead;
+
+export const erc721IsApprovedForAll = (args: {
+ erc721: Pick;
+ owner: Address;
+ spender: Address;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateERC721ABI,
+ address: args.erc721.address,
+ functionName: "isApprovedForAll",
+ args: [args.owner, args.spender],
+ }),
+ parse: (data) => data,
+ }) as const satisfies ReverseMirageRead;
+
+export const erc721SupportsInterface = (args: {
+ erc721: Pick;
+ interfaceID: Hex;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ publicClient.readContract({
+ abi: solmateERC721ABI,
+ address: args.erc721.address,
+ functionName: "supportsInterface",
+ args: [args.interfaceID],
+ }),
+ parse: (data) => data,
+ }) as const satisfies ReverseMirageRead;
+
+export const getERC721 = (args: {
+ erc721: Pick;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ Promise.all([
+ erc721Name(args).read(publicClient),
+ erc721Symbol(args).read(publicClient),
+ erc721TokenURI(args).read(publicClient),
+ ]),
+ parse: (data): ERC721 =>
+ createERC721(
+ args.erc721.address,
+ data[0],
+ data[1],
+ args.erc721.id,
+ data[2],
+ args.erc721.chainID,
+ ),
+ }) as const satisfies ReverseMirageRead<[string, string, string]>;
+
+export const erc721IDData = (args: {
+ erc721: TERC721;
+ owner: Address;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ erc721OwnerOf({ erc721: args.erc721 }).read(publicClient),
+ parse: (data): ERC721IDData =>
+ createERC721IDData(
+ args.erc721,
+ getAddress(data) === getAddress(args.owner),
+ ),
+ }) as const satisfies ReverseMirageRead;
+
+export const erc721Data = (args: {
+ erc721: TERC721;
+ owner: Address;
+}) =>
+ ({
+ read: (publicClient: PublicClient) =>
+ erc721BalanceOf(args).read(publicClient),
+ parse: (data): ERC721Data => {
+ if (data > Number.MAX_SAFE_INTEGER)
+ throw Error("balance exceeds maximum representable number");
+ return createERC721Data(args.erc721, Number(data));
+ },
+ }) as const satisfies ReverseMirageRead;
diff --git a/packages/core/src/erc721/types.ts b/packages/core/src/erc721/types.ts
new file mode 100644
index 0000000..9ebfbcd
--- /dev/null
+++ b/packages/core/src/erc721/types.ts
@@ -0,0 +1,30 @@
+import type { Address } from "viem";
+import type { Token, TokenData, Tuple } from "../types.js";
+
+export type ERC721 = Token<"erc721"> & {
+ address: Address;
+ name: string;
+ symbol: string;
+ id: bigint;
+ tokenURI: string;
+};
+
+export type ERC721IDData = TokenData<
+ TERC721,
+ `${TERC721["type"]}IDData`,
+ {
+ owned: boolean;
+ }
+>;
+
+export type ERC721Data<
+ TERC721 extends ERC721,
+ TBalance extends number = number,
+> = TokenData<
+ TERC721,
+ `${TERC721["type"]}Data`,
+ {
+ balance: TBalance;
+ ids: Tuple | undefined;
+ }
+>;
diff --git a/packages/core/src/erc721/utils.test.ts b/packages/core/src/erc721/utils.test.ts
new file mode 100644
index 0000000..53dd1cc
--- /dev/null
+++ b/packages/core/src/erc721/utils.test.ts
@@ -0,0 +1,48 @@
+import { zeroAddress } from "viem";
+import { foundry } from "viem/chains";
+import { describe, expect, test } from "vitest";
+import { createERC721, createERC721Data, createERC721IDData } from "./utils.js";
+
+const erc721 = {
+ type: "erc721",
+ address: zeroAddress,
+ name: "name",
+ symbol: "symbol",
+ id: 0n,
+ tokenURI: "https://mitch.com",
+ chainID: foundry.id,
+} as const;
+
+describe("utils", () => {
+ test("can create erc721", () => {
+ expect(
+ createERC721(
+ zeroAddress,
+ "name",
+ "symbol",
+ 0n,
+ "https://mitch.com",
+ foundry.id,
+ ),
+ ).toStrictEqual(erc721);
+ });
+
+ test("can create erc721 id data", () => {
+ expect(createERC721IDData(erc721, true)).toStrictEqual({
+ type: "erc721IDData",
+ token: erc721,
+ owned: true,
+ });
+ });
+
+ test("can create erc721 data", () => {
+ expect(createERC721Data(erc721, 6, [0n, 1n, 2n, 3n, 4n, 5n])).toStrictEqual(
+ {
+ type: "erc721Data",
+ balance: 6,
+ ids: [0n, 1n, 2n, 3n, 4n, 5n],
+ token: erc721,
+ },
+ );
+ });
+});
diff --git a/packages/core/src/erc721/utils.ts b/packages/core/src/erc721/utils.ts
new file mode 100644
index 0000000..aa91f96
--- /dev/null
+++ b/packages/core/src/erc721/utils.ts
@@ -0,0 +1,52 @@
+import { type Address, getAddress } from "viem";
+import type { Tuple } from "../types.js";
+import type { ERC721, ERC721Data, ERC721IDData } from "./types.js";
+
+/**
+ * Creates an {@link ERC721}
+ */
+export const createERC721 = (
+ address: Address,
+ name: string,
+ symbol: string,
+ id: bigint,
+ tokenURI: string,
+ chainID: number,
+): ERC721 => ({
+ type: "erc721",
+ address: getAddress(address),
+ name,
+ symbol,
+ id,
+ tokenURI,
+ chainID,
+});
+
+/**
+ * Creates an {@link ERC721IDData}
+ */
+export const createERC721IDData = (
+ erc721: TERC721,
+ owned: boolean,
+): ERC721IDData => ({
+ type: `${erc721.type as TERC721["type"]}IDData`,
+ token: erc721,
+ owned,
+});
+
+/**
+ * Creates an {@link ERC721Data}
+ */
+export const createERC721Data = <
+ TERC721 extends ERC721,
+ TBalance extends number,
+>(
+ erc721: TERC721,
+ balance: TBalance,
+ ids?: Tuple,
+): ERC721Data => ({
+ type: `${erc721.type as TERC721["type"]}Data`,
+ token: erc721,
+ balance,
+ ids,
+});
diff --git a/packages/core/src/erc721/writes.test.ts b/packages/core/src/erc721/writes.test.ts
new file mode 100644
index 0000000..c4da227
--- /dev/null
+++ b/packages/core/src/erc721/writes.test.ts
@@ -0,0 +1,136 @@
+import invariant from "tiny-invariant";
+import { type Hex, getAddress } from "viem";
+import { foundry } from "viem/chains";
+import { beforeEach, describe, expect, test } from "vitest";
+import ERC721Bytecode from "../../../../contracts/out/ERC721.sol/ERC721.json";
+import { ALICE, BOB } from "../_test/constants.js";
+import { publicClient, testClient, walletClient } from "../_test/utils.js";
+import { erc721ABI } from "../generated.js";
+import { readAndParse } from "../readUtils.js";
+import {
+ erc721GetApproved,
+ erc721IsApprovedForAll,
+ erc721OwnerOf,
+} from "./reads.js";
+import type { ERC721 } from "./types.js";
+import { createERC721 } from "./utils.js";
+import {
+ erc721Approve,
+ erc721SetApprovalForAll,
+ erc721Transfer,
+} from "./writes.js";
+
+let id: Hex | undefined = undefined;
+
+let erc721: ERC721;
+
+beforeEach(async () => {
+ if (id === undefined) {
+ const deployHash = await walletClient.deployContract({
+ abi: erc721ABI,
+ bytecode: ERC721Bytecode.bytecode.object as Hex,
+ args: ["name", "symbol", "https://mitch.com"],
+ });
+
+ const { contractAddress } = await publicClient.waitForTransactionReceipt({
+ hash: deployHash,
+ });
+ invariant(contractAddress);
+ erc721 = createERC721(
+ contractAddress,
+ "name",
+ "symbol",
+ 0n,
+ "https://mitch.com",
+ foundry.id,
+ );
+
+ const mintHash = await walletClient.writeContract({
+ abi: erc721ABI,
+ functionName: "mint",
+ address: getAddress(contractAddress!),
+ args: [ALICE, 0n],
+ });
+ await publicClient.waitForTransactionReceipt({ hash: mintHash });
+ } else {
+ await testClient.revert({ id });
+ }
+
+ id = await testClient.snapshot();
+});
+
+describe("erc721 writes", async () => {
+ test("can transfer", async () => {
+ const { hash } = await erc721Transfer(publicClient, walletClient, ALICE, {
+ from: ALICE,
+ to: BOB,
+ erc721,
+ });
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ expect(await readAndParse(publicClient, erc721OwnerOf({ erc721 }))).toBe(
+ BOB,
+ );
+ });
+
+ test("can transfer safe", async () => {
+ const { hash } = await erc721Transfer(publicClient, walletClient, ALICE, {
+ from: ALICE,
+ to: BOB,
+ erc721,
+ data: "safe",
+ });
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ expect(await readAndParse(publicClient, erc721OwnerOf({ erc721 }))).toBe(
+ BOB,
+ );
+ });
+
+ test("can transfer data", async () => {
+ const { hash } = await erc721Transfer(publicClient, walletClient, ALICE, {
+ from: ALICE,
+ to: BOB,
+ erc721,
+ data: "0x",
+ });
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ expect(await readAndParse(publicClient, erc721OwnerOf({ erc721 }))).toBe(
+ BOB,
+ );
+ });
+
+ test("can approve", async () => {
+ const { hash } = await erc721Approve(publicClient, walletClient, ALICE, {
+ erc721,
+ spender: BOB,
+ });
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ expect(
+ await readAndParse(publicClient, erc721GetApproved({ erc721 })),
+ ).toBe(BOB);
+ });
+
+ test("can approve for all", async () => {
+ const { hash } = await erc721SetApprovalForAll(
+ publicClient,
+ walletClient,
+ ALICE,
+ {
+ erc721,
+ spender: BOB,
+ approved: true,
+ },
+ );
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ expect(
+ await readAndParse(
+ publicClient,
+ erc721IsApprovedForAll({ erc721, owner: ALICE, spender: BOB }),
+ ),
+ ).toBe(true);
+ });
+});
diff --git a/packages/core/src/erc721/writes.ts b/packages/core/src/erc721/writes.ts
new file mode 100644
index 0000000..a1163ee
--- /dev/null
+++ b/packages/core/src/erc721/writes.ts
@@ -0,0 +1,102 @@
+import type { Account, Address, Hex, PublicClient, WalletClient } from "viem";
+import { solmateErc721ABI } from "../generated.js";
+import type { ReverseMirageWrite } from "../types.js";
+import type { ERC721 } from "./types.js";
+
+/**
+ * Transfer an {@link ERC721}
+ *
+ * Depending on `data` passed in, use one of three transfer methods
+ */
+// TODO: make from optional
+export const erc721Transfer = async (
+ publicClient: PublicClient,
+ walletClient: WalletClient,
+ account: Account | Address,
+ args: {
+ from: Address;
+ to: Address;
+ erc721: Pick;
+ data?: "safe" | Hex;
+ },
+): Promise<
+ ReverseMirageWrite<
+ typeof solmateErc721ABI,
+ "transferFrom" | "safeTransferFrom"
+ >
+> => {
+ if (args.data === undefined) {
+ const { request, result } = await publicClient.simulateContract({
+ address: args.erc721.address,
+ abi: solmateErc721ABI,
+ functionName: "transferFrom",
+ args: [args.from, args.to, args.erc721.id],
+ account,
+ });
+ const hash = await walletClient.writeContract(request);
+ return { hash, result, request };
+ } else if (args.data === "safe") {
+ const { request, result } = await publicClient.simulateContract({
+ address: args.erc721.address,
+ abi: solmateErc721ABI,
+ functionName: "safeTransferFrom",
+ args: [args.from, args.to, args.erc721.id],
+ account,
+ });
+ const hash = await walletClient.writeContract(request);
+ return { hash, result, request };
+ } else {
+ const { request, result } = await publicClient.simulateContract({
+ address: args.erc721.address,
+ abi: solmateErc721ABI,
+ functionName: "safeTransferFrom",
+ args: [args.from, args.to, args.erc721.id, args.data],
+ account,
+ });
+ const hash = await walletClient.writeContract(request);
+ return { hash, result, request };
+ }
+};
+
+export const erc721Approve = async (
+ publicClient: PublicClient,
+ walletClient: WalletClient,
+ account: Account | Address,
+ args: {
+ erc721: Pick;
+ spender: Address;
+ },
+): Promise> => {
+ const { request, result } = await publicClient.simulateContract({
+ address: args.erc721.address,
+ abi: solmateErc721ABI,
+ functionName: "approve",
+ args: [args.spender, args.erc721.id],
+ account,
+ });
+ const hash = await walletClient.writeContract(request);
+ return { hash, result, request };
+};
+
+export const erc721SetApprovalForAll = async (
+ publicClient: PublicClient,
+ walletClient: WalletClient,
+ account: Account | Address,
+ args: {
+ erc721: Pick;
+ spender: Address;
+ approved: boolean;
+ },
+): Promise<
+ ReverseMirageWrite
+> => {
+ const { request, result } = await publicClient.simulateContract({
+ address: args.erc721.address,
+ abi: solmateErc721ABI,
+ functionName: "setApprovalForAll",
+ args: [args.spender, args.approved],
+ account,
+ });
+ const hash = await walletClient.writeContract(request);
+ return { hash, result, request };
+};
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
index 5bd1cd0..0478a1a 100644
--- a/packages/core/src/index.ts
+++ b/packages/core/src/index.ts
@@ -1,3 +1,101 @@
+// ERC20
+
+export {
+ erc20BalanceOf,
+ erc20Allowance,
+ erc20TotalSupply,
+ erc20Name,
+ erc20Symbol,
+ erc20Decimals,
+ erc20PermitNonce,
+ erc20PermitData,
+ erc20PermitDomainSeparator,
+ getERC20,
+ getERC20Permit,
+ erc20IsPermit,
+} from "./erc20/reads.js";
+
+export {
+ createERC20,
+ createERC20Permit,
+ createERC20PermitDataFromString,
+ createERC20PermitDataFromRaw,
+ createERC20PermitDataFromFraction,
+ PermitType,
+ erc20PermitTypedDataHash,
+} from "./erc20/utils.js";
+
+export {
+ erc20Transfer,
+ erc20Approve,
+ erc20TransferFrom,
+ erc20Permit,
+ erc20SignPermit,
+} from "./erc20/writes.js";
+
+// ERC721
+
+export {
+ erc721Name,
+ erc721Symbol,
+ erc721TokenURI,
+ erc721GetApproved,
+ erc721IsApprovedForAll,
+ erc721OwnerOf,
+ erc721BalanceOf,
+ erc721SupportsInterface,
+ getERC721,
+ erc721Data,
+ erc721IDData,
+} from "./erc721/reads.js";
+
+export {
+ createERC721,
+ createERC721Data,
+ createERC721IDData,
+} from "./erc721/utils.js";
+
+export {
+ erc721Transfer,
+ erc721Approve,
+ erc721SetApprovalForAll,
+} from "./erc721/writes.js";
+
+// ERC1155
+
+export {
+ erc1155IsApprovedForAll,
+ erc1155URI,
+ erc1155BalanceOf,
+ getERC1155,
+} from "./erc1155/reads.js";
+
+export { createERC1155, createERC1155Data } from "./erc1155/utils.js";
+
+export {
+ erc1155SetApprovalForAll,
+ erc1155Transfer,
+ erc1155TransferBatch,
+} from "./erc1155/writes.js";
+
+// NATIVE
+
+export { nativeBalance } from "./native/reads.js";
+
+export { createNativeCurrency } from "./native/utils.js";
+
+// WETH
+
+export { createWETH } from "./weth/utils.js";
+
+export { wethDeposit, wethWithdraw } from "./weth/writes.js";
+
+// UTILS
+
+export { readAndParse } from "./readUtils.js";
+
+// AMOUNT
+
export {
type Amount,
isAmount,
@@ -14,6 +112,8 @@ export {
amountToNumber,
} from "./amountUtils.js";
+// FRACTION
+
export {
isFraction,
createFraction,
@@ -30,6 +130,8 @@ export {
fractionToNumber,
} from "./fractionUtils.js";
+// PRICE
+
export {
isPrice,
createPriceFromFraction,
@@ -49,42 +151,19 @@ export {
priceToNumber,
} from "./priceUtils.js";
-export { readAndParse } from "./readUtils.js";
+// ABI
export {
- erc20BalanceOf,
- erc20Allowance,
- erc20TotalSupply,
- erc20Name,
- erc20Symbol,
- erc20Decimals,
- erc20PermitNonce,
- erc20PermitData,
- erc20PermitDomainSeparator,
- getErc20,
- getErc20Permit,
- erc20IsPermit,
-} from "./erc20/reads.js";
+ solmateErc20ABI as erc20ABI,
+ solmateErc721ABI as erc721ABI,
+ solmateErc1155ABI as erc1155ABI,
+ weth9ABI,
+} from "./generated.js";
-export {
- createErc20,
- createErc20Permit,
- createERC20PermitDataFromString,
- createERC20PermitDataFromRaw,
- createERC20PermitDataFromFraction,
- PermitType,
- erc20PermitTypedDataHash,
-} from "./erc20/utils.js";
-
-export {
- erc20Transfer,
- erc20Approve,
- erc20TransferFrom,
- erc20Permit,
- erc20SignPermit,
-} from "./erc20/writes.js";
+// TYPES
export type {
+ BaseERC20,
ERC20,
ERC20Permit,
ERC20Data,
@@ -92,9 +171,9 @@ export type {
ERC20PermitData,
} from "./erc20/types.js";
-export { nativeBalance } from "./native/reads.js";
+export type { ERC721, ERC721IDData, ERC721Data } from "./erc721/types.js";
-export { createNativeCurrency } from "./native/utils.js";
+export type { ERC1155, ERC1155Data } from "./erc1155/types.js";
export type {
NativeCurrency,
@@ -102,7 +181,7 @@ export type {
NativeCurrencyData,
} from "./native/types.js";
-export { solmateErc20ABI as erc20ABI } from "./generated.js";
+export type { WETH } from "./weth/types.js";
export type {
BigIntIsh,
@@ -112,4 +191,5 @@ export type {
Price,
ReverseMirageRead,
ReverseMirageWrite,
+ Tuple,
} from "./types.js";
diff --git a/packages/core/src/native/types.ts b/packages/core/src/native/types.ts
index bf1b994..672ed8f 100644
--- a/packages/core/src/native/types.ts
+++ b/packages/core/src/native/types.ts
@@ -1,6 +1,8 @@
import type { Token, TokenData } from "../types.js";
export type NativeCurrency = Token<"nativeCurrency"> & {
+ name: string;
+ symbol: string;
decimals: number;
};
diff --git a/packages/core/src/native/utils.test.ts b/packages/core/src/native/utils.test.ts
new file mode 100644
index 0000000..e413a00
--- /dev/null
+++ b/packages/core/src/native/utils.test.ts
@@ -0,0 +1,12 @@
+import { foundry } from "viem/chains";
+import { describe, expect, test } from "vitest";
+import { anvilEther } from "../_test/constants.js";
+import { createNativeCurrency } from "./utils.js";
+
+describe("utils", () => {
+ test("can create nativeCurrency", () => {
+ expect(
+ createNativeCurrency("Anvil Ether", "ETH", 18, foundry.id),
+ ).toStrictEqual(anvilEther);
+ });
+});
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
index e21a30e..a28afa3 100644
--- a/packages/core/src/types.ts
+++ b/packages/core/src/types.ts
@@ -10,8 +10,6 @@ export type Fraction = {
export type Token = {
type: TType;
- name: string;
- symbol: string;
chainID: number;
};
@@ -46,3 +44,16 @@ export type ReverseMirageWrite<
request: SimulateContractReturnType["request"];
result: SimulateContractReturnType["result"];
}>;
+
+/**
+ * A tuple of length `N` with elements of type `T`.
+ * @see https://github.com/saber-hq/saber-common/blob/master/packages/tuple-utils/src/tuple.ts
+ */
+export type Tuple = N extends N
+ ? number extends N
+ ? T[]
+ : _TupleOf
+ : never;
+type _TupleOf = R["length"] extends N
+ ? R
+ : _TupleOf;
diff --git a/packages/core/src/weth/types.ts b/packages/core/src/weth/types.ts
new file mode 100644
index 0000000..78b2dc5
--- /dev/null
+++ b/packages/core/src/weth/types.ts
@@ -0,0 +1,3 @@
+import type { BaseERC20 } from "../index.js";
+
+export type WETH = BaseERC20<"weth">;
diff --git a/packages/core/src/weth/utils.test.ts b/packages/core/src/weth/utils.test.ts
new file mode 100644
index 0000000..0cf8c4e
--- /dev/null
+++ b/packages/core/src/weth/utils.test.ts
@@ -0,0 +1,21 @@
+import { zeroAddress } from "viem";
+import { foundry } from "viem/chains";
+import { describe, expect, test } from "vitest";
+import { createWETH } from "./utils.js";
+
+const weth = {
+ type: "weth",
+ name: "Wrapped Ether",
+ symbol: "WETH",
+ decimals: 18,
+ address: zeroAddress,
+ chainID: foundry.id,
+} as const;
+
+describe("utils", () => {
+ test("can create nativeCurrency", () => {
+ expect(
+ createWETH(zeroAddress, "Wrapped Ether", "WETH", 18, foundry.id),
+ ).toStrictEqual(weth);
+ });
+});
diff --git a/packages/core/src/weth/utils.ts b/packages/core/src/weth/utils.ts
new file mode 100644
index 0000000..177323c
--- /dev/null
+++ b/packages/core/src/weth/utils.ts
@@ -0,0 +1,20 @@
+import { type Address, getAddress } from "viem";
+import type { WETH } from "./types.js";
+
+/**
+ * Creates an {@link WETH}
+ */
+export const createWETH = (
+ address: Address,
+ name: string,
+ symbol: string,
+ decimals: number,
+ chainID: number,
+): WETH => ({
+ type: "weth",
+ address: getAddress(address),
+ name,
+ symbol,
+ decimals,
+ chainID,
+});
diff --git a/packages/core/src/weth/writes.test.ts b/packages/core/src/weth/writes.test.ts
new file mode 100644
index 0000000..add8567
--- /dev/null
+++ b/packages/core/src/weth/writes.test.ts
@@ -0,0 +1,98 @@
+import invariant from "tiny-invariant";
+import type { Hex } from "viem";
+import { foundry } from "viem/chains";
+import { beforeEach, describe, expect, test } from "vitest";
+import WETH9Bytecode from "../../../../contracts/out/WETH9.sol/WETH9.json";
+import { ALICE } from "../_test/constants.js";
+import { publicClient, testClient, walletClient } from "../_test/utils.js";
+import { createAmountFromString } from "../amountUtils.js";
+import { weth9ABI } from "../generated.js";
+import { erc20BalanceOf } from "../index.js";
+import { readAndParse } from "../readUtils.js";
+import type { WETH } from "./types.js";
+import { createWETH } from "./utils.js";
+import { wethDeposit, wethWithdraw } from "./writes.js";
+
+let id: Hex | undefined = undefined;
+
+let weth: WETH;
+
+beforeEach(async () => {
+ if (id === undefined) {
+ const deployHash = await walletClient.deployContract({
+ abi: weth9ABI,
+ bytecode: WETH9Bytecode.bytecode.object as Hex,
+ });
+
+ const { contractAddress } = await publicClient.waitForTransactionReceipt({
+ hash: deployHash,
+ });
+ invariant(contractAddress);
+ weth = createWETH(contractAddress, "name", "symbol", 18, foundry.id);
+ } else {
+ await testClient.revert({ id });
+ }
+
+ id = await testClient.snapshot();
+});
+
+describe("weth writes", async () => {
+ test("deposit", async () => {
+ const { hash } = await wethDeposit(publicClient, walletClient, ALICE, {
+ amount: createAmountFromString(weth, "1"),
+ });
+
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ const balance = await readAndParse(
+ publicClient,
+ erc20BalanceOf({ erc20: weth, address: ALICE }),
+ );
+
+ expect(balance.amount).toBe(10n ** 18n);
+ expect(balance.token).toStrictEqual(weth);
+ });
+
+ test("deposit", async () => {
+ const { hash } = await wethDeposit(publicClient, walletClient, ALICE, {
+ amount: createAmountFromString(weth, "1"),
+ });
+
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ const balance = await readAndParse(
+ publicClient,
+ erc20BalanceOf({ erc20: weth, address: ALICE }),
+ );
+
+ expect(balance.amount).toBe(10n ** 18n);
+ expect(balance.token).toStrictEqual(weth);
+ });
+
+ test("withdraw", async () => {
+ const { hash } = await wethDeposit(publicClient, walletClient, ALICE, {
+ amount: createAmountFromString(weth, "1"),
+ });
+
+ await publicClient.waitForTransactionReceipt({ hash });
+
+ const { hash: withdrawHash } = await wethWithdraw(
+ publicClient,
+ walletClient,
+ ALICE,
+ {
+ amount: createAmountFromString(weth, "1"),
+ },
+ );
+
+ await publicClient.waitForTransactionReceipt({ hash: withdrawHash });
+
+ const balance = await readAndParse(
+ publicClient,
+ erc20BalanceOf({ erc20: weth, address: ALICE }),
+ );
+
+ expect(balance.amount).toBe(0n);
+ expect(balance.token).toStrictEqual(weth);
+ });
+});
diff --git a/packages/core/src/weth/writes.ts b/packages/core/src/weth/writes.ts
new file mode 100644
index 0000000..ffd3d5f
--- /dev/null
+++ b/packages/core/src/weth/writes.ts
@@ -0,0 +1,42 @@
+import type { Account, Address, PublicClient, WalletClient } from "viem";
+import { weth9ABI } from "../generated.js";
+import type { ERC20Amount, ReverseMirageWrite } from "../index.js";
+import type { WETH } from "./types.js";
+
+export const wethDeposit = async (
+ publicClient: PublicClient,
+ walletClient: WalletClient,
+ account: Account | Address,
+ args: {
+ amount: ERC20Amount;
+ },
+): Promise> => {
+ const { request, result } = await publicClient.simulateContract({
+ address: args.amount.token.address,
+ abi: weth9ABI,
+ functionName: "deposit",
+ account,
+ value: args.amount.amount,
+ });
+ const hash = await walletClient.writeContract(request);
+ return { hash, result, request };
+};
+
+export const wethWithdraw = async (
+ publicClient: PublicClient,
+ walletClient: WalletClient,
+ account: Account | Address,
+ args: {
+ amount: ERC20Amount;
+ },
+): Promise> => {
+ const { request, result } = await publicClient.simulateContract({
+ address: args.amount.token.address,
+ abi: weth9ABI,
+ functionName: "withdraw",
+ account,
+ args: [args.amount.amount],
+ });
+ const hash = await walletClient.writeContract(request);
+ return { hash, result, request };
+};