-
Notifications
You must be signed in to change notification settings - Fork 3
/
doc.ts
6745 lines (6743 loc) · 700 KB
/
doc.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {
SmartContractTemplateCategories,
SmartContractTemplate,
} from "./scripts/smart-contract-template";
const LIST: SmartContractTemplate[] = [
{
id: "ERC721_META_TRANSACTION",
name: "ERC721 NFT smart contract",
description: "The smart contract template to deploy single-copy NFTs",
shortDescription: "The smart contract template to deploy single-copy NFTs",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/non-fungible/StartonERC721Base.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC721Base",
},
isActivated: true,
isAudited: false,
order: 1,
category: SmartContractTemplateCategories.NFT,
tags: [SmartContractTemplateCategories.NFT],
form: {
infos: {
description:
"The ERC721 smart contract standard is built for single-copy Non Fungible Tokens (NFT) and is out-of-the-box compatible with Opensea. With an ERC721, every NFT is unique, so you have to reference the content for each NFT. You can also send transactions on behalf of your users so they can use their tokens without having to pay for gas fees.",
usecases: [
"In a video game, one-of-one NFT can consist of a digital good only one player can own at a time such as a piece of land.",
],
requirements: [
"A wallet to fund the creation of your contract",
"The URI of the metadata of your collection",
"The URI of the content of the NFT",
"The address of the initial owner",
"The network on which you want to deploy",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC721-Meta",
alt: "Go to ERC721 NFT Smart Contract",
},
tutorials: {
href: "https://docs.starton.io/docs/Tutorials/deploy-Nfts-with-Binance",
alt: "Go to Deploy your NFTs with Starton",
},
},
},
},
},
{
id: "ERC721_ROYALTIES_META_TRANSACTION",
name: "ERC721 NFT smart contract (with Royalty)",
description:
"The smart contract template to deploy single-copy NFTs. This template integrates the NFT Royalty standard enabling you to perceive a fraction of the price received for the NFT.",
shortDescription:
"The smart contract template to deploy single-copy NFTs. This template integrates the NFT Royalty standard enabling you to perceive a fraction of the price received for the NFT.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/non-fungible/StartonERC721BaseRoyalties.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC721BaseRoyalties",
},
isActivated: true,
isAudited: false,
order: 4,
category: SmartContractTemplateCategories.NFT,
tags: [SmartContractTemplateCategories.NFT],
form: {
infos: {
description:
"The ERC721 smart contract standard is built for single-copy Non Fungible Tokens (NFT) and is out-of-the-box compatible with Opensea. With an ERC721, every NFT is unique, so you have to reference the content for each NFT. This template integrates the NFT Royalty standard enabling you to perceive a fraction of the price received for the NFT",
usecases: [
"In a video game, one-of-one NFT can consist of a digital good only one player can own at a time such as a piece of land.",
],
requirements: [
"A wallet to fund the creation of your contract",
"The URI of the metadata of your collection",
"The URI of the content of the NFT",
"The address of the initial owner",
"The network on which you want to deploy",
"The fraction of sale price representing the royalty fees",
"The address that will receive the royalty fees",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC721_ROYALTIES_META_TRANSACTION",
alt: "Go to ERC721 NFT Smart Contract",
},
tutorials: {
href: "https://docs.starton.io/docs/Tutorials/deploy-Nfts-with-Binance",
alt: "Go to Deploy your NFTs with Starton",
},
},
},
},
},
{
id: "ERC721_CAPPED_META_TRANSACTION",
name: "ERC721 NFT with limited supply",
description:
"The capped ERC721 NFT smart contract template for single-copy Non Fungible Tokens (NFT).",
shortDescription:
"The capped ERC721 NFT smart contract template for single-copy Non Fungible Tokens (NFT).",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/non-fungible/StartonERC721Capped.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC721Capped",
},
isActivated: true,
isAudited: false,
order: 2,
category: SmartContractTemplateCategories.NFT,
tags: [SmartContractTemplateCategories.NFT],
form: {
infos: {
description:
"The NFT ERC721 smart contract where you can define the maximum supply of NFT you can mint.",
usecases: [
"In a video game, you can sell an NFT and pay for gas in place of the NFT receiver.",
],
requirements: [
"A wallet to fund the creation of your contract",
"The URI of the metadata of your collection",
"The URI of the content of the NFT",
"The address of the initial owner",
"The network on which you want to deploy",
"The maximum supply of NFTs that can be minted",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC721-Capped",
alt: "Go to ERC721 NFT Capped Documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/Home",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "ERC721_ROYALTIES_CAPPED_META_TRANSACTION",
name: "ERC721 NFT with limited supply (with Royalty)",
description:
"The capped ERC721 NFT smart contract template for single-copy Non Fungible Tokens (NFT). This template integrates the NFT Royalty standard enabling you to perceive a fraction of the price received for the NFT.",
shortDescription:
"The capped ERC721 NFT smart contract template for single-copy Non Fungible Tokens (NFT). This template integrates the NFT Royalty standard enabling you to perceive a fraction of the price received for the NFT.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/non-fungible/StartonERC721CappedRoyalties.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC721CappedRoyalties",
},
isActivated: true,
isAudited: false,
order: 5,
category: SmartContractTemplateCategories.NFT,
tags: [SmartContractTemplateCategories.NFT],
form: {
infos: {
description:
"The NFT ERC721 smart contract where you can define the maximum supply of NFT you can mint. This template integrates the NFT Royalty standard enabling you to perceive a fraction of the price received for the NFT",
usecases: [
"In a video game, you can sell an NFT and pay for gas in place of the NFT receiver.",
],
requirements: [
"A wallet to fund the creation of your contract",
"The URI of the metadata of your collection",
"The URI of the content of the NFT",
"The address of the initial owner",
"The network on which you want to deploy",
"The maximum supply of NFTs that can be minted",
"The fraction of sale price representing the royalty fees",
"The address that will receive the royalty fees",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC721_ROYALTIES_CAPPED_META_TRANSACTION",
alt: "Go to ERC721 NFT Capped Documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/Home",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "ERC1155_META_TRANSACTION",
name: "ERC1155 NFTs collection",
description: "The smart contract standard to manage multiple-copies NFTs.",
shortDescription:
"The smart contract standard to manage multiple-copies NFTs.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/non-fungible/StartonERC1155Base.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC1155Base",
},
isActivated: true,
isAudited: false,
order: 3,
category: SmartContractTemplateCategories.NFT,
tags: [SmartContractTemplateCategories.NFT],
form: {
infos: {
description:
"The smart contract standard to manage multiple-copies NFTs. Though their content is identical, each NFT has a different token ID.",
usecases: [
"In a video game, it can be a piece of equipment won after an action such as a powerful sword after defeating an enemy. Every user defeating the enemy will own an edition of the sword with a different identifier.",
],
requirements: [
"A wallet to fund the creation of your contract",
"The URI of the metadata of your collection",
"The URI of the content of the NFT",
"The address of the initial owner",
"The network on which you want to deploy",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC1155-Meta",
alt: "Go to ERC1155 NFT Smart contract Documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/creating-NFT-collection",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "ERC1155_ROYALTIES_META_TRANSACTION",
name: "ERC1155 NFTs collection (with Royalty)",
description:
"The smart contract standard to manage multiple-copies NFTs. This template integrates the NFT Royalty standard enabling you to perceive a fraction of the price received for the NFT.",
shortDescription:
"The smart contract standard to manage multiple-copies NFTs. This template integrates the NFT Royalty standard enabling you to perceive a fraction of the price received for the NFT.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/non-fungible/StartonERC1155BaseRoyalties.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC1155BaseRoyalties",
},
isActivated: true,
isAudited: false,
order: 6,
category: SmartContractTemplateCategories.NFT,
tags: [SmartContractTemplateCategories.NFT],
form: {
infos: {
description:
"The smart contract standard to manage multiple-copies NFTs. Though their content is identical, each NFT has a different token ID. This template integrates the NFT Royalty standard enabling you to perceive a fraction of the price received for the NFT",
usecases: [
"In a video game, it can be a piece of equipment won after an action such as a powerful sword after defeating an enemy. Every user defeating the enemy will own an edition of the sword with a different identifier.",
],
requirements: [
"A wallet to fund the creation of your contract",
"The URI of the metadata of your collection",
"The URI of the content of the NFT",
"The address of the initial owner",
"The network on which you want to deploy",
"The fraction of sale price representing the royalty fees",
"The address that will receive the royalty fees",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC1155-Meta",
alt: "Go to ERC1155 NFT Smart contract Documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/creating-NFT-collection",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "ERC20_META_TRANSACTION",
name: "ERC20 Token with fixed supply",
description:
"The smart contract template for fungible tokens. No new tokens can be created after the initial emission.",
shortDescription:
"The smart contract template for fungible tokens. No new tokens can be created after the initial emission.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/fungible/StartonERC20Base.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC20Base",
},
isActivated: true,
isAudited: false,
order: 7,
category: SmartContractTemplateCategories.FUNGIBLE,
tags: [SmartContractTemplateCategories.FUNGIBLE],
form: {
infos: {
description:
"Create your own fungible token. You will set the supply at initial emission. You can also send transactions on behalf of your users so they can use their tokens without having to pay for gas fees.",
tag: "ERC20, Fungible",
usecases: [
"In a video game, fixed fungible tokens can represent gems available only in limited supply",
],
requirements: [
"A name for your smart contract which will be reflected on-chain",
"A symbol for your smart contract which will be reflected on-chain",
"A number of tokens that will be minted",
"The address that will own the ERC20 contract",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC20-fixed-Meta",
alt: "Documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/Home",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "ERC20_MINT_META_TRANSACTION",
name: "ERC20 Token with mintable supply",
description:
"The smart contract template for fungible tokens. Admin can mint new tokens after initial emission.",
shortDescription:
"The smart contract template for fungible tokens. Admin can mint new tokens after initial emission.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/fungible/StartonERC20Mintable.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC20Mintable",
},
isActivated: true,
isAudited: false,
order: 8,
category: SmartContractTemplateCategories.FUNGIBLE,
tags: [SmartContractTemplateCategories.FUNGIBLE],
form: {
infos: {
description:
"Create your own fungible token, you can mint new tokens after the initial emission. You can also send transactions on behalf of your users so they can use their tokens without having to pay for gas fees.",
tag: "ERC20, Fungible",
"use cases": [
"In a video game, mintable fungible tokens can represent the currency gamers can spend in-game.",
],
requirements: [
"A Name for your smart contract which will be reflected on-chain",
"A Symbol for your smart contract which will be reflected on-chain",
"A Number of tokens that will be minted when the smart contract is deployed",
"The Address that will own the ERC20 contract",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC20-mintable-Meta",
alt: "Documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/Home",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "ERC721_SALE",
name: "ERC721 single-copy NFT Sale",
description: "The smart contract template for selling single-copy NFTs.",
shortDescription:
"The smart contract template for selling single-copy NFTs.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/nft-sales/StartonERC721BaseSale.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC721BaseSale",
},
isActivated: true,
isAudited: false,
order: 9,
category: SmartContractTemplateCategories.SALE,
tags: [SmartContractTemplateCategories.SALE],
form: {
infos: {
description:
"Set a price, a date, and a supply and you can sell your NFTs deployed using the ERC721 smart contract template.",
tag: "ERC721, Sale",
usecases: ["In a video game, you can sell a piece of land."],
requirements: [
"The address of the ERC721 smart contract of the NFT that you want to sell",
"A price the NFTs will be sold for",
"The time at which the sale will begin and end",
"The maximum amount of tokens that can be minted by a single address",
"The maximum amount of tokens that can be minted during the sale",
"The address that will receive the payment for the NFTs",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC721-Sale",
alt: "Documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/Home",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "ERC1155_SALE",
name: "ERC1155 NFT Collection Sale",
description:
"The smart contract template for selling multiple-copies NFTs.",
shortDescription:
"The smart contract template for selling multiple-copies NFTs.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/nft-sales/StartonERC1155BaseSale.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC1155BaseSale",
},
isActivated: true,
isAudited: false,
order: 10,
category: SmartContractTemplateCategories.SALE,
tags: [SmartContractTemplateCategories.SALE],
form: {
infos: {
description:
"Set a price, a date, and a supply and you can sell your NFT collections deployed using the ERC1155 smart contract template. ",
tag: "ERC1155, Sale",
usecases: [
"In a video game, you can sell a piece of equipment to another player.",
],
requirements: [
"The token address of the ERC1155 that you want to sell",
"The address that will receive the amount paid for the NFTs",
"The initial price offered for the NFT",
"The time at which the sale will begin and end, where users can bid. Timestamp in seconds",
"The URI that will append at the end of the base token URI for the token that will be minted",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC1155-Sale",
alt: "Go to ERC1155 Sale Documentation",
},
tutorials: {
href: "https://docs.starton.io/docs/Tutorials/create-an-NFT-collection-sale",
alt: "Go to ERC1155 Tutorials",
},
},
},
},
},
{
id: "ERC721_WHITELIST_SALE",
name: "ERC721 Whitelist Sale",
description:
"The smart contract template to sell NFTs only to selected users.",
shortDescription:
"The smart contract template to sell NFTs only to selected users.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/nft-sales/StartonERC721WhitelistSale.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC721WhitelistSale",
},
isActivated: true,
isAudited: false,
order: 11,
category: SmartContractTemplateCategories.SALE,
tags: [SmartContractTemplateCategories.SALE],
form: {
infos: {
description:
"Select who can buy your NFT collection. Then set a price, a date and a supply and you can sell your NFTs, deployed using an ERC1155 NFT deployment template.",
tag: "ERC1155, Sale",
usecases: [
"In a video game, you can sell a piece of equipment only to a list of approved players.",
],
requirements: [
"The token address of the ERC1155 that you want to sell",
"The price that the NFTs will be sold for",
"The root of the merkle tree that contains the list of the users that can buy the NFTs",
"The start and end time for your sale (in timestamp seconds)",
"The maximum amount of tokens that can be minted by a single address",
"The maximum amount of tokens that can be minted during the sale",
"The address that will receive all the price paid to mint the NFTs",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC1155-Whitelist-Sale",
alt: "ERC1155 Whitelist Sale Documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/Home",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "ERC1155_WHITELIST_SALE",
name: "ERC1155 Whitelist Sale",
description:
"The smart contract template for selling multiple copies of NFTs only to a specified list of addresses.",
shortDescription:
"The smart contract template for selling multiple copies of NFTs only to a specified list of addresses.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/nft-sales/StartonERC1155WhitelistSale.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC1155WhitelistSale",
},
isActivated: true,
isAudited: false,
order: 12,
category: SmartContractTemplateCategories.SALE,
tags: [SmartContractTemplateCategories.SALE],
form: {
infos: {
description:
"Select who can buy your NFT collection. Then set a price, a date and a supply and you can sell your NFTs, deployed using an ERC1155 NFT deployment template.",
tag: "ERC1155, Sale",
usecases: [
"In a video game, you can sell a piece of equipment only to a list of approved players.",
],
requirements: [
"The token address of the ERC1155 that you want to sell",
"The price that the NFTs will be sold for",
"The root of the merkle tree that contains the list of the users that can buy the NFTs",
"The start and end time for your sale (in timestamp seconds)",
"The maximum amount of tokens that can be minted by a single address",
"The maximum amount of tokens that can be minted during the sale",
"The address that will receive all the price paid to mint the NFTs",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC1155-Whitelist-Sale",
alt: "ERC1155 Whitelist Sale Documentation",
},
tutorials: {
href: "https://docs.starton.io/docs/Tutorials/Home",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "ERC721_AUCTION_SALE",
name: "ERC721 NFT Sale in an Auction",
description: "The smart contract to sell NFTs in a form of auction.",
shortDescription: "The smart contract to sell NFTs in a form of auction.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/nft-sales/StartonERC721AuctionSale.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC721AuctionSale",
},
isActivated: true,
isAudited: false,
order: 13,
category: SmartContractTemplateCategories.SALE,
tags: [SmartContractTemplateCategories.SALE],
form: {
infos: {
description:
"Set a starting price, a date and a supply and you can sell your NFTs, deployed using an ERC721 NFT deployment template. You can set the minimum bid increment to choose the pace of your auction.",
tag: "ERC721, Sale",
usecases: [
"In a video game, you can sell a piece of land to the player placing the highest bid.",
],
requirements: [
"The token address of the ERC721 that you want to sell.",
"The address that will receive the amount paid for the NFTs.",
"The initial price offered for the NFT.",
"The minimum bid increment to place a bid on top of the current maximum bid.",
"The time at which the sale will begin and end, where users can bid. Timestamp in seconds.",
"The URI that will be append in the end of the base token URI for the token that will be minted.",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC721-Auction-Sale",
alt: "Documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/create-an-NFT-auction",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "ERC1155_AUCTION_SALE",
name: "ERC1155 NFT collection Sale in an Auction",
description:
"The smart contract template for selling multiple copies of NFTs in the form of an Auction to the highest bidder in a time slot.",
shortDescription:
"The smart contract template for selling multiple copies of NFTs in the form of an Auction to the highest bidder in a time slot.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/nft-sales/StartonERC1155AuctionSale.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonERC1155AuctionSale",
},
isActivated: true,
isAudited: false,
order: 14,
category: SmartContractTemplateCategories.SALE,
tags: [SmartContractTemplateCategories.SALE],
form: {
infos: {
description:
"Set a starting price, a date and a supply and you can sell your NFTs, deployed using an ERC1155 NFT deployment template. You can set the minimum bid increment to choose the pace of your auction.",
usecases: [
"In a video game, you can sell a piece of equipment to the player placing the highest bid.",
],
requirements: [
"The token address of the ERC1155 that you want to sell",
"The address that will receive the amount paid for the NFTs",
"The initial price offered for the NFT",
"The minimum bid increment to place a bid on top of the current maximum bid",
"The start and end time for your sale (in timestamp seconds)",
"The URI that will append at the end of the base token URI for the token that will be minted",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/ERC1155-Auction",
alt: "Go to ERC1155 Auction Sale Documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/Home",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "PAYMENT_SPLITTER",
name: "Payment Splitter",
description:
"The smart contract template to split all payments between a list of users with a defined share for each of them.",
shortDescription:
"The smart contract template to split all payments between a list of users with a defined share for each of them.",
githubUrl:
"https://github.com/starton-io/smart-contract-templates/blob/master/contracts/tools/StartonPaymentSplitter.sol",
blockchains: ["polygon", "avalanche", "binance", "ethereum"],
compilationDetails: {
contractName: "StartonPaymentSplitter",
},
isActivated: true,
isAudited: false,
order: 15,
category: SmartContractTemplateCategories.OTHER,
tags: [SmartContractTemplateCategories.OTHER],
form: {
infos: {
description:
"Split all payments between a list of users with a defined share for each of them. The sender is not aware that the payment is split. The contract handles the split in a transparent manner.",
usecases: [
"When selling NFTs for an artist, you can set up payments so that a percentage of the sale goes directly to the artist and a another percentage goes to the manager.",
],
requirements: [
"The list of addresses that will receive a split of all the payments",
"The share that each address will get from the payment",
],
resources: {
documentation: {
href: "https://docs.starton.io/docs/Smart-contract/payment-splitter",
alt: "Go to Payment splitter documentation",
},
tutorial: {
href: "https://docs.starton.io/docs/Tutorials/Home",
alt: "Go to Tutorials",
},
},
},
},
},
{
id: "sct_010e42e313cd4de3a4f191510848e9b6",
name: "Child ERC1155",
description:
'<p>The ERC1155 is a smart contract standard which is specialised in multiple-copies Non Fungible Tokens (NFT).\n\t\t\tWithin this standard, tokens are linked to addresses (the owners) and to URIs (references of the NFT contents).</p>\n\t\t\t<p>It is important to notice that we do not store any content directly inside the smart contract.\n\t\t\tOnly references are stored. It is up to the smart contract readers to find the content by themselves using the references.</p>\n\t\t\t<p>Starton provides an <a href="https://app.starton.io/ipfs">IPFS integration</a> in case you need to host your NFT contents.</p>\n\t\t\t<p>Parameters :</p>\n\t\t\t<ul>\n\t\t\t<li><strong>Name</strong> : This is the name of your smart contract which will be reflected on-chain.</li>\n\t\t\t<li><strong>BaseUri</strong> : Will be used to concatenate NFT URIs and the ContractUriSuffix<ul>\n\t\t\t<li>Using IPFS: it should be <code>ipfs://ipfs/</code></li>\n\t\t\t<li>Using a centralised server: it should be like <code>https://yourapi.com/endpoint/</code></li>\n\t\t\t</ul>\n\t\t\t</li>\n\t\t\t<li><strong>ContractUriSuffix</strong> (will be concatenated with baseUri):<ul>\n\t\t\t<li>Using IPFS: it is the CID of the contract metadata (more info <a href="https://docs.opensea.io/docs/contract-level-metadata">here</a>)</li>\n\t\t\t<li>Using a centralised server: the path of the contract metadata json</li>\n\t\t\t</ul>\n\t\t\t</li>\n\t\t\t</ul>',
shortDescription:
"The smart contract template for bridging multiple-copies Non Fungible Tokens (NFT) between Ethereum and Polygon. For example, at large scale, to reduce gas fees and increase speed, NFTs can be transferred from one blockchain network to another. ",
blockchains: ["polygon"],
abi: [
{
type: "constructor",
inputs: [
{
name: "name",
type: "string",
internalType: "string",
},
{
name: "baseUri",
type: "string",
internalType: "string",
},
{
name: "contractUriSuffix",
type: "string",
internalType: "string",
},
{
name: "ownerOrMultiSigContract",
type: "address",
internalType: "address",
},
],
stateMutability: "nonpayable",
},
{
name: "ApprovalForAll",
type: "event",
inputs: [
{
name: "account",
type: "address",
indexed: true,
internalType: "address",
},
{
name: "operator",
type: "address",
indexed: true,
internalType: "address",
},
{
name: "approved",
type: "bool",
indexed: false,
internalType: "bool",
},
],
anonymous: false,
},
{
name: "Paused",
type: "event",
inputs: [
{
name: "account",
type: "address",
indexed: false,
internalType: "address",
},
],
anonymous: false,
},
{
name: "RoleAdminChanged",
type: "event",
inputs: [
{
name: "role",
type: "bytes32",
indexed: true,
internalType: "bytes32",
},
{
name: "previousAdminRole",
type: "bytes32",
indexed: true,
internalType: "bytes32",
},
{
name: "newAdminRole",
type: "bytes32",
indexed: true,
internalType: "bytes32",
},
],
anonymous: false,
},
{
name: "RoleGranted",
type: "event",
inputs: [
{
name: "role",
type: "bytes32",
indexed: true,
internalType: "bytes32",
},
{
name: "account",
type: "address",
indexed: true,
internalType: "address",
},
{
name: "sender",
type: "address",
indexed: true,
internalType: "address",
},
],
anonymous: false,
},
{
name: "RoleRevoked",
type: "event",
inputs: [
{
name: "role",
type: "bytes32",
indexed: true,
internalType: "bytes32",
},
{
name: "account",
type: "address",
indexed: true,
internalType: "address",
},
{
name: "sender",
type: "address",
indexed: true,
internalType: "address",
},
],
anonymous: false,
},
{
name: "TransferBatch",
type: "event",
inputs: [
{
name: "operator",
type: "address",
indexed: true,
internalType: "address",
},
{
name: "from",
type: "address",
indexed: true,
internalType: "address",
},
{
name: "to",
type: "address",
indexed: true,
internalType: "address",
},
{
name: "ids",
type: "uint256[]",
indexed: false,
internalType: "uint256[]",
},
{
name: "values",
type: "uint256[]",
indexed: false,
internalType: "uint256[]",
},
],
anonymous: false,
},
{
name: "TransferSingle",
type: "event",
inputs: [
{
name: "operator",
type: "address",
indexed: true,
internalType: "address",
},
{
name: "from",
type: "address",
indexed: true,
internalType: "address",
},
{
name: "to",
type: "address",
indexed: true,
internalType: "address",
},
{
name: "id",
type: "uint256",
indexed: false,
internalType: "uint256",
},
{
name: "value",
type: "uint256",
indexed: false,
internalType: "uint256",
},
],
anonymous: false,
},
{
name: "URI",
type: "event",
inputs: [
{
name: "value",
type: "string",
indexed: false,
internalType: "string",
},
{
name: "id",
type: "uint256",
indexed: true,
internalType: "uint256",
},
],
anonymous: false,
},
{
name: "Unpaused",
type: "event",
inputs: [
{
name: "account",
type: "address",
indexed: false,
internalType: "address",
},
],
anonymous: false,
},
{
name: "DEFAULT_ADMIN_ROLE",
type: "function",
inputs: [],
outputs: [
{
name: "",
type: "bytes32",
internalType: "bytes32",
},
],
stateMutability: "view",
},
{
name: "DEPOSITOR_ROLE",
type: "function",
inputs: [],
outputs: [
{
name: "",
type: "bytes32",
internalType: "bytes32",
},
],
stateMutability: "view",
},
{
name: "LOCKER_ROLE",
type: "function",
inputs: [],
outputs: [
{
name: "",
type: "bytes32",
internalType: "bytes32",
},
],
stateMutability: "view",
},
{
name: "MINTER_ROLE",
type: "function",
inputs: [],
outputs: [
{
name: "",
type: "bytes32",
internalType: "bytes32",
},
],
stateMutability: "view",
},
{
name: "PAUSER_ROLE",
type: "function",
inputs: [],