forked from thirdweb-dev/go-sdk
-
Notifications
You must be signed in to change notification settings - Fork 1
/
erc1155_signature_minting.go
541 lines (484 loc) · 19 KB
/
erc1155_signature_minting.go
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
package thirdweb
import (
"context"
"encoding/hex"
"errors"
"fmt"
"math/big"
"github.com/ethereum/go-ethereum/accounts/abi/bind"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/common/math"
"github.com/ethereum/go-ethereum/core/types"
"github.com/ethereum/go-ethereum/crypto"
"github.com/ethereum/go-ethereum/ethclient"
signerTypes "github.com/ethereum/go-ethereum/signer/core/apitypes"
"github.com/google/uuid"
"github.com/mry-am/thirdweb-go-sdk/v2/abi"
)
// You can access this interface from the edition contract under the
// signature interface
type ERC1155SignatureMinting struct {
abi *abi.TokenERC1155
Helper *contractHelper
storage storage
}
func newERC1155SignatureMinting(provider *ethclient.Client, address common.Address, privateKey string, storage storage) (*ERC1155SignatureMinting, error) {
if contractAbi, err := abi.NewTokenERC1155(address, provider); err != nil {
return nil, err
} else if helper, err := newContractHelper(address, provider, privateKey); err != nil {
return nil, err
} else {
return &ERC1155SignatureMinting{
contractAbi,
helper,
storage,
}, nil
}
}
// Mint a token with the data in given payload.
//
// signedPayload: the payload signed by the minters private key being used to mint
//
// returns: the transaction receipt of the mint
//
// Example
//
// // Learn more about how to craft a payload in the Generate() function
// signedPayload, err := contract.Signature.Generate(payload)
// tx, err := contract.Signature.Mint(signedPayload)
func (signature *ERC1155SignatureMinting) Mint(ctx context.Context, signedPayload *SignedPayload1155) (*types.Transaction, error) {
txOpts, err := signature.Helper.GetTxOptions(ctx)
if err != nil {
return nil, err
}
tx, err := signature.MintWithOpts(ctx, signedPayload, txOpts)
if err != nil {
return nil, err
}
return signature.Helper.AwaitTx(ctx, tx.Hash())
}
func (signature *ERC1155SignatureMinting) MintWithOpts(ctx context.Context, signedPayload *SignedPayload1155, txOpts *bind.TransactOpts) (*types.Transaction, error) {
message, err := signature.mapPayloadToContractStruct(ctx, signedPayload.Payload)
if err != nil {
return nil, err
}
if err := setErc20Allowance(
ctx,
signature.Helper,
big.NewInt(message.PricePerToken.Int64()).Mul(message.PricePerToken, message.Quantity),
message.Currency.String(),
txOpts,
); err != nil {
return nil, err
}
signatureBytes, err := hex.DecodeString(signedPayload.Signature[2:])
if err != nil {
return nil, err
}
return signature.abi.MintWithSignature(txOpts, *message, signatureBytes)
}
// Mint a batch of token with the data in given payload.
//
// signedPayload: the list of payloads signed by the minters private key being used to mint
//
// returns: the transaction receipt of the batch mint
//
// Example
//
// // Learn more about how to craft multiple payloads in the GenerateBatch() function
// signedPayloads, err := contract.Signature.GenerateBatch(payloads)
// tx, err := contract.Signature.MintBatch(signedPayloads)
func (signature *ERC1155SignatureMinting) MintBatch(ctx context.Context, signedPayloads []*SignedPayload1155) (*types.Transaction, error) {
contractPayloads := []*abi.ITokenERC1155MintRequest{}
for _, signedPayload := range signedPayloads {
price, ok := big.NewInt(0).SetString(signedPayload.Payload.Price, 10)
if !ok {
return nil, errors.New("specified price was not a valid big.Int")
}
if price.Cmp(big.NewInt(0)) == 1 {
return nil, fmt.Errorf("can only batch free mints. For mints with a price, use the Mint() function")
}
payload, err := signature.mapPayloadToContractStruct(ctx, signedPayload.Payload)
if err != nil {
return nil, err
}
contractPayloads = append(contractPayloads, payload)
}
encoded := [][]byte{}
for i, payload := range contractPayloads {
txOpts, err := signature.Helper.getEncodedTxOptions(ctx)
if err != nil {
return nil, err
}
signatureBytes, err := hex.DecodeString(signedPayloads[i].Signature[2:])
if err != nil {
return nil, err
}
tx, err := signature.abi.MintWithSignature(txOpts, *payload, signatureBytes)
if err != nil {
return nil, err
}
encoded = append(encoded, tx.Data())
}
txOpts, err := signature.Helper.GetTxOptions(ctx)
if err != nil {
return nil, err
}
tx, err := signature.abi.Multicall(txOpts, encoded)
if err != nil {
return nil, err
}
return signature.Helper.AwaitTx(ctx, tx.Hash())
}
// Verify that a signed payload is valid
//
// signedPayload: the payload to verify
//
// returns: true if the payload is valid, otherwise false.
//
// Example
//
// // Learn more about how to craft a payload in the Generate() function
// signedPayload, err := contract.Signature.Generate(payload)
// isValid, err := contract.Signature.Verify(context.Background(), signedPayload)
func (signature *ERC1155SignatureMinting) Verify(ctx context.Context, signedPayload *SignedPayload1155) (bool, error) {
mintRequest := signedPayload.Payload
mintSignatureBytes, err := hex.DecodeString(signedPayload.Signature[2:])
if err != nil {
return false, err
}
message, err := signature.mapPayloadToContractStruct(ctx, mintRequest)
if err != nil {
return false, err
}
verification, _, err := signature.abi.Verify(&bind.CallOpts{}, *message, mintSignatureBytes)
return verification, err
}
// Generate a payload to mint a new token ID
//
// payloadToSign: the payload containing the data for the signature mint
//
// returns: the payload signed by the minter's private key
//
// Example
//
// payload := &thirdweb.Signature721PayloadInput{
// To: "0x9e1b8A86fFEE4a7175DAE4bDB1cC12d111Dcb3D6", // address to mint to
// Price: 0, // cost of minting
// CurrencyAddress: "0x0000000000000000000000000000000000000000", // currency to pay in order to mint
// MintStartTime: 0, // time where minting is allowed to start (epoch seconds)
// MintEndTime: 100000000000000, // time when this signature expires (epoch seconds)
// PrimarySaleRecipient: "0x0000000000000000000000000000000000000000", // address to receive the primary sales of this mint
// Metadata: &thirdweb.NFTMetadataInput{ // metadata of the NFT to mint
// Name: "ERC721 Sigmint!",
// },
// RoyaltyRecipient: "0x0000000000000000000000000000000000000000", // address to receive royalties of this mint
// RoyaltyBps: 0, // royalty cut of this mint in basis points
// Quantity: 1, // number of tokens to mint
// }
//
// signedPayload, err := contract.Signature.Generate(context.Background(), payload)
func (signature *ERC1155SignatureMinting) Generate(ctx context.Context, payloadToSign *Signature1155PayloadInput) (*SignedPayload1155, error) {
payloadWithTokenId := &Signature1155PayloadInputWithTokenId{
To: payloadToSign.To,
Price: payloadToSign.Price,
CurrencyAddress: payloadToSign.CurrencyAddress,
MintStartTime: payloadToSign.MintStartTime,
MintEndTime: payloadToSign.MintEndTime,
PrimarySaleRecipient: payloadToSign.PrimarySaleRecipient,
Metadata: payloadToSign.Metadata,
RoyaltyRecipient: payloadToSign.RoyaltyRecipient,
RoyaltyBps: payloadToSign.RoyaltyBps,
Quantity: payloadToSign.Quantity,
TokenId: -1,
}
payload, err := signature.GenerateFromTokenId(ctx, payloadWithTokenId)
if err != nil {
return nil, err
}
return payload, nil
}
// Generate a new payload to mint additionaly supply to an existing token ID
//
// payloadToSign: the payload containing the data for the signature mint
//
// returns: the payload signed by the minter's private key
//
// Example
//
// payload := &thirdweb.Signature1155PayloadInputWithTokenId{
// To: "0x9e1b8A86fFEE4a7175DAE4bDB1cC12d111Dcb3D6",
// Price: 0,
// CurrencyAddress: "0x0000000000000000000000000000000000000000",
// MintStartTime: 0,
// MintEndTime: 100000000000000,
// PrimarySaleRecipient: "0x0000000000000000000000000000000000000000",
// Metadata: nil, // we don't need to pass NFT metadata since we are minting an existing token
// RoyaltyRecipient: "0x0000000000000000000000000000000000000000",
// RoyaltyBps: 0,
// Quantity: 1,
// TokenId: 0, // now we need to specify the token ID to mint supply to
// }
//
// signedPayload, err := contract.Signature.GenerateFromTokenId(context.Background(), payload)
func (signature *ERC1155SignatureMinting) GenerateFromTokenId(ctx context.Context, payloadToSign *Signature1155PayloadInputWithTokenId) (*SignedPayload1155, error) {
payload, err := signature.GenerateBatchFromTokenIds(ctx, []*Signature1155PayloadInputWithTokenId{payloadToSign})
if err != nil {
return nil, err
}
return payload[0], nil
}
// Generate a batch of payloads to mint multiple new token IDs
//
// payloadToSign: the payloads containing the data for the signature mint
//
// returns: the payloads signed by the minter's private key
//
// Example
//
// payload := []*thirdweb.Signature1155PayloadInput{
// &thirdweb.Signature1155PayloadInput{
// To: "0x9e1b8A86fFEE4a7175DAE4bDB1cC12d111Dcb3D6",
// Price: 0,
// CurrencyAddress: "0x0000000000000000000000000000000000000000",
// MintStartTime: 0,
// MintEndTime: 100000000000000,
// PrimarySaleRecipient: "0x0000000000000000000000000000000000000000",
// Metadata: &thirdweb.NFTMetadataInput{
// Name: "ERC1155 Sigmint 1",
// },
// RoyaltyRecipient: "0x0000000000000000000000000000000000000000",
// RoyaltyBps: 0,
// Quantity: 1,
// },
// &thirdweb.Signature1155PayloadInput{
// To: "0x9e1b8A86fFEE4a7175DAE4bDB1cC12d111Dcb3D6",
// Price: 0,
// CurrencyAddress: "0x0000000000000000000000000000000000000000",
// MintStartTime: 0,
// MintEndTime: 100000000000000,
// PrimarySaleRecipient: "0x0000000000000000000000000000000000000000",
// Metadata: &thirdweb.NFTMetadataInput{
// Name: "ERC1155 Sigmint 2",
// },
// RoyaltyRecipient: "0x0000000000000000000000000000000000000000",
// RoyaltyBps: 0,
// Quantity: 1,
// },
// }
//
// signedPayload, err := contract.Signature.GenerateBatch(context.Background(), payload)
func (signature *ERC1155SignatureMinting) GenerateBatch(ctx context.Context, payloadsToSign []*Signature1155PayloadInput) ([]*SignedPayload1155, error) {
payloadsWithTokenIds := []*Signature1155PayloadInputWithTokenId{}
for _, payloadToSign := range payloadsToSign {
payloadWithTokenId := &Signature1155PayloadInputWithTokenId{
To: payloadToSign.To,
Price: payloadToSign.Price,
CurrencyAddress: payloadToSign.CurrencyAddress,
MintStartTime: payloadToSign.MintStartTime,
MintEndTime: payloadToSign.MintEndTime,
PrimarySaleRecipient: payloadToSign.PrimarySaleRecipient,
Metadata: payloadToSign.Metadata,
RoyaltyRecipient: payloadToSign.RoyaltyRecipient,
RoyaltyBps: payloadToSign.RoyaltyBps,
Quantity: payloadToSign.Quantity,
TokenId: -1,
}
payloadsWithTokenIds = append(payloadsWithTokenIds, payloadWithTokenId)
}
payloads, err := signature.GenerateBatchFromTokenIds(ctx, payloadsWithTokenIds)
if err != nil {
return nil, err
}
return payloads, nil
}
// Generate a batch of payloads to mint multiple new token IDs
//
// payloadToSign: the payloads containing the data for the signature mint
//
// returns: the payloads signed by the minter's private key
//
// Example
//
// payload := []*thirdweb.Signature1155PayloadInputWithTokenId{
// &thirdweb.Signature1155PayloadInputWithTokenId{
// To: "0x9e1b8A86fFEE4a7175DAE4bDB1cC12d111Dcb3D6",
// Price: 0,
// CurrencyAddress: "0x0000000000000000000000000000000000000000",
// MintStartTime: 0,
// MintEndTime: 100000000000000,
// PrimarySaleRecipient: "0x0000000000000000000000000000000000000000",
// Metadata: &thirdweb.NFTMetadataInput{
// Name: "ERC1155 Sigmint 1",
// },
// RoyaltyRecipient: "0x0000000000000000000000000000000000000000",
// RoyaltyBps: 0,
// Quantity: 1,
// TokenId: 0,
// },
// &thirdweb.Signature1155PayloadInputWithTokenId{
// To: "0x9e1b8A86fFEE4a7175DAE4bDB1cC12d111Dcb3D6",
// Price: 0,
// CurrencyAddress: "0x0000000000000000000000000000000000000000",
// MintStartTime: 0,
// MintEndTime: 100000000000000,
// PrimarySaleRecipient: "0x0000000000000000000000000000000000000000",
// Metadata: nil
// RoyaltyRecipient: "0x0000000000000000000000000000000000000000",
// RoyaltyBps: 0,
// Quantity: 1,
// TokenId: 1,
// },
// }
//
// signedPayload, err := contract.Signature.GenerateBatchFromTokenIds(context.Background(), payload)
func (signature *ERC1155SignatureMinting) GenerateBatchFromTokenIds(ctx context.Context, payloadsToSign []*Signature1155PayloadInputWithTokenId) ([]*SignedPayload1155, error) {
// TODO: Verify roles and return error
metadatas := []*NFTMetadataInput{}
for _, payload := range payloadsToSign {
metadatas = append(metadatas, payload.Metadata)
}
uris, err := uploadOrExtractUris(ctx, metadatas, signature.storage)
if err != nil {
return nil, err
}
chainId, err := signature.Helper.GetChainID(ctx)
if err != nil {
return nil, err
}
signedPayloads := []*SignedPayload1155{}
for i, uri := range uris {
p := payloadsToSign[i]
generatedId := uuid.New()
id := [32]byte{}
for i := 0; i < 16; i++ {
id[16+i] = generatedId[i]
}
provider := signature.Helper.GetProvider()
price, err := normalizePriceValue(ctx, provider, p.Price, p.CurrencyAddress)
if err != nil {
return nil, err
}
payload := &Signature1155PayloadOutput{
To: p.To,
Price: price.String(),
CurrencyAddress: p.CurrencyAddress,
MintStartTime: p.MintStartTime,
MintEndTime: p.MintEndTime,
PrimarySaleRecipient: p.PrimarySaleRecipient,
Metadata: p.Metadata,
RoyaltyRecipient: p.RoyaltyRecipient,
RoyaltyBps: p.RoyaltyBps,
TokenId: p.TokenId,
Quantity: p.Quantity,
Uri: uri,
Uid: id,
}
mappedPayload := generateMessage(payload)
typedData := signerTypes.TypedData{
Types: signerTypes.Types{
"MintRequest": []signerTypes.Type{
{Name: "to", Type: "address"},
{Name: "royaltyRecipient", Type: "address"},
{Name: "royaltyBps", Type: "uint256"},
{Name: "primarySaleRecipient", Type: "address"},
{Name: "tokenId", Type: "uint256"},
{Name: "uri", Type: "string"},
{Name: "quantity", Type: "uint256"},
{Name: "pricePerToken", Type: "uint256"},
{Name: "currency", Type: "address"},
{Name: "validityStartTimestamp", Type: "uint128"},
{Name: "validityEndTimestamp", Type: "uint128"},
{Name: "uid", Type: "bytes32"},
},
"EIP712Domain": []signerTypes.Type{
{Name: "name", Type: "string"},
{Name: "version", Type: "string"},
{Name: "chainId", Type: "uint256"},
{Name: "verifyingContract", Type: "address"},
},
},
PrimaryType: "MintRequest",
Domain: signerTypes.TypedDataDomain{
Name: "TokenERC1155",
Version: "1",
ChainId: math.NewHexOrDecimal256(chainId.Int64()),
VerifyingContract: signature.Helper.getAddress().String(),
},
Message: mappedPayload,
}
domainSeparator, err := typedData.HashStruct("EIP712Domain", typedData.Domain.Map())
if err != nil {
return nil, err
}
typedDataHash, err := typedData.HashStruct(typedData.PrimaryType, typedData.Message)
if err != nil {
return nil, err
}
rawData := []byte(fmt.Sprintf("\x19\x01%s%s", string(domainSeparator), string(typedDataHash)))
sigHash := crypto.Keccak256(rawData)
privateKey := signature.Helper.GetPrivateKey()
signatureHash, err := crypto.Sign(sigHash, privateKey)
if err != nil {
return nil, err
}
// We need this to correct v = 0,1 to v = 27,28 - or else all will break
if signatureHash[64] == 0 || signatureHash[64] == 1 {
signatureHash[64] += 27
}
signedPayloads = append(signedPayloads, &SignedPayload1155{
Payload: payload,
Signature: "0x" + hex.EncodeToString(signatureHash),
})
}
return signedPayloads, nil
}
func generateMessage(mintRequest *Signature1155PayloadOutput) signerTypes.TypedDataMessage {
// If tokenID < 0, set it to MaxUin256 (to mint a new NFT)
tokenId := big.NewInt(int64(mintRequest.TokenId))
if mintRequest.TokenId < 0 {
MaxUint256 := new(big.Int).Sub(new(big.Int).Lsh(common.Big1, 256), common.Big1)
tokenId = MaxUint256
}
message := signerTypes.TypedDataMessage{
"to": mintRequest.To,
"royaltyRecipient": mintRequest.RoyaltyRecipient,
"royaltyBps": fmt.Sprintf("%v", mintRequest.RoyaltyBps),
"primarySaleRecipient": mintRequest.PrimarySaleRecipient,
"uri": mintRequest.Uri,
"pricePerToken": fmt.Sprintf("%v", mintRequest.Price),
"tokenId": tokenId.String(),
"quantity": fmt.Sprintf("%v", mintRequest.Quantity),
"currency": mintRequest.CurrencyAddress,
"validityStartTimestamp": fmt.Sprintf("%v", mintRequest.MintStartTime),
"validityEndTimestamp": fmt.Sprintf("%v", mintRequest.MintEndTime),
"uid": mintRequest.Uid[:],
}
return message
}
func (signature *ERC1155SignatureMinting) mapPayloadToContractStruct(ctx context.Context, mintRequest *Signature1155PayloadOutput) (*abi.ITokenERC1155MintRequest, error) {
price, ok := big.NewInt(0).SetString(mintRequest.Price, 10)
if !ok {
return nil, errors.New("Specified price was not a valid big.Int")
}
// If tokenID < 0, set it to MaxUin256 (to mint a new NFT)
tokenId := big.NewInt(int64(mintRequest.TokenId))
if mintRequest.TokenId < 0 {
MaxUint256 := new(big.Int).Sub(new(big.Int).Lsh(common.Big1, 256), common.Big1)
tokenId = MaxUint256
}
return &abi.ITokenERC1155MintRequest{
To: common.HexToAddress(mintRequest.To),
RoyaltyRecipient: common.HexToAddress(mintRequest.RoyaltyRecipient),
RoyaltyBps: big.NewInt(int64(mintRequest.RoyaltyBps)),
PrimarySaleRecipient: common.HexToAddress(mintRequest.PrimarySaleRecipient),
Uri: mintRequest.Uri,
PricePerToken: price,
TokenId: tokenId,
Quantity: big.NewInt(int64(mintRequest.Quantity)),
Currency: common.HexToAddress(mintRequest.CurrencyAddress),
ValidityStartTimestamp: big.NewInt(int64(mintRequest.MintStartTime)),
ValidityEndTimestamp: big.NewInt(int64(mintRequest.MintEndTime)),
Uid: mintRequest.Uid,
}, nil
}