├── .gitignore
├── .prettierrc
├── LICENSE
├── README.md
├── jest.config.js
├── package.json
├── src
├── __tests__
│ └── marketplace.test.ts
├── client.ts
├── escrow.ts
├── index.ts
├── instructions
│ ├── createAuctionHouse.ts
│ ├── index.ts
│ └── updateAuctionHouse.ts
├── ipfs.ts
├── listings.ts
├── marketplace.ts
├── offers.ts
├── transaction.ts
├── treasury.ts
└── types.ts
├── tsconfig.json
└── yarn.lock
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 | yarn-debug.log*
6 | yarn-error.log*
7 | lerna-debug.log*
8 |
9 | # Diagnostic reports (https://nodejs.org/api/report.html)
10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11 |
12 | # Runtime data
13 | pids
14 | *.pid
15 | *.seed
16 | *.pid.lock
17 |
18 | # Directory for instrumented libs generated by jscoverage/JSCover
19 | lib-cov
20 |
21 | # Coverage directory used by tools like istanbul
22 | coverage
23 | *.lcov
24 |
25 | # nyc test coverage
26 | .nyc_output
27 |
28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29 | .grunt
30 |
31 | # Bower dependency directory (https://bower.io/)
32 | bower_components
33 |
34 | # node-waf configuration
35 | .lock-wscript
36 |
37 | # Compiled binary addons (https://nodejs.org/api/addons.html)
38 | build/Release
39 |
40 | # Dependency directories
41 | node_modules/
42 | jspm_packages/
43 |
44 | # TypeScript v1 declaration files
45 | typings/
46 |
47 | # TypeScript cache
48 | *.tsbuildinfo
49 |
50 | # Optional npm cache directory
51 | .npm
52 |
53 | # Optional eslint cache
54 | .eslintcache
55 |
56 | # Microbundle cache
57 | .rpt2_cache/
58 | .rts2_cache_cjs/
59 | .rts2_cache_es/
60 | .rts2_cache_umd/
61 |
62 | # Optional REPL history
63 | .node_repl_history
64 |
65 | # Output of 'npm pack'
66 | *.tgz
67 |
68 | # Yarn Integrity file
69 | .yarn-integrity
70 |
71 | # dotenv environment variables file
72 | .env
73 | .env.test
74 |
75 | # parcel-bundler cache (https://parceljs.org/)
76 | .cache
77 |
78 | # Next.js build output
79 | .next
80 |
81 | # Nuxt.js build / generate output
82 | .nuxt
83 | dist
84 |
85 | # Gatsby files
86 | .cache/
87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js
88 | # https://nextjs.org/blog/next-9-1#public-directory-support
89 | # public
90 |
91 | # vuepress build output
92 | .vuepress/dist
93 |
94 | # Serverless directories
95 | .serverless/
96 |
97 | # FuseBox cache
98 | .fusebox/
99 |
100 | # DynamoDB Local files
101 | .dynamodb/
102 |
103 | # TernJS port file
104 | .tern-port
105 |
--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 | "trailingComma": "es5",
3 | "tabWidth": 2,
4 | "semi": false,
5 | "singleQuote": true
6 | }
7 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Holaplex Marketplace Standard JS SDK
2 |
3 | Submit actions to the [Metaplex Auction House](https://docs.metaplex.com/auction-house/definition) program that adhere to the Holaplex Marketplace Standard. Its recommend to leverage the sdk with typescript to get access to the package type definitions and code completion.
4 |
5 | ## Setup
6 |
7 | Install the package from npm using your favorite package manager.
8 |
9 | ```shell
10 | npm install -S @holaplex/marketplace-js-sdk
11 | yarn add @holaplex/marketplace-js-sdk
12 | ```
13 |
14 | ## Usage
15 |
16 | Examples of using the sdk from different javascript based development environments.
17 |
18 | ### React
19 |
20 | ```typescript
21 | import { initMarketplaceSDK, AuctionHouse, Nft } from '@holaplex/marketplace-js-sdk'
22 | import { useConnection, useWallet } from '@solana/wallet-adapter-react'
23 |
24 | interface PageProps {
25 | auctionHouse: AuctionHouse
26 | nft: Nft
27 | }
28 |
29 | const Page = ({ auctionHouse, nft }: PageProps) => {
30 | const wallet = useWallet()
31 | const connection = useConnection()
32 |
33 | const sdk = useMemo(() => initMarketplaceSDK(connection, wallet), [connection, wallet])
34 |
35 | const onListNft = ({ amount }: <{ amount: number }>) => {
36 | await sdk.transaction().add(sdk.listings(auctionHouse).post({ amount, nft })).send()
37 | }
38 |
39 | const onMakeOffer = ({ amount }: <{ amount: number }>) => {
40 | await sdk.transaction().add(sdk.offers(auctionHouse).make({ amount, nft })).send()
41 | }
42 |
43 | return (
44 | ...
45 | )
46 | }
47 | ```
48 |
49 | ## Deploy
50 |
51 | ```
52 | yarn build
53 | ```
54 |
55 | ## Publish
56 |
57 | ```
58 | npm publish
59 | ```
60 |
61 | ## Contribute
62 |
63 | As with all [Holaplex](https://www.holaplex.com/) repositories contributions are welcome. Please fork and publish a pull request with any fixes or enhancements.
64 |
--------------------------------------------------------------------------------
/jest.config.js:
--------------------------------------------------------------------------------
1 | /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
2 | module.exports = {
3 | preset: 'ts-jest',
4 | testEnvironment: 'node',
5 | };
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@holaplex/marketplace-js-sdk",
3 | "version": "0.2.8",
4 | "description": "Holaplex Marketplace Standard Actions for the Metaplex Auction House program",
5 | "types": "dist/index.d.ts",
6 | "main": "dist/index.js",
7 | "files": [
8 | "/dist"
9 | ],
10 | "scripts": {
11 | "build": "tsc",
12 | "test": "yarn jest"
13 | },
14 | "repository": {
15 | "type": "git",
16 | "url": "git+https://github.com/holaplex/marketplace-js-sdk.git"
17 | },
18 | "keywords": [
19 | "solana",
20 | "metaplex",
21 | "holaplex"
22 | ],
23 | "author": "Holaplex Engineering ",
24 | "license": "AGPL-3.0-only",
25 | "bugs": {
26 | "url": "https://github.com/holaplex/marketplace-js-sdk/issues"
27 | },
28 | "homepage": "https://github.com/holaplex/marketplace-js-sdk#readme",
29 | "devDependencies": {
30 | "@types/jest": "^27.4.1",
31 | "jest": "^27.5.1",
32 | "ts-jest": "^27.1.4",
33 | "typescript": "^4.6.3"
34 | },
35 | "dependencies": {
36 | "@metaplex-foundation/beet": "^0.4.0",
37 | "@metaplex-foundation/mpl-auction-house": "^1.1.1",
38 | "@metaplex/js": "^4.12.0",
39 | "@solana/spl-token": "0.1.8",
40 | "@solana/spl-token-registry": "^0.2.4574",
41 | "@solana/wallet-adapter-react": "^0.15.4",
42 | "@solana/web3.js": "1.37.1",
43 | "bn.js": "^5.2.0"
44 | }
45 | }
46 |
--------------------------------------------------------------------------------
/src/__tests__/marketplace.test.ts:
--------------------------------------------------------------------------------
1 | import { clusterApiUrl, Connection, Keypair } from '@solana/web3.js'
2 | import { NodeWallet } from '@metaplex/js'
3 | import { initMarketplaceSDK, MarketplaceClient } from '../marketplace'
4 | import { OffersClient } from '../offers'
5 | import { ListingsClient } from '../listings'
6 | import { AuctionHouse } from '../types'
7 |
8 | describe('marketplaces', () => {
9 | let sdk: MarketplaceClient
10 |
11 | beforeEach(() => {
12 | const connection = new Connection(clusterApiUrl('devnet'))
13 | const wallet = new NodeWallet(Keypair.generate())
14 |
15 | sdk = initMarketplaceSDK(connection, wallet)
16 | })
17 |
18 | describe('initMarketplaceSDK', () => {
19 | it('returns a new MarketplaceClient', () => {
20 | expect(sdk).toBeInstanceOf(MarketplaceClient)
21 | })
22 | })
23 |
24 | describe('MarketplaceClient', () => {
25 | let auctionHouse: AuctionHouse
26 |
27 | beforeEach(() => {
28 | auctionHouse = {
29 | address: '8et18wjPAf9TUsvKrt7wmKxFWjo4tz2rTJoHnuL6PzgX',
30 | treasuryMint: 'So11111111111111111111111111111111111111112',
31 | auctionHouseTreasury: 'FqLZuGRWjAX2hWybQidF1USws7xa5MKiiro8afUidrBJ',
32 | treasuryWithdrawalDestination: 'ohs9X6mPZG3mLqdPheYpEGvvXZkGwVFdV1ec8WbTecV',
33 | feeWithdrawalDestination: 'ohs9X6mPZG3mLqdPheYpEGvvXZkGwVFdV1ec8WbTecV',
34 | authority: 'ohs9X6mPZG3mLqdPheYpEGvvXZkGwVFdV1ec8WbTecV',
35 | creator: 'ohs9X6mPZG3mLqdPheYpEGvvXZkGwVFdV1ec8WbTecV',
36 | auctionHouseFeeAccount: '2kPTuBsUyao3uT5dtLjVCK5RdvK4CX1cEKMDaxaeugiM',
37 | bump: 254,
38 | treasuryBump: 255,
39 | feePayerBump: 255,
40 | sellerFeeBasisPoints: 100,
41 | requiresSignOff: false,
42 | canChangeSalePrice: false
43 | }
44 | })
45 |
46 | describe('#offers', () => {
47 | it('returns an OffersClient', () => {
48 | expect(sdk.offers(auctionHouse)).toBeInstanceOf(OffersClient)
49 | })
50 | })
51 |
52 | describe('#listings', () => {
53 | it('returns a ListingsClient', () => {
54 | expect(sdk.listings(auctionHouse)).toBeInstanceOf(ListingsClient)
55 | })
56 | })
57 | })
58 | })
--------------------------------------------------------------------------------
/src/client.ts:
--------------------------------------------------------------------------------
1 | import { Connection } from '@solana/web3.js'
2 | import { Wallet } from '@metaplex/js'
3 | import { TransactionBuilder } from './transaction'
4 |
5 | export abstract class Client {
6 | public connection: Connection
7 | public wallet: Wallet
8 |
9 |
10 | constructor(connection: Connection, wallet: Wallet) {
11 | this.connection = connection
12 | this.wallet = wallet
13 | }
14 |
15 | transaction() {
16 | return new TransactionBuilder(this.connection, this.wallet)
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/src/escrow.ts:
--------------------------------------------------------------------------------
1 | import { Client } from './client'
2 | import { AuctionHouseProgram } from '@metaplex-foundation/mpl-auction-house'
3 | import { PublicKey, Transaction, Connection, Keypair } from '@solana/web3.js'
4 | import { AuctionHouse } from './types'
5 | import {
6 | TOKEN_PROGRAM_ID,
7 | NATIVE_MINT,
8 | Token,
9 | ASSOCIATED_TOKEN_PROGRAM_ID,
10 | } from '@solana/spl-token'
11 | import { Wallet } from '@metaplex/js'
12 | import { PendingTransaction } from './transaction'
13 |
14 | const { instructions } = AuctionHouseProgram
15 | const { createDepositInstruction, createWithdrawInstruction } = instructions
16 |
17 | export interface DepositParams {
18 | amount: number
19 | }
20 |
21 | export interface WithdrawParams {
22 | amount: number
23 | }
24 |
25 | export class EscrowClient extends Client {
26 | private auctionHouse: AuctionHouse
27 |
28 | constructor(
29 | connection: Connection,
30 | wallet: Wallet,
31 | auctionHouse: AuctionHouse
32 | ) {
33 | super(connection, wallet)
34 |
35 | this.auctionHouse = auctionHouse
36 | }
37 |
38 | async desposit({ amount }: DepositParams): Promise {
39 | const { publicKey } = this.wallet
40 | const ah = this.auctionHouse
41 | const buyerPrice = amount
42 | const auctionHouse = new PublicKey(ah.address)
43 | const authority = new PublicKey(ah.authority)
44 | const auctionHouseFeeAccount = new PublicKey(ah.auctionHouseFeeAccount)
45 | const treasuryMint = new PublicKey(ah.treasuryMint)
46 | const isSplMint = !treasuryMint.equals(NATIVE_MINT)
47 |
48 | let signatures: Keypair[] = []
49 | let splTokenTransferAuthority = Keypair.generate()
50 | let transferAuthority = publicKey
51 | let paymentAccount = publicKey
52 |
53 | if (isSplMint) {
54 | signatures = [...signatures, splTokenTransferAuthority]
55 | transferAuthority = splTokenTransferAuthority.publicKey
56 | const buyerAssociatedTokenAccount = await Token.getAssociatedTokenAddress(
57 | ASSOCIATED_TOKEN_PROGRAM_ID,
58 | TOKEN_PROGRAM_ID,
59 | treasuryMint,
60 | publicKey
61 | )
62 | paymentAccount = buyerAssociatedTokenAccount
63 | }
64 |
65 | const [escrowPaymentAccount, escrowPaymentBump] =
66 | await AuctionHouseProgram.findEscrowPaymentAccountAddress(
67 | auctionHouse,
68 | publicKey
69 | )
70 |
71 | const txt = new Transaction()
72 |
73 | const depositInstructionAccounts = {
74 | wallet: publicKey,
75 | paymentAccount: paymentAccount,
76 | transferAuthority: transferAuthority,
77 | treasuryMint,
78 | escrowPaymentAccount,
79 | authority,
80 | auctionHouse,
81 | auctionHouseFeeAccount,
82 | }
83 | const depositInstructionArgs = {
84 | escrowPaymentBump,
85 | amount: buyerPrice,
86 | }
87 |
88 | const depositInstruction = createDepositInstruction(
89 | depositInstructionAccounts,
90 | depositInstructionArgs
91 | )
92 |
93 | if (isSplMint) {
94 | const createApproveInstruction = Token.createApproveInstruction(
95 | TOKEN_PROGRAM_ID,
96 | paymentAccount,
97 | transferAuthority,
98 | publicKey,
99 | [],
100 | amount
101 | )
102 |
103 | txt.add(createApproveInstruction)
104 |
105 | depositInstruction.keys.map((key) => {
106 | if (key.pubkey.equals(transferAuthority)) {
107 | key.isSigner = true
108 | }
109 |
110 | return key
111 | })
112 | }
113 |
114 | txt.add(depositInstruction)
115 |
116 | if (isSplMint) {
117 | const createRevokeInstruction = Token.createRevokeInstruction(
118 | TOKEN_PROGRAM_ID,
119 | paymentAccount,
120 | publicKey,
121 | []
122 | )
123 |
124 | txt.add(createRevokeInstruction)
125 | }
126 |
127 | return [txt, signatures]
128 | }
129 |
130 | async withdraw({ amount }: WithdrawParams): Promise {
131 | const ah = this.auctionHouse
132 | const { publicKey } = this.wallet
133 | const auctionHouse = new PublicKey(ah.address)
134 | const authority = new PublicKey(ah.authority)
135 | const auctionHouseFeeAccount = new PublicKey(ah.auctionHouseFeeAccount)
136 | const treasuryMint = new PublicKey(ah.treasuryMint)
137 | const isSplMint = !treasuryMint.equals(NATIVE_MINT)
138 |
139 | const userAssociatedTokenAccount = await Token.getAssociatedTokenAddress(
140 | ASSOCIATED_TOKEN_PROGRAM_ID,
141 | TOKEN_PROGRAM_ID,
142 | treasuryMint,
143 | publicKey
144 | )
145 |
146 | let receiptAccount = publicKey
147 |
148 | if (isSplMint) {
149 | receiptAccount = userAssociatedTokenAccount
150 | }
151 |
152 | const [escrowPaymentAccount, escrowPaymentBump] =
153 | await AuctionHouseProgram.findEscrowPaymentAccountAddress(
154 | auctionHouse,
155 | publicKey
156 | )
157 |
158 | const tx = new Transaction()
159 |
160 | const withdrawInstructionAccounts = {
161 | receiptAccount: receiptAccount,
162 | wallet: publicKey,
163 | escrowPaymentAccount,
164 | auctionHouse,
165 | authority,
166 | treasuryMint,
167 | auctionHouseFeeAccount,
168 | }
169 | const withdrawInstructionArgs = {
170 | escrowPaymentBump,
171 | amount,
172 | }
173 |
174 | const withdrawInstruction = createWithdrawInstruction(
175 | withdrawInstructionAccounts,
176 | withdrawInstructionArgs
177 | )
178 |
179 | tx.add(withdrawInstruction)
180 |
181 | return [tx, []]
182 | }
183 | }
184 |
--------------------------------------------------------------------------------
/src/index.ts:
--------------------------------------------------------------------------------
1 | export * from "./types";
2 | export * from "./marketplace";
3 | export * from "./listings";
4 | export * from "./offers";
5 | export * from "./escrow";
6 | export { AuctionHouseProgram } from "@metaplex-foundation/mpl-auction-house";
7 |
--------------------------------------------------------------------------------
/src/instructions/createAuctionHouse.ts:
--------------------------------------------------------------------------------
1 | import {
2 | PublicKey,
3 | PublicKeyInitData,
4 | TransactionInstruction,
5 | } from "@solana/web3.js";
6 | import { NATIVE_MINT } from "@solana/spl-token";
7 | import { Wallet } from "@metaplex/js";
8 | import { AuctionHouseProgram } from "@metaplex-foundation/mpl-auction-house";
9 |
10 | const { createCreateAuctionHouseInstruction } =
11 | AuctionHouseProgram.instructions;
12 |
13 | interface CreateAuctionHouseParams {
14 | wallet: Wallet;
15 | sellerFeeBasisPoints: number;
16 | canChangeSalePrice?: boolean;
17 | requiresSignOff?: boolean;
18 | treasuryWithdrawalDestination?: PublicKeyInitData;
19 | feeWithdrawalDestination?: PublicKeyInitData;
20 | treasuryMint?: PublicKeyInitData;
21 | }
22 |
23 | export const createAuctionHouse = async (
24 | params: CreateAuctionHouseParams
25 | ): Promise => {
26 | const {
27 | wallet,
28 | sellerFeeBasisPoints,
29 | canChangeSalePrice = false,
30 | requiresSignOff = false,
31 | treasuryWithdrawalDestination,
32 | feeWithdrawalDestination,
33 | treasuryMint,
34 | } = params;
35 |
36 | const twdKey = treasuryWithdrawalDestination
37 | ? new PublicKey(treasuryWithdrawalDestination)
38 | : wallet.publicKey;
39 |
40 | const fwdKey = feeWithdrawalDestination
41 | ? new PublicKey(feeWithdrawalDestination)
42 | : wallet.publicKey;
43 |
44 | const tMintKey = treasuryMint ? new PublicKey(treasuryMint) : NATIVE_MINT;
45 |
46 | const twdAta = tMintKey.equals(NATIVE_MINT)
47 | ? twdKey
48 | : (
49 | await AuctionHouseProgram.findAssociatedTokenAccountAddress(
50 | tMintKey,
51 | twdKey
52 | )
53 | )[0];
54 |
55 | const [auctionHouse, bump] =
56 | await AuctionHouseProgram.findAuctionHouseAddress(
57 | wallet.publicKey,
58 | tMintKey
59 | );
60 |
61 | const [feeAccount, feePayerBump] =
62 | await AuctionHouseProgram.findAuctionHouseFeeAddress(auctionHouse);
63 |
64 | const [treasuryAccount, treasuryBump] =
65 | await AuctionHouseProgram.findAuctionHouseTreasuryAddress(auctionHouse);
66 |
67 | return createCreateAuctionHouseInstruction(
68 | {
69 | treasuryMint: tMintKey,
70 | payer: wallet.publicKey,
71 | authority: wallet.publicKey,
72 | feeWithdrawalDestination: fwdKey,
73 | treasuryWithdrawalDestination: twdAta,
74 | treasuryWithdrawalDestinationOwner: twdKey,
75 | auctionHouse,
76 | auctionHouseFeeAccount: feeAccount,
77 | auctionHouseTreasury: treasuryAccount,
78 | },
79 | {
80 | bump,
81 | feePayerBump,
82 | treasuryBump,
83 | sellerFeeBasisPoints,
84 | requiresSignOff,
85 | canChangeSalePrice,
86 | }
87 | );
88 | };
89 |
--------------------------------------------------------------------------------
/src/instructions/index.ts:
--------------------------------------------------------------------------------
1 | export * from './updateAuctionHouse'
2 | export * from './createAuctionHouse'
3 |
--------------------------------------------------------------------------------
/src/instructions/updateAuctionHouse.ts:
--------------------------------------------------------------------------------
1 | import {
2 | PublicKey,
3 | PublicKeyInitData,
4 | TransactionInstruction,
5 | } from '@solana/web3.js'
6 | import { NATIVE_MINT } from '@solana/spl-token'
7 | import { Wallet } from '@metaplex/js'
8 | import { AuctionHouseProgram } from '@metaplex-foundation/mpl-auction-house'
9 |
10 | const { createUpdateAuctionHouseInstruction } = AuctionHouseProgram.instructions
11 |
12 | interface UpdateAuctionHouseParams {
13 | wallet: Wallet
14 | sellerFeeBasisPoints: number
15 | canChangeSalePrice?: boolean
16 | requiresSignOff?: boolean
17 | treasuryWithdrawalDestination?: PublicKeyInitData
18 | feeWithdrawalDestination?: PublicKeyInitData
19 | treasuryMint?: PublicKeyInitData
20 | }
21 |
22 | export const updateAuctionHouse = async (
23 | params: UpdateAuctionHouseParams
24 | ): Promise => {
25 | const {
26 | wallet,
27 | sellerFeeBasisPoints,
28 | canChangeSalePrice = false,
29 | requiresSignOff = false,
30 | treasuryWithdrawalDestination,
31 | feeWithdrawalDestination,
32 | treasuryMint,
33 | } = params
34 |
35 | const twdKey = treasuryWithdrawalDestination
36 | ? new PublicKey(treasuryWithdrawalDestination)
37 | : wallet.publicKey
38 |
39 | const fwdKey = feeWithdrawalDestination
40 | ? new PublicKey(feeWithdrawalDestination)
41 | : wallet.publicKey
42 |
43 | const tMintKey = treasuryMint ? new PublicKey(treasuryMint) : NATIVE_MINT
44 |
45 | const twdAta = tMintKey.equals(NATIVE_MINT)
46 | ? twdKey
47 | : (
48 | await AuctionHouseProgram.findAssociatedTokenAccountAddress(
49 | tMintKey,
50 | twdKey
51 | )
52 | )[0]
53 |
54 | const [auctionHouse] = await AuctionHouseProgram.findAuctionHouseAddress(
55 | wallet.publicKey,
56 | tMintKey
57 | )
58 |
59 | return createUpdateAuctionHouseInstruction(
60 | {
61 | treasuryMint: tMintKey,
62 | payer: wallet.publicKey,
63 | authority: wallet.publicKey,
64 | newAuthority: wallet.publicKey,
65 | feeWithdrawalDestination: fwdKey,
66 | treasuryWithdrawalDestination: twdAta,
67 | treasuryWithdrawalDestinationOwner: twdKey,
68 | auctionHouse,
69 | },
70 | {
71 | sellerFeeBasisPoints,
72 | requiresSignOff,
73 | canChangeSalePrice,
74 | }
75 | )
76 | }
77 |
--------------------------------------------------------------------------------
/src/ipfs.ts:
--------------------------------------------------------------------------------
1 | interface FileUploadResponse {
2 | name: string
3 | type: string
4 | uri: string
5 | error?: string
6 | }
7 |
8 | interface IpfsSender {
9 | uploadFile: (file: File) => Promise
10 | }
11 |
12 | const ipfsSDK = {
13 | uploadFile: async (file) => {
14 | const body = new FormData()
15 | console.log('file', file)
16 | body.append(file.name, file, file.name)
17 | try {
18 | const resp = await fetch('https://market.holaplex.com/api/ipfs/upload', {
19 | method: 'POST',
20 | body,
21 | })
22 | const json = await resp.json()
23 | if (json) {
24 | return json.files[0] as FileUploadResponse
25 | }
26 | } catch (e: any) {
27 | console.error('Could not upload file', e)
28 | throw new Error(e)
29 | }
30 | },
31 | } as IpfsSender
32 |
33 | export default ipfsSDK
34 |
--------------------------------------------------------------------------------
/src/listings.ts:
--------------------------------------------------------------------------------
1 | import { AuctionHouseProgram } from '@metaplex-foundation/mpl-auction-house'
2 | import {
3 | SYSVAR_INSTRUCTIONS_PUBKEY,
4 | PublicKey,
5 | Transaction,
6 | Connection,
7 | TransactionInstruction,
8 | AccountMeta,
9 | } from '@solana/web3.js'
10 | import { Wallet } from '@metaplex/js'
11 | import {
12 | ASSOCIATED_TOKEN_PROGRAM_ID,
13 | NATIVE_MINT,
14 | Token,
15 | TOKEN_PROGRAM_ID,
16 | } from '@solana/spl-token'
17 | import { Client } from './client'
18 | import { PendingTransaction } from './transaction'
19 | import { AuctionHouse, Nft, AhListing } from './types'
20 |
21 | const { instructions } = AuctionHouseProgram
22 |
23 | const {
24 | createSellInstruction,
25 | createPrintListingReceiptInstruction,
26 | createPrintPurchaseReceiptInstruction,
27 | createCancelInstruction,
28 | createCancelListingReceiptInstruction,
29 | createExecuteSaleInstruction
30 | } = instructions
31 |
32 | export interface PostListingParams {
33 | amount: number
34 | nft: Nft
35 | }
36 |
37 | export interface CancelListingParams {
38 | listing: AhListing
39 | nft: Nft
40 | }
41 |
42 | export interface BuyListingParams {
43 | listing: AhListing
44 | nft: Nft
45 | }
46 |
47 | export class ListingsClient extends Client {
48 | private auctionHouse: AuctionHouse
49 |
50 | constructor(
51 | connection: Connection,
52 | wallet: Wallet,
53 | auctionHouse: AuctionHouse
54 | ) {
55 | super(connection, wallet)
56 |
57 | this.auctionHouse = auctionHouse
58 | }
59 |
60 | async post({ amount, nft }: PostListingParams): Promise {
61 | const { publicKey } = this.wallet
62 | const ah = this.auctionHouse
63 | const buyerPrice = amount
64 | const auctionHouse = new PublicKey(ah.address)
65 | const authority = new PublicKey(ah.authority)
66 | const auctionHouseFeeAccount = new PublicKey(ah.auctionHouseFeeAccount)
67 | const treasuryMint = new PublicKey(ah.treasuryMint)
68 | const tokenMint = new PublicKey(nft.mintAddress)
69 | const metadata = new PublicKey(nft.address)
70 |
71 | const associatedTokenAccount = new PublicKey(
72 | nft.owner.associatedTokenAccountAddress
73 | )
74 |
75 | const [sellerTradeState, tradeStateBump] =
76 | await AuctionHouseProgram.findTradeStateAddress(
77 | publicKey,
78 | auctionHouse,
79 | associatedTokenAccount,
80 | treasuryMint,
81 | tokenMint,
82 | buyerPrice,
83 | 1
84 | )
85 |
86 | const [programAsSigner, programAsSignerBump] =
87 | await AuctionHouseProgram.findAuctionHouseProgramAsSignerAddress()
88 |
89 | const [freeTradeState, freeTradeBump] =
90 | await AuctionHouseProgram.findTradeStateAddress(
91 | publicKey,
92 | auctionHouse,
93 | associatedTokenAccount,
94 | treasuryMint,
95 | tokenMint,
96 | 0,
97 | 1
98 | )
99 |
100 | const txt = new Transaction()
101 |
102 | const sellInstructionArgs = {
103 | tradeStateBump,
104 | freeTradeStateBump: freeTradeBump,
105 | programAsSignerBump: programAsSignerBump,
106 | buyerPrice,
107 | tokenSize: 1,
108 | }
109 |
110 | const sellInstructionAccounts = {
111 | wallet: publicKey,
112 | tokenAccount: associatedTokenAccount,
113 | metadata: metadata,
114 | authority: authority,
115 | auctionHouse: auctionHouse,
116 | auctionHouseFeeAccount: auctionHouseFeeAccount,
117 | sellerTradeState: sellerTradeState,
118 | freeSellerTradeState: freeTradeState,
119 | programAsSigner: programAsSigner,
120 | }
121 |
122 | const sellInstruction = createSellInstruction(
123 | sellInstructionAccounts,
124 | sellInstructionArgs
125 | )
126 |
127 | const [receipt, receiptBump] =
128 | await AuctionHouseProgram.findListingReceiptAddress(sellerTradeState)
129 |
130 | const printListingReceiptInstruction = createPrintListingReceiptInstruction(
131 | {
132 | receipt,
133 | bookkeeper: publicKey,
134 | instruction: SYSVAR_INSTRUCTIONS_PUBKEY,
135 | },
136 | {
137 | receiptBump,
138 | }
139 | )
140 |
141 | txt.add(sellInstruction).add(printListingReceiptInstruction)
142 |
143 | return [txt, []]
144 | }
145 |
146 | async cancel({
147 | listing,
148 | nft,
149 | }: CancelListingParams): Promise {
150 | const { publicKey } = this.wallet
151 | const ah = this.auctionHouse
152 | const auctionHouse = new PublicKey(ah.address)
153 | const authority = new PublicKey(ah.authority)
154 | const auctionHouseFeeAccount = new PublicKey(ah.auctionHouseFeeAccount)
155 | const tokenMint = new PublicKey(nft.mintAddress)
156 | const treasuryMint = new PublicKey(ah.treasuryMint)
157 | const tokenAccount = new PublicKey(nft.owner.associatedTokenAccountAddress)
158 | const buyerPrice = listing.price.toNumber()
159 |
160 | const [tradeState] = await AuctionHouseProgram.findTradeStateAddress(
161 | publicKey,
162 | auctionHouse,
163 | tokenAccount,
164 | treasuryMint,
165 | tokenMint,
166 | buyerPrice,
167 | 1
168 | )
169 |
170 | const [listingReceipt, _listingReceiptBump] =
171 | await AuctionHouseProgram.findListingReceiptAddress(
172 | new PublicKey(listing.tradeState)
173 | )
174 |
175 | const cancelInstructionAccounts = {
176 | wallet: publicKey,
177 | tokenAccount,
178 | tokenMint,
179 | authority,
180 | auctionHouse,
181 | auctionHouseFeeAccount,
182 | tradeState,
183 | }
184 | const cancelInstructionArgs = {
185 | buyerPrice,
186 | tokenSize: 1,
187 | }
188 |
189 | const cancelListingReceiptAccounts = {
190 | receipt: listingReceipt,
191 | instruction: SYSVAR_INSTRUCTIONS_PUBKEY,
192 | }
193 |
194 | const cancelInstruction = createCancelInstruction(
195 | cancelInstructionAccounts,
196 | cancelInstructionArgs
197 | )
198 | const cancelListingReceiptInstruction =
199 | createCancelListingReceiptInstruction(cancelListingReceiptAccounts)
200 |
201 | const txt = new Transaction()
202 |
203 | txt.add(cancelInstruction).add(cancelListingReceiptInstruction)
204 |
205 | return [txt, []]
206 | }
207 |
208 | async buy({ listing, nft }: BuyListingParams): Promise {
209 | const { publicKey } = this.wallet
210 | const ah = this.auctionHouse
211 | const auctionHouse = new PublicKey(ah.address)
212 | const authority = new PublicKey(ah.authority)
213 | const auctionHouseFeeAccount = new PublicKey(ah.auctionHouseFeeAccount)
214 | const treasuryMint = new PublicKey(ah.treasuryMint)
215 | const seller = new PublicKey(listing.seller)
216 | const tokenMint = new PublicKey(nft.mintAddress)
217 | const auctionHouseTreasury = new PublicKey(ah.auctionHouseTreasury)
218 | const sellerTradeState = new PublicKey(listing.tradeState)
219 | const buyerPrice = listing.price.toNumber()
220 | const tokenAccount = new PublicKey(nft.owner.associatedTokenAccountAddress)
221 | const metadata = new PublicKey(nft.address)
222 | const isNative = treasuryMint.equals(NATIVE_MINT)
223 |
224 | const [listingReceipt, _listingReceiptBump] =
225 | await AuctionHouseProgram.findListingReceiptAddress(
226 | new PublicKey(listing.tradeState)
227 | )
228 |
229 | let sellerPaymentReceiptAccount = await Token.getAssociatedTokenAddress(
230 | ASSOCIATED_TOKEN_PROGRAM_ID,
231 | TOKEN_PROGRAM_ID,
232 | treasuryMint,
233 | seller
234 | )
235 |
236 | if (isNative) {
237 | sellerPaymentReceiptAccount = seller
238 | }
239 |
240 | const [escrowPaymentAccount, escrowPaymentBump] =
241 | await AuctionHouseProgram.findEscrowPaymentAccountAddress(
242 | auctionHouse,
243 | publicKey
244 | )
245 |
246 | const [buyerTradeState, _tradeStateBump] =
247 | await AuctionHouseProgram.findPublicBidTradeStateAddress(
248 | publicKey,
249 | auctionHouse,
250 | treasuryMint,
251 | tokenMint,
252 | buyerPrice,
253 | 1
254 | )
255 | const [freeTradeState, freeTradeStateBump] =
256 | await AuctionHouseProgram.findTradeStateAddress(
257 | seller,
258 | auctionHouse,
259 | tokenAccount,
260 | treasuryMint,
261 | tokenMint,
262 | 0,
263 | 1
264 | )
265 | const [programAsSigner, programAsSignerBump] =
266 | await AuctionHouseProgram.findAuctionHouseProgramAsSignerAddress()
267 | const [buyerReceiptTokenAccount] =
268 | await AuctionHouseProgram.findAssociatedTokenAccountAddress(
269 | tokenMint,
270 | publicKey
271 | )
272 |
273 | const [bidReceipt, _bidReceiptBump] =
274 | await AuctionHouseProgram.findBidReceiptAddress(buyerTradeState)
275 | const [purchaseReceipt, purchaseReceiptBump] =
276 | await AuctionHouseProgram.findPurchaseReceiptAddress(
277 | sellerTradeState,
278 | buyerTradeState
279 | )
280 |
281 | const executeSaleInstructionAccounts = {
282 | buyer: publicKey,
283 | seller,
284 | tokenAccount,
285 | tokenMint,
286 | metadata,
287 | treasuryMint,
288 | escrowPaymentAccount,
289 | sellerPaymentReceiptAccount,
290 | buyerReceiptTokenAccount,
291 | authority,
292 | auctionHouse,
293 | auctionHouseFeeAccount,
294 | auctionHouseTreasury,
295 | buyerTradeState,
296 | sellerTradeState,
297 | freeTradeState,
298 | programAsSigner,
299 | }
300 |
301 | const executeSaleInstructionArgs = {
302 | escrowPaymentBump,
303 | freeTradeStateBump,
304 | programAsSignerBump,
305 | buyerPrice,
306 | tokenSize: 1,
307 | }
308 |
309 | const printPurchaseReceiptAccounts = {
310 | bookkeeper: publicKey,
311 | purchaseReceipt,
312 | bidReceipt,
313 | listingReceipt,
314 | instruction: SYSVAR_INSTRUCTIONS_PUBKEY,
315 | }
316 | const printPurchaseReceiptArgs = {
317 | purchaseReceiptBump,
318 | }
319 |
320 | const executeSaleInstruction = createExecuteSaleInstruction(
321 | executeSaleInstructionAccounts,
322 | executeSaleInstructionArgs
323 | )
324 | const printPurchaseReceiptInstruction =
325 | createPrintPurchaseReceiptInstruction(
326 | printPurchaseReceiptAccounts,
327 | printPurchaseReceiptArgs
328 | )
329 |
330 | const txt = new Transaction()
331 |
332 | let remainingAccounts: AccountMeta[] = []
333 |
334 | for (let creator of nft.creators) {
335 | const creatorAccount = {
336 | pubkey: new PublicKey(creator.address),
337 | isSigner: false,
338 | isWritable: true,
339 | }
340 | remainingAccounts = [...remainingAccounts, creatorAccount]
341 |
342 | if (isNative) {
343 | continue
344 | }
345 |
346 | const pubkey = await Token.getAssociatedTokenAddress(
347 | ASSOCIATED_TOKEN_PROGRAM_ID,
348 | TOKEN_PROGRAM_ID,
349 | treasuryMint,
350 | creatorAccount.pubkey
351 | )
352 |
353 | const creatorAtaAccount = {
354 | pubkey,
355 | isSigner: false,
356 | isWritable: true,
357 | }
358 |
359 | remainingAccounts = [...remainingAccounts, creatorAtaAccount]
360 | }
361 |
362 | txt
363 | .add(
364 | new TransactionInstruction({
365 | programId: AuctionHouseProgram.PUBKEY,
366 | data: executeSaleInstruction.data,
367 | keys: executeSaleInstruction.keys.concat(remainingAccounts),
368 | })
369 | )
370 | .add(printPurchaseReceiptInstruction)
371 |
372 | return [txt, []]
373 | }
374 | }
375 |
--------------------------------------------------------------------------------
/src/marketplace.ts:
--------------------------------------------------------------------------------
1 | import { Connection, PublicKey, Transaction } from '@solana/web3.js'
2 | import { programs, Wallet } from '@metaplex/js'
3 | import { createAuctionHouse, updateAuctionHouse } from './instructions'
4 | import { TokenInfo } from "@solana/spl-token-registry"
5 | import { MarktplaceSettingsPayload, AuctionHouse } from './types'
6 | import ipfsSDK from './ipfs'
7 | import { Client } from './client'
8 | import { OffersClient } from './offers'
9 | import { ListingsClient } from './listings'
10 | import { TreasuryClient } from './treasury'
11 | import { createWithdrawFromTreasuryInstruction } from '@metaplex-foundation/mpl-auction-house/dist/src/generated/instructions'
12 | import { EscrowClient } from './escrow'
13 | import { PendingTransaction } from './transaction'
14 |
15 | const {
16 | metaplex: { Store, SetStoreV2, StoreConfig },
17 | } = programs
18 |
19 | export interface MarketplaceClientParams {
20 | connection: Connection
21 | wallet: Wallet
22 | }
23 |
24 | export class MarketplaceClient extends Client {
25 | static price = function (
26 | priceInUnits: number,
27 | mintInfo: TokenInfo,
28 | precision: number = 5
29 | ) {
30 | const multiplier = Math.pow(10, precision)
31 | const mantissa = 10 ** mintInfo.decimals
32 | return Math.round((priceInUnits / mantissa) * multiplier) / multiplier
33 | }
34 |
35 | static mantissa = function(
36 | price: number,
37 | mintInfo: TokenInfo
38 | ) {
39 | const mantissa = 10 ** mintInfo.decimals
40 | return Math.ceil(price * mantissa)
41 | }
42 |
43 | async create(settings: MarktplaceSettingsPayload, transactionFee: number) {
44 | const wallet = this.wallet
45 | const publicKey = wallet.publicKey as PublicKey
46 | const connection = this.connection
47 |
48 | const storePubkey = await Store.getPDA(publicKey)
49 | const storeConfigPubkey = await StoreConfig.getPDA(storePubkey)
50 |
51 | settings.address.store = storePubkey.toBase58()
52 | settings.address.storeConfig = storeConfigPubkey.toBase58()
53 | settings.address.owner = publicKey.toBase58()
54 |
55 | const storefrontSettings = new File(
56 | [JSON.stringify(settings)],
57 | 'storefront_settings'
58 | )
59 | const { uri } = await ipfsSDK.uploadFile(storefrontSettings)
60 |
61 | const auctionHouseCreateInstruction = await createAuctionHouse({
62 | wallet: wallet as any,
63 | sellerFeeBasisPoints: transactionFee,
64 | treasuryWithdrawalDestination: this.wallet.publicKey.toBase58(),
65 | feeWithdrawalDestination: this.wallet.publicKey.toBase58(),
66 | })
67 |
68 | const setStorefrontV2Instructions = new SetStoreV2(
69 | {
70 | feePayer: publicKey,
71 | },
72 | {
73 | admin: publicKey,
74 | store: storePubkey,
75 | config: storeConfigPubkey,
76 | isPublic: false,
77 | settingsUri: uri,
78 | }
79 | )
80 |
81 | const transaction = new Transaction()
82 |
83 | transaction.add(auctionHouseCreateInstruction)
84 | transaction.add(setStorefrontV2Instructions)
85 |
86 | transaction.feePayer = wallet.publicKey as any
87 | transaction.recentBlockhash = (
88 | await connection.getLatestBlockhash()
89 | ).blockhash
90 |
91 | const signedTransaction = await wallet.signTransaction(transaction)
92 |
93 | const txtId = await connection.sendRawTransaction(
94 | signedTransaction.serialize()
95 | )
96 |
97 | if (txtId) await connection.confirmTransaction(txtId)
98 | }
99 |
100 | async update(
101 | settings: MarktplaceSettingsPayload,
102 | transactionFee: number
103 | ): Promise {
104 | const wallet = this.wallet
105 | const publicKey = wallet.publicKey as PublicKey
106 | const storePubkey = await Store.getPDA(publicKey)
107 | const storeConfigPubkey = await StoreConfig.getPDA(storePubkey)
108 |
109 | settings.address.owner = publicKey.toBase58()
110 | settings.address.store = storePubkey.toBase58()
111 | settings.address.storeConfig = storeConfigPubkey.toBase58()
112 |
113 | const storefrontSettings = new File(
114 | [JSON.stringify(settings)],
115 | 'storefront_settings'
116 | )
117 | const { uri } = await ipfsSDK.uploadFile(storefrontSettings)
118 |
119 | const auctionHouseUpdateInstruction = await updateAuctionHouse({
120 | wallet: wallet as Wallet,
121 | sellerFeeBasisPoints: transactionFee,
122 | })
123 |
124 | const setStorefrontV2Instructions = new SetStoreV2(
125 | {
126 | feePayer: publicKey,
127 | },
128 | {
129 | admin: publicKey,
130 | store: storePubkey,
131 | config: storeConfigPubkey,
132 | isPublic: false,
133 | settingsUri: uri,
134 | }
135 | )
136 | const transaction = new Transaction()
137 |
138 | if (auctionHouseUpdateInstruction) {
139 | transaction.add(auctionHouseUpdateInstruction)
140 | }
141 |
142 | transaction.add(setStorefrontV2Instructions)
143 | return [transaction, []]
144 | }
145 |
146 | offers(auctionHouse: AuctionHouse): OffersClient {
147 | return new OffersClient(this.connection, this.wallet, auctionHouse)
148 | }
149 |
150 | listings(auctionHouse: AuctionHouse): ListingsClient {
151 | return new ListingsClient(this.connection, this.wallet, auctionHouse)
152 | }
153 |
154 | escrow(auctionHouse: AuctionHouse): EscrowClient {
155 | return new EscrowClient(this.connection, this.wallet, auctionHouse)
156 | }
157 |
158 | treasury(auctionHouse: AuctionHouse): TreasuryClient {
159 | return new TreasuryClient(this.connection, this.wallet, auctionHouse)
160 | }
161 | }
162 |
163 | export const initMarketplaceSDK = (
164 | connection: Connection,
165 | wallet: Wallet
166 | ): MarketplaceClient => {
167 | return new MarketplaceClient(connection, wallet)
168 | }
169 |
--------------------------------------------------------------------------------
/src/offers.ts:
--------------------------------------------------------------------------------
1 | import { Client } from './client'
2 | import { AuctionHouseProgram } from '@metaplex-foundation/mpl-auction-house'
3 | import {
4 | SYSVAR_INSTRUCTIONS_PUBKEY,
5 | PublicKey,
6 | Transaction,
7 | Connection,
8 | TransactionInstruction,
9 | Keypair,
10 | AccountMeta,
11 | } from '@solana/web3.js'
12 | import { AuctionHouse, Nft, Offer } from './types'
13 | import {
14 | TOKEN_PROGRAM_ID,
15 | NATIVE_MINT,
16 | Token,
17 | ASSOCIATED_TOKEN_PROGRAM_ID,
18 | } from '@solana/spl-token'
19 | import { Wallet } from '@metaplex/js'
20 | import { PendingTransaction } from './transaction'
21 |
22 | const { instructions } = AuctionHouseProgram
23 | const {
24 | createPrintBidReceiptInstruction,
25 | createPublicBuyInstruction,
26 | createCancelBidReceiptInstruction,
27 | createCancelInstruction,
28 | createSellInstruction,
29 | createPrintListingReceiptInstruction,
30 | createPrintPurchaseReceiptInstruction,
31 | createExecuteSaleInstruction
32 | } = instructions
33 |
34 | export interface MakeOfferParams {
35 | amount: number
36 | nft: Nft
37 | }
38 |
39 | export interface CancelOfferParams {
40 | offer: Offer
41 | nft: Nft
42 | }
43 |
44 | export interface AcceptOfferParams {
45 | offer: Offer
46 | nft: Nft
47 | }
48 |
49 | export class OffersClient extends Client {
50 | private auctionHouse: AuctionHouse
51 |
52 | constructor(
53 | connection: Connection,
54 | wallet: Wallet,
55 | auctionHouse: AuctionHouse
56 | ) {
57 | super(connection, wallet)
58 |
59 | this.auctionHouse = auctionHouse
60 | }
61 |
62 | async make({ amount, nft }: MakeOfferParams): Promise {
63 | const { publicKey } = this.wallet
64 | const ah = this.auctionHouse
65 | const buyerPrice = amount
66 | const auctionHouse = new PublicKey(ah.address)
67 | const authority = new PublicKey(ah.authority)
68 | const auctionHouseFeeAccount = new PublicKey(ah.auctionHouseFeeAccount)
69 | const treasuryMint = new PublicKey(ah.treasuryMint)
70 | const tokenMint = new PublicKey(nft.mintAddress)
71 | const tokenAccount = new PublicKey(nft.owner.associatedTokenAccountAddress)
72 | const metadata = new PublicKey(nft.address)
73 | const isSplMint = !treasuryMint.equals(NATIVE_MINT)
74 |
75 | let splTokenTransferAuthority = Keypair.generate()
76 | let transferAuthority = publicKey
77 | let paymentAccount = publicKey
78 | let signers: Keypair[] = []
79 |
80 | if (isSplMint) {
81 | transferAuthority = splTokenTransferAuthority.publicKey
82 | signers = [...signers, splTokenTransferAuthority]
83 |
84 | const buyerAssociatedTokenAccount = await Token.getAssociatedTokenAddress(
85 | ASSOCIATED_TOKEN_PROGRAM_ID,
86 | TOKEN_PROGRAM_ID,
87 | treasuryMint,
88 | publicKey
89 | )
90 | paymentAccount = buyerAssociatedTokenAccount
91 | }
92 |
93 | const [escrowPaymentAccount, escrowPaymentBump] =
94 | await AuctionHouseProgram.findEscrowPaymentAccountAddress(
95 | auctionHouse,
96 | publicKey
97 | )
98 |
99 | const [buyerTradeState, tradeStateBump] =
100 | await AuctionHouseProgram.findPublicBidTradeStateAddress(
101 | publicKey,
102 | auctionHouse,
103 | treasuryMint,
104 | tokenMint,
105 | buyerPrice,
106 | 1
107 | )
108 |
109 | const txt = new Transaction()
110 |
111 | let publicBuyInstruction = createPublicBuyInstruction(
112 | {
113 | wallet: publicKey,
114 | paymentAccount: publicKey,
115 | transferAuthority: publicKey,
116 | treasuryMint,
117 | tokenAccount,
118 | metadata,
119 | escrowPaymentAccount,
120 | authority,
121 | auctionHouse,
122 | auctionHouseFeeAccount,
123 | buyerTradeState,
124 | },
125 | {
126 | escrowPaymentBump,
127 | tradeStateBump,
128 | tokenSize: 1,
129 | buyerPrice,
130 | }
131 | )
132 |
133 | if (isSplMint) {
134 | publicBuyInstruction.keys.map((key) => {
135 | if (key.pubkey.equals(transferAuthority)) {
136 | key.isSigner = true
137 | }
138 |
139 | return key
140 | })
141 | }
142 |
143 | const [receipt, receiptBump] =
144 | await AuctionHouseProgram.findBidReceiptAddress(buyerTradeState)
145 |
146 | const printBidReceiptInstruction = createPrintBidReceiptInstruction(
147 | {
148 | receipt,
149 | bookkeeper: publicKey,
150 | instruction: SYSVAR_INSTRUCTIONS_PUBKEY,
151 | },
152 | {
153 | receiptBump,
154 | }
155 | )
156 |
157 | if (isSplMint) {
158 | const createApproveInstruction = Token.createApproveInstruction(
159 | TOKEN_PROGRAM_ID,
160 | paymentAccount,
161 | transferAuthority,
162 | publicKey,
163 | [],
164 | amount
165 | )
166 |
167 | txt.add(createApproveInstruction)
168 | }
169 |
170 | txt.add(publicBuyInstruction).add(printBidReceiptInstruction)
171 |
172 | if (isSplMint) {
173 | const createRevokeInstruction = Token.createRevokeInstruction(
174 | TOKEN_PROGRAM_ID,
175 | paymentAccount,
176 | publicKey,
177 | []
178 | )
179 |
180 | txt.add(createRevokeInstruction)
181 | }
182 |
183 | return [txt, signers]
184 | }
185 |
186 | async cancel({ nft, offer }: CancelOfferParams): Promise {
187 | const ah = this.auctionHouse
188 | const { publicKey } = this.wallet
189 | const auctionHouse = new PublicKey(ah.address)
190 | const authority = new PublicKey(ah.authority)
191 | const auctionHouseFeeAccount = new PublicKey(ah.auctionHouseFeeAccount)
192 | const tokenMint = new PublicKey(nft.mintAddress)
193 | const buyerPrice = offer.price.toNumber()
194 | const tradeState = new PublicKey(offer.tradeState)
195 | const tokenAccount = new PublicKey(nft.owner.associatedTokenAccountAddress)
196 |
197 | const [bidReceipt, _bidReceiptBump] =
198 | await AuctionHouseProgram.findBidReceiptAddress(tradeState)
199 |
200 | const txt = new Transaction()
201 |
202 | const cancelInstructionAccounts = {
203 | wallet: publicKey,
204 | tokenAccount,
205 | tokenMint,
206 | authority,
207 | auctionHouse,
208 | auctionHouseFeeAccount,
209 | tradeState,
210 | }
211 |
212 | const cancelInstructionArgs = {
213 | buyerPrice,
214 | tokenSize: 1,
215 | }
216 |
217 | const cancelBidReceiptInstructionAccounts = {
218 | receipt: bidReceipt,
219 | instruction: SYSVAR_INSTRUCTIONS_PUBKEY,
220 | }
221 |
222 | const cancelBidInstruction = createCancelInstruction(
223 | cancelInstructionAccounts,
224 | cancelInstructionArgs
225 | )
226 |
227 | const cancelBidReceiptInstruction = createCancelBidReceiptInstruction(
228 | cancelBidReceiptInstructionAccounts
229 | )
230 |
231 | txt.add(cancelBidInstruction).add(cancelBidReceiptInstruction)
232 |
233 | return [txt, []]
234 | }
235 |
236 | async accept({
237 | offer,
238 | nft,
239 | }: AcceptOfferParams): Promise {
240 | const { publicKey } = this.wallet
241 | const ah = this.auctionHouse
242 | const auctionHouse = new PublicKey(ah.address)
243 | const authority = new PublicKey(ah.authority)
244 | const auctionHouseFeeAccount = new PublicKey(ah.auctionHouseFeeAccount)
245 | const tokenMint = new PublicKey(nft.mintAddress)
246 | const treasuryMint = new PublicKey(ah.treasuryMint)
247 | const auctionHouseTreasury = new PublicKey(ah.auctionHouseTreasury)
248 | const tokenAccount = new PublicKey(nft.owner.associatedTokenAccountAddress)
249 | const buyerPubkey = new PublicKey(offer.buyer)
250 | const metadata = new PublicKey(nft.address)
251 |
252 | const isNative = treasuryMint.equals(NATIVE_MINT)
253 |
254 | let sellerPaymentReceiptAccount = await Token.getAssociatedTokenAddress(
255 | ASSOCIATED_TOKEN_PROGRAM_ID,
256 | TOKEN_PROGRAM_ID,
257 | treasuryMint,
258 | publicKey
259 | )
260 |
261 | if (isNative) {
262 | sellerPaymentReceiptAccount = publicKey
263 | }
264 |
265 | const [bidReceipt, _bidReceiptBump] =
266 | await AuctionHouseProgram.findBidReceiptAddress(
267 | new PublicKey(offer.tradeState)
268 | )
269 |
270 | const [sellerTradeState, sellerTradeStateBump] =
271 | await AuctionHouseProgram.findTradeStateAddress(
272 | publicKey,
273 | auctionHouse,
274 | tokenAccount,
275 | treasuryMint,
276 | tokenMint,
277 | offer.price.toNumber(),
278 | 1
279 | )
280 |
281 | const [buyerTradeState] =
282 | await AuctionHouseProgram.findPublicBidTradeStateAddress(
283 | buyerPubkey,
284 | auctionHouse,
285 | treasuryMint,
286 | tokenMint,
287 | offer.price.toNumber(),
288 | 1
289 | )
290 |
291 | const [purchaseReceipt, purchaseReceiptBump] =
292 | await AuctionHouseProgram.findPurchaseReceiptAddress(
293 | sellerTradeState,
294 | buyerTradeState
295 | )
296 |
297 | const [escrowPaymentAccount, escrowPaymentBump] =
298 | await AuctionHouseProgram.findEscrowPaymentAccountAddress(
299 | auctionHouse,
300 | buyerPubkey
301 | )
302 |
303 | const [programAsSigner, programAsSignerBump] =
304 | await AuctionHouseProgram.findAuctionHouseProgramAsSignerAddress()
305 |
306 | const [freeTradeState, freeTradeStateBump] =
307 | await AuctionHouseProgram.findTradeStateAddress(
308 | publicKey,
309 | auctionHouse,
310 | tokenAccount,
311 | treasuryMint,
312 | tokenMint,
313 | 0,
314 | 1
315 | )
316 |
317 | const [buyerReceiptTokenAccount] =
318 | await AuctionHouseProgram.findAssociatedTokenAccountAddress(
319 | tokenMint,
320 | buyerPubkey
321 | )
322 |
323 | const [listingReceipt, listingReceiptBump] =
324 | await AuctionHouseProgram.findListingReceiptAddress(sellerTradeState)
325 |
326 | const sellInstructionAccounts = {
327 | wallet: publicKey,
328 | tokenAccount,
329 | metadata,
330 | authority,
331 | auctionHouse: auctionHouse,
332 | auctionHouseFeeAccount: auctionHouseFeeAccount,
333 | sellerTradeState: sellerTradeState,
334 | freeSellerTradeState: freeTradeState,
335 | programAsSigner: programAsSigner,
336 | }
337 |
338 | const sellInstructionArgs = {
339 | tradeStateBump: sellerTradeStateBump,
340 | freeTradeStateBump: freeTradeStateBump,
341 | programAsSignerBump: programAsSignerBump,
342 | buyerPrice: offer.price,
343 | tokenSize: 1,
344 | }
345 |
346 | const printListingReceiptInstructionAccounts = {
347 | receipt: listingReceipt,
348 | bookkeeper: publicKey,
349 | instruction: SYSVAR_INSTRUCTIONS_PUBKEY,
350 | }
351 |
352 | const printListingReceiptInstructionArgs = {
353 | receiptBump: listingReceiptBump,
354 | }
355 |
356 | const executeSaleInstructionAccounts = {
357 | buyer: buyerPubkey,
358 | seller: publicKey,
359 | auctionHouse,
360 | tokenAccount,
361 | tokenMint,
362 | treasuryMint,
363 | metadata,
364 | authority,
365 | sellerTradeState,
366 | buyerTradeState,
367 | freeTradeState,
368 | sellerPaymentReceiptAccount,
369 | escrowPaymentAccount,
370 | buyerReceiptTokenAccount,
371 | auctionHouseFeeAccount,
372 | auctionHouseTreasury,
373 | programAsSigner,
374 | }
375 | const executeSaleInstructionArgs = {
376 | escrowPaymentBump,
377 | freeTradeStateBump,
378 | programAsSignerBump,
379 | buyerPrice: offer.price,
380 | tokenSize: 1,
381 | }
382 | const executePrintPurchaseReceiptInstructionAccounts = {
383 | purchaseReceipt,
384 | listingReceipt,
385 | bidReceipt,
386 | bookkeeper: publicKey,
387 | instruction: SYSVAR_INSTRUCTIONS_PUBKEY,
388 | }
389 |
390 | const executePrintPurchaseReceiptInstructionArgs = {
391 | purchaseReceiptBump: purchaseReceiptBump,
392 | }
393 |
394 | const createListingInstruction = createSellInstruction(
395 | sellInstructionAccounts,
396 | sellInstructionArgs
397 | )
398 | const createPrintListingInstruction = createPrintListingReceiptInstruction(
399 | printListingReceiptInstructionAccounts,
400 | printListingReceiptInstructionArgs
401 | )
402 | const executeSaleInstruction = createExecuteSaleInstruction(
403 | executeSaleInstructionAccounts,
404 | executeSaleInstructionArgs
405 | )
406 | const executePrintPurchaseReceiptInstruction =
407 | createPrintPurchaseReceiptInstruction(
408 | executePrintPurchaseReceiptInstructionAccounts,
409 | executePrintPurchaseReceiptInstructionArgs
410 | )
411 |
412 | const txt = new Transaction()
413 |
414 | let remainingAccounts: AccountMeta[] = []
415 |
416 | for (let creator of nft.creators) {
417 | const creatorAccount = {
418 | pubkey: new PublicKey(creator.address),
419 | isSigner: false,
420 | isWritable: true,
421 | }
422 | remainingAccounts = [...remainingAccounts, creatorAccount]
423 |
424 | if (isNative) {
425 | continue
426 | }
427 |
428 | const pubkey = await Token.getAssociatedTokenAddress(
429 | ASSOCIATED_TOKEN_PROGRAM_ID,
430 | TOKEN_PROGRAM_ID,
431 | treasuryMint,
432 | creatorAccount.pubkey
433 | )
434 |
435 | const creatorAtaAccount = {
436 | pubkey,
437 | isSigner: false,
438 | isWritable: true,
439 | }
440 |
441 | remainingAccounts = [...remainingAccounts, creatorAtaAccount]
442 | }
443 |
444 | txt
445 | .add(createListingInstruction)
446 | .add(createPrintListingInstruction)
447 | .add(
448 | new TransactionInstruction({
449 | programId: AuctionHouseProgram.PUBKEY,
450 | data: executeSaleInstruction.data,
451 | keys: executeSaleInstruction.keys.concat(remainingAccounts),
452 | })
453 | )
454 | .add(executePrintPurchaseReceiptInstruction)
455 |
456 | return [txt, []]
457 | }
458 | }
459 |
--------------------------------------------------------------------------------
/src/transaction.ts:
--------------------------------------------------------------------------------
1 | import {
2 | Connection,
3 | PublicKey,
4 | Transaction,
5 | TransactionInstruction,
6 | TransactionInstructionCtorFields,
7 | Keypair,
8 | } from '@solana/web3.js'
9 | import { Wallet } from '@metaplex/js'
10 |
11 | export type Tx =
12 | | Transaction
13 | | TransactionInstruction
14 | | TransactionInstructionCtorFields
15 | export type PendingTransaction = [Tx, Keypair[]]
16 |
17 | export class TransactionBuilder {
18 | public connection: Connection
19 | public wallet: Wallet
20 | private transactions: Promise[]
21 |
22 | constructor(connection: Connection, wallet: Wallet) {
23 | this.connection = connection
24 | this.wallet = wallet
25 | this.transactions = []
26 | }
27 |
28 | add(transaction: Promise): TransactionBuilder {
29 | this.transactions = [...this.transactions, transaction]
30 | return this
31 | }
32 |
33 | async send() {
34 | const wallet = this.wallet
35 | const publicKey = wallet.publicKey as PublicKey
36 | const connection = this.connection
37 | let signers: Keypair[] = []
38 |
39 | const transaction = new Transaction()
40 | const txs = await Promise.all(this.transactions)
41 | txs.forEach(([tx, keypairs]) => {
42 | signers = [...signers, ...keypairs]
43 |
44 | transaction.add(tx)
45 | })
46 |
47 | transaction.feePayer = publicKey
48 | const recentBlockhash = await connection.getLatestBlockhash()
49 |
50 | transaction.recentBlockhash = recentBlockhash.blockhash
51 |
52 | const signerPubKeys = signers.map((signer) => signer.publicKey)
53 | transaction.setSigners(publicKey, ...signerPubKeys)
54 |
55 | if (signers.length > 0) {
56 | transaction.partialSign(...signers)
57 | }
58 |
59 | const signedTransaction = await wallet.signTransaction(transaction)
60 | const txtId = await connection.sendRawTransaction(
61 | signedTransaction.serialize()
62 | )
63 |
64 | if (txtId) await connection.confirmTransaction(txtId, 'confirmed')
65 | }
66 | }
67 |
--------------------------------------------------------------------------------
/src/treasury.ts:
--------------------------------------------------------------------------------
1 | import { Client } from './client'
2 | import { AuctionHouseProgram } from '@metaplex-foundation/mpl-auction-house'
3 | import { PublicKey, Connection, Keypair } from '@solana/web3.js'
4 | import { AuctionHouse } from './types'
5 | import { TOKEN_PROGRAM_ID, MintInfo, NATIVE_MINT, Token } from '@solana/spl-token'
6 | import { Transaction } from '@solana/web3.js'
7 |
8 | import { Wallet } from '@metaplex/js'
9 | import { PendingTransaction } from './transaction'
10 |
11 | const { instructions } = AuctionHouseProgram
12 | const { createWithdrawFromTreasuryInstruction } = instructions
13 |
14 | interface WithdrawTreasuryParams {
15 | amount: number
16 | }
17 |
18 | export class TreasuryClient extends Client {
19 | private auctionHouse: AuctionHouse
20 |
21 | constructor(
22 | connection: Connection,
23 | wallet: Wallet,
24 | auctionHouse: AuctionHouse
25 | ) {
26 | super(connection, wallet)
27 |
28 | this.auctionHouse = auctionHouse
29 | }
30 |
31 | async balance(): Promise {
32 | const connection = this.connection
33 | const wallet = this.wallet
34 | const auctionHouse = this.auctionHouse
35 | const treasuryMint = new PublicKey(auctionHouse.treasuryMint)
36 | const auctionHouseTreasury = new PublicKey(auctionHouse.auctionHouseTreasury)
37 |
38 | const isNative = treasuryMint.equals(NATIVE_MINT)
39 |
40 | try {
41 | if (isNative) {
42 | const balance = await connection.getBalance(auctionHouseTreasury)
43 | const rent = await connection.getMinimumBalanceForRentExemption(0)
44 |
45 | return balance - rent
46 | }
47 |
48 | const keypair = Keypair.generate()
49 |
50 | const token = new Token(connection, treasuryMint, TOKEN_PROGRAM_ID, keypair)
51 |
52 | const associatedTokenAccount = await token.getAccountInfo(auctionHouseTreasury)
53 |
54 | return associatedTokenAccount.amount.toNumber()
55 | } catch(e: any) {
56 | throw new Error(e.message)
57 | }
58 | }
59 |
60 | async withdraw({ amount }: WithdrawTreasuryParams): Promise {
61 | const auctionHouse = this.auctionHouse
62 | const auctionHouseAddress = new PublicKey(auctionHouse.address)
63 | const authority = new PublicKey(auctionHouse.authority)
64 | const treasuryMint = new PublicKey(auctionHouse.treasuryMint)
65 | const auctionHouseTreasury = new PublicKey(auctionHouse.auctionHouseTreasury)
66 |
67 | const treasuryWithdrawalDestination = new PublicKey(
68 | auctionHouse.treasuryWithdrawalDestination
69 | )
70 |
71 | const withdrawFromTreasuryInstructionAccounts = {
72 | treasuryMint,
73 | authority,
74 | treasuryWithdrawalDestination,
75 | auctionHouseTreasury,
76 | auctionHouse: auctionHouseAddress,
77 | }
78 | const withdrawFromTreasuryInstructionArgs = {
79 | amount,
80 | }
81 |
82 | const withdrawFromTreasuryInstruction =
83 | createWithdrawFromTreasuryInstruction(
84 | withdrawFromTreasuryInstructionAccounts,
85 | withdrawFromTreasuryInstructionArgs
86 | )
87 |
88 | const txt = new Transaction()
89 |
90 | txt.add(withdrawFromTreasuryInstruction)
91 |
92 | return [txt, []]
93 | }
94 | }
95 |
--------------------------------------------------------------------------------
/src/types.ts:
--------------------------------------------------------------------------------
1 | import BN from 'bn.js'
2 |
3 | export type Volume = number
4 | type Uuid = string
5 |
6 | interface MarketplaceStats {
7 | nfts: Volume
8 | }
9 |
10 | interface CreatorCounts {
11 | creations: number
12 | }
13 |
14 | export interface MarktetplaceMetaPayload {
15 | name: string
16 | description: string
17 | }
18 |
19 | export interface FileUploadPayload {
20 | name: string | undefined
21 | type: string | undefined
22 | url: string
23 | }
24 |
25 | export interface MarketplaceThemePayload {
26 | logo: FileUploadPayload
27 | banner: FileUploadPayload
28 | }
29 |
30 | export interface MarketplaceCreatorPayload {
31 | address: string
32 | }
33 |
34 | export interface MarketplaceAddressPayload {
35 | owner?: string
36 | store?: string
37 | storeConfig?: string
38 | }
39 | interface MarketplaceAuctionHousePayload {
40 | address: string
41 | }
42 | export interface MarktplaceSettingsPayload {
43 | meta: MarktetplaceMetaPayload
44 | theme: MarketplaceThemePayload
45 | creators: MarketplaceCreatorPayload[]
46 | subdomain: string
47 | address: MarketplaceAddressPayload
48 | auctionHouses: MarketplaceAuctionHousePayload[]
49 | }
50 |
51 | export interface Marketplace {
52 | configAddress: string
53 | subdomain: string
54 | name: string
55 | description: string
56 | logoUrl: string
57 | bannerUrl: string
58 | auctionHouses: AuctionHouse[]
59 | ownerAddress: string
60 | creators: MarketplaceCreator[]
61 | stats?: MarketplaceStats
62 | }
63 |
64 | interface GraphQLObject {
65 | __typename: string
66 | }
67 |
68 | export interface MarketplaceCreator {
69 | creatorAddress: string
70 | storeConfigAddress: string
71 | preview: Nft[]
72 | twitterHandle?: string
73 | profile?: TwitterProfile | null
74 | nftCount?: number
75 | }
76 |
77 | export interface AuctionHouse {
78 | address: string
79 | treasuryMint: string
80 | auctionHouseTreasury: string
81 | treasuryWithdrawalDestination: string
82 | feeWithdrawalDestination: string
83 | authority: string
84 | creator: string
85 | auctionHouseFeeAccount: string
86 | bump: number
87 | treasuryBump: number
88 | feePayerBump: number
89 | sellerFeeBasisPoints: number
90 | requiresSignOff: boolean
91 | canChangeSalePrice: boolean
92 | stats?: MintStats
93 | }
94 |
95 | export interface AttributeVariant {
96 | name: string
97 | count: number
98 | }
99 |
100 | export interface AttributeGroup {
101 | name: string
102 | variants: AttributeVariant[]
103 | }
104 |
105 | export interface MintStats {
106 | volume24hr?: BN
107 | volumeTotal?: BN
108 | average?: BN
109 | floor?: BN
110 | mint: string
111 | auctionHouse?: AuctionHouse
112 | }
113 | export interface Creator extends UserWallet {
114 | attributeGroups: AttributeGroup[]
115 | stats: MintStats[]
116 | counts: CreatorCounts
117 | }
118 |
119 | export interface NftAttribute {
120 | value: string
121 | traitType: string
122 | }
123 |
124 | export interface UserWallet {
125 | address: string
126 | profile?: TwitterProfile | null
127 | }
128 |
129 | export interface NftOwner extends UserWallet {
130 | associatedTokenAccountAddress: string
131 | twitterHandle: string
132 | }
133 |
134 | export interface NftCreator extends UserWallet {
135 | twitterHandle?: string
136 | metadataAddress: string
137 | share: number
138 | verified: boolean
139 | position: number
140 | }
141 |
142 | export interface AhListing {
143 | id: Uuid
144 | tradeState: string
145 | auctionHouse?: AuctionHouse
146 | seller: string
147 | metadata: string
148 | purchaseId?: Uuid
149 | price: BN
150 | tokenSize: number
151 | tradeStateBump: number
152 | createdAt: string
153 | canceledAt?: string
154 | nft?: Nft
155 | }
156 |
157 | export interface Purchase {
158 | id: Uuid
159 | buyer: string
160 | seller: string
161 | auctionHouse?: AuctionHouse
162 | metadata: string
163 | price: BN
164 | createdAt: string
165 | tokenSize: number
166 | nft?: Nft
167 | }
168 |
169 | export interface Offer {
170 | id: Uuid
171 | tradeState: string
172 | buyer: string
173 | metadata: string
174 | auctionHouse?: AuctionHouse
175 | price: BN
176 | purchaseId?: Uuid
177 | tradeStateBump: number
178 | tokenAccount?: string
179 | createdAt: string
180 | canceledAt?: string
181 | tokenSize: number
182 | nft?: Nft
183 | }
184 |
185 | export interface NftFile {
186 | metadataAddress: string
187 | fileType: string
188 | uri: string
189 | }
190 |
191 | export interface Nft {
192 | address: string
193 | name: string
194 | sellerFeeBasisPoints: number
195 | mintAddress: string
196 | primarySaleHappened: boolean
197 | updateAuthorityAddress: string
198 | description: string
199 | category: string
200 | image: string
201 | animationUrl?: string
202 | externalUrl?: string
203 | creators: NftCreator[]
204 | attributes?: NftAttribute[]
205 | owner: NftOwner
206 | activities?: Activity[]
207 | listings?: AhListing[]
208 | purchases?: Purchase[]
209 | offers?: Offer[]
210 | files?: NftFile[]
211 | collection?: Nft
212 | createdAt?: string
213 | parser?: string
214 | }
215 |
216 | export interface AttributeFilter {
217 | traitType: string
218 | values: string[]
219 | }
220 |
221 | export enum PresetNftFilter {
222 | All = 'All',
223 | Listed = 'Listed',
224 | Owned = 'Owned',
225 | OpenOffers = 'OpenOffers',
226 | }
227 |
228 | export interface Viewer extends GraphQLObject {
229 | id: string
230 | balance: number
231 | }
232 |
233 | export enum PresetEditFilter {
234 | Marketplace = 'Marketplace',
235 | Creators = 'Creators',
236 | }
237 |
238 | export enum ActivityType {
239 | Listed = 'listing',
240 | Sold = 'purchase',
241 | }
242 | export interface Activity {
243 | id: Uuid
244 | metadata: string
245 | auctionHouse?: AuctionHouse
246 | price: BN
247 | createdAt: string
248 | wallets: Wallet[]
249 | activityType: string
250 | nft?: Nft
251 | }
252 |
253 | export interface TwitterProfile {
254 | handle: string
255 | description?: string
256 | walletAddress?: string
257 | bannerImageUrl?: string
258 | /**
259 | * @deprecated
260 | */
261 | profileImageUrl?: string
262 | profileImageUrlLowres?: string
263 | profileImageUrlHighres?: string
264 | }
265 |
266 | export interface NftCount {
267 | total: number
268 | listed: number
269 | }
270 |
271 | export interface NftOwner extends UserWallet {
272 | associatedTokenAccountAddress: string
273 | twitterHandle: string
274 | }
275 | export interface Wallet extends UserWallet {
276 | nftCounts: WalletNftCount
277 | connectionCounts: ConnectionCounts
278 | }
279 |
280 | export interface WalletNftCount {
281 | owned: number
282 | offered: number
283 | listed: number
284 | }
285 |
286 | export interface ConnectionCounts {
287 | fromCount: number
288 | toCount: number
289 | }
290 |
291 | export interface PricePoint {
292 | price: BN
293 | date: string
294 | }
295 |
296 | export interface PriceChart {
297 | listingFloor: PricePoint[]
298 | salesAverage: PricePoint[]
299 | totalVolume: PricePoint[]
300 | }
301 |
302 | export interface GetPriceChartData {
303 | charts: PriceChart
304 | }
305 |
306 | export interface GetActivities {
307 | activities: Activity[]
308 | }
309 |
310 | export interface GetNftData {
311 | nft: Nft
312 | }
313 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "declaration": true,
4 | "strictNullChecks": true,
5 | "target": "es5",
6 | "outDir": "dist",
7 | "module": "commonjs",
8 | "moduleResolution": "node",
9 | "esModuleInterop": true,
10 | "sourceMap": true,
11 | "lib": ["es2015", "dom"],
12 | "rootDir": "src"
13 | },
14 | "include": ["src"],
15 | "exclude": ["node_modules", "dist"]
16 | }
--------------------------------------------------------------------------------