-
Notifications
You must be signed in to change notification settings - Fork 0
/
digi_pets.move
4361 lines (3758 loc) · 159 KB
/
digi_pets.move
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
/*
Relive the 90's with a blockchain twist by implementing your own, on-chain digital pets!
Key Concepts:
- Token v2 non-fungible tokens
- Token v2 fungible tokens
- Aptos coin
- String utilities
*/
module overmind::digi_pets {
//==============================================================================================
// Dependencies
//==============================================================================================
use std::bcs;
use std::vector;
use std::object;
use std::signer;
use std::string_utils;
use aptos_framework::coin;
use aptos_framework::option;
use aptos_framework::timestamp;
use aptos_token_objects::token;
use std::string::{Self, String};
use aptos_token_objects::collection;
use aptos_token_objects::property_map;
use aptos_framework::primary_fungible_store;
use aptos_framework::aptos_coin::{AptosCoin};
use aptos_framework::event::{Self, EventHandle};
use aptos_framework::fungible_asset::{Self, Metadata};
use aptos_framework::account::{Self, SignerCapability};
#[test_only]
use aptos_token_objects::royalty;
#[test_only]
use aptos_framework::aptos_coin::{Self};
//==============================================================================================
// Constants - DO NOT MODIFY
//==============================================================================================
// Seed for resource account creation
const SEED: vector<u8> = b"digi-pets";
// constant for math
const DAY_IN_SECONDS: u64 = 86400;
// Types of digi pets
const PET_TYPES: vector<vector<u8>> = vector<vector<u8>>[
b"Dog",
b"Cat",
b"Snake",
b"Monkey"
];
// Pet toys
const TOY_FOR_DOG: vector<u8> = b"Chew toy";
const TOY_FOR_CAT: vector<u8> = b"Yarn ball";
const TOY_FOR_SNAKE: vector<u8> = b"Teddy bear";
const TOY_FOR_MONKEY: vector<u8> = b"Beach ball";
// Digi-pet collection information
const DIGI_PET_COLLECTION_NAME: vector<u8> = b"Digi-Pets collection name";
const DIGI_PET_COLLECTION_DESCRIPTION: vector<u8> = b"Digi-Pets collection description";
const DIGI_PET_COLLECTION_URI: vector<u8> = b"Digi-Pets collection uri";
// Digi-pet token information
const DIGI_PET_TOKEN_DESCRIPTION: vector<u8> = b"Digi-Pets token description";
const DIGI_PET_TOKEN_URI: vector<u8> = b"Digi-Pets token uri";
// Digi-pet accessory collection information
const DIGI_PET_ACCESSORY_COLLECTION_NAME: vector<u8> = b"Digi-Pets accessory collection name";
const DIGI_PET_ACCESSORY_COLLECTION_DESCRIPTION: vector<u8> = b"Digi-Pets accessory collection description";
const DIGI_PET_ACCESSORY_COLLECTION_URI: vector<u8> = b"Digi-Pets accessory collection uri";
// property names for digi-pet token properties
const PROPERTY_KEY_PET_NAME: vector<u8> = b"pet_name";
const PROPERTY_KEY_PET_TYPE: vector<u8> = b"pet_type";
const PROPERTY_KEY_PET_HEALTH: vector<u8> = b"pet_health";
const PROPERTY_KEY_PET_HAPPINESS: vector<u8> = b"pet_happiness";
const PROPERTY_KEY_PET_BIRTHDAY_TIMESTAMP_SECONDS: vector<u8> = b"pet_birthday";
const PROPERTY_KEY_LAST_TIMESTAMP_FED: vector<u8> = b"last_timestamp_fed";
const PROPERTY_KEY_LAST_TIMESTAMP_PLAYED_WITH: vector<u8> = b"last_timestamp_played_with";
const PROPERTY_KEY_LAST_TIMESTAMP_UPDATED: vector<u8> = b"last_timestamp_updated";
// Starting values for digi-pet token properties
const STARTING_VALUE_PET_HEALTH: u64 = 100;
const STARTING_VALUE_PET_HAPPINESS: u64 = 100;
// Digi-pet food token information
const FOOD_TOKEN_NAME: vector<u8> = b"food token name";
const FOOD_TOKEN_DESCRIPTION: vector<u8> = b"food token description";
const FOOD_TOKEN_URI: vector<u8> = b"food token uri";
const FOOD_TOKEN_FUNGIBLE_ASSET_NAME: vector<u8> = b"food token fungible asset name";
const FOOD_TOKEN_FUNGIBLE_ASSET_SYMBOL: vector<u8> = b"FOOD";
const FOOD_TOKEN_ICON_URI: vector<u8> = b"food token icon uri";
const FOOD_TOKEN_PROJECT_URI: vector<u8> = b"food token project uri";
const FOOD_TOKEN_DECIMALS: u8 = 0;
// Prices
const FOOD_TOKEN_PRICE: u64 = 5000000; // .05 APT
const TOY_PRICE_APT: u64 = 100000000; // 1 APT
// Starting value for toy
const STARTING_TOY_DURABILITY: u64 = 50;
//==============================================================================================
// Error codes - DO NOT MODIFY
//==============================================================================================
const EInsufficientAptBalance: u64 = 0;
const EInsufficientFoodBalance: u64 = 1;
const ENotOwnerOfPet: u64 = 3;
const EInvalidPetType: u64 = 4;
//==============================================================================================
// Module Structs - DO NOT MODIFY
//==============================================================================================
/*
Digi-pet NFT token type
*/
struct DigiPetToken has key {
// Used for editing the token data
mutator_ref: token::MutatorRef,
// Used for burning the token
burn_ref: token::BurnRef,
// USed for editing the token's property_map
property_mutator_ref: property_map::MutatorRef,
// A list of toys for the digi-pet
toys: vector<Toy>
}
/*
Information about a toy. Used for keeping the digi-pets happy
*/
struct Toy has store, drop, copy {
// name of the specific toy
name: String,
// how much happiness the toy can supply to the pet
durability: u64
}
/*
struct for any fungible token for digi-pets
*/
struct AccessoryToken has key {
mutator_ref: property_map::MutatorRef,
mint_ref: fungible_asset::MintRef,
burn_ref: fungible_asset::BurnRef,
}
/*
Information to be used in the module
*/
struct State has key {
// signer cap of the module's resource account
signer_cap: SignerCapability,
// the number of pets adopted - used for pet name generation
pet_count: u64,
// Events
adopt_pet_events: EventHandle<AdoptPetEvent>,
feed_pet_events: EventHandle<FeedPetEvent>,
play_with_pet_events: EventHandle<PlayWithPetEvent>,
bury_pet_events: EventHandle<BuryPetEvent>,
}
//==============================================================================================
// Event structs - DO NOT MODIFY
//==============================================================================================
/*
Event to be emitted when a pet is adopted
*/
struct AdoptPetEvent has store, drop {
// address of the account adopting the new pet
adopter: address,
// name of the new pet
pet_name: String,
// address of the pet
pet: address,
// type of pet
pet_type: String
}
/*
Event to be emitted when a pet is fed
*/
struct FeedPetEvent has store, drop {
// address of the account that owns the pet
owner: address,
// address of the pet
pet: address
}
/*
Event to be emitted when a pet is played with
*/
struct PlayWithPetEvent has store, drop {
// address of the account that owns the pet
owner: address,
// address of the pet
pet: address
}
/*
Event to be emitted when a pet is buried
*/
struct BuryPetEvent has store, drop {
// address of the account that owns the pet
owner: address,
// address of the pet
pet: address
}
//==============================================================================================
// Functions
//==============================================================================================
/*
Initializes the module by creating a resource account, registering with AptosCoin, creating
the token collectiions, and setting up the State resource.
@param account - signer representing the module publisher
*/
fun init_module(account: &signer) {
// TODO: Create a resource account with the account signer and the `SEED` constant
let (resource_account, resource_signer_cap) = account::create_resource_account(account, SEED);
// TODO: Register the resource account with AptosCoin
coin::register<AptosCoin>(&resource_account);
// TODO: Create an NFT collection with an unlimied supply and the following aspects:
// - name: DIGI_PET_COLLECTION_NAME
// - description: DIGI_PET_COLLECTION_DESCRIPTION
// - uri: DIGI_PET_COLLECTION_URI
// - royalty: no royalty
collection::create_unlimited_collection(
&resource_account,
string::utf8(DIGI_PET_COLLECTION_DESCRIPTION),
string::utf8(DIGI_PET_COLLECTION_NAME),
option::none(),
string::utf8(DIGI_PET_COLLECTION_URI));
// TODO: Create an NFT collection with an unlimied supply and the following aspects:
// - name: DIGI_PET_ACCESSORY_COLLECTION_NAME
// - description: DIGI_PET_ACCESSORY_COLLECTION_DESCRIPTION
// - uri: DIGI_PET_ACCESSORY_COLLECTION_URI
// - royalty: no royalty
collection::create_unlimited_collection(
&resource_account,
string::utf8(DIGI_PET_ACCESSORY_COLLECTION_DESCRIPTION),
string::utf8(DIGI_PET_ACCESSORY_COLLECTION_NAME),
option::none(),
string::utf8(DIGI_PET_ACCESSORY_COLLECTION_URI)
);
// TODO: Create fungible token for digi pet food
//
// HINT: Use helper function - create_food_fungible_token
create_food_token(&resource_account);
// TODO: Create the State global resource and move it to the resource account
let state = State {
signer_cap: resource_signer_cap,
pet_count: 0,
adopt_pet_events: account::new_event_handle<AdoptPetEvent>(account),
feed_pet_events: account::new_event_handle<FeedPetEvent>(account),
play_with_pet_events: account::new_event_handle<PlayWithPetEvent>(account),
bury_pet_events: account::new_event_handle<BuryPetEvent>(account)
};
move_to(&resource_account, state);
}
/*
Mints a new DigiPetToken for the adopter account
@param adopter - signer representing the account adopting the new pet
@param pet_name - name of the pet to be adopted
@param pet_type_code - code which specifies the type of digi-pet that is being adopted
*/
public entry fun adopt_pet(
adopter: &signer,
pet_name: String,
pet_type_code: u64
) acquires State {
// TODO: Create the pet token's name based off the State's pet_count. Increment the pet
// count as well.
//
// HINT: Use this formatting - "Pet #{}", where {} is the pet_count + 1
let state_ref = borrow_global_mut<State>(get_resource_account_address());
let new_pet_count = state_ref.pet_count + 1;
state_ref.pet_count = new_pet_count;
let pet_token_name = string_utils::format2(&b"Pet #{}: {}", new_pet_count, pet_name);
// TODO: Create a new named token with the following aspects:
// - collection name: DIGI_PET_COLLECTION_NAME
// - token description: DIGI_PET_TOKEN_DESCRIPTION
// - token name: Specified in above TODO
// - royalty: no royalty
// - uri: DIGI_PET_TOKEN_URI
let creator = account::create_signer_with_capability(&state_ref.signer_cap);
let token_ref = token::create_named_token(
&creator,
string::utf8(DIGI_PET_COLLECTION_NAME),
string::utf8(DIGI_PET_TOKEN_DESCRIPTION),
pet_token_name,
option::none(),
string::utf8(DIGI_PET_TOKEN_URI)
);
// TODO: Transfer the token to the adopter account
let pet_address = get_pet_token_address_with_token_name(pet_token_name);
let pet_token_object = object::address_to_object<token::Token>(pet_address);
let adopter_address = signer::address_of(adopter);
object::transfer<token::Token>(&creator, pet_token_object, adopter_address);
// TODO: Create the property_map for the new token with the following properties:
// - PROPERTY_KEY_PET_NAME: the name of the pet (same as token name)
// - PROPERTY_KEY_PET_TYPE: the type of pet (string)
// - PROPERTY_KEY_PET_HEALTH: the health level of the pet (use STARTING_VALUE_PET_HEALTH)
// - PROPERTY_KEY_PET_HAPPINESS: the happiness level of the pet (use STARTING_VALUE_PET_HAPPINESS)
// - PROPERTY_KEY_PET_BIRTHDAY_TIMESTAMP_SECONDS: the current timestamp
// - PROPERTY_KEY_LAST_TIMESTAMP_FED: the current timestamp
// - PROPERTY_KEY_LAST_TIMESTAMP_PLAYED_WITH: the current timestamp
// - PROPERTY_KEY_LAST_TIMESTAMP_UPDATED: the current timestamp
let current_time = timestamp::now_seconds();
let input = property_map::prepare_input(
vector[
string::utf8(PROPERTY_KEY_PET_NAME),
string::utf8(PROPERTY_KEY_PET_TYPE),
string::utf8(PROPERTY_KEY_PET_HEALTH),
string::utf8(PROPERTY_KEY_PET_HAPPINESS),
string::utf8(PROPERTY_KEY_PET_BIRTHDAY_TIMESTAMP_SECONDS),
string::utf8(PROPERTY_KEY_LAST_TIMESTAMP_FED),
string::utf8(PROPERTY_KEY_LAST_TIMESTAMP_PLAYED_WITH),
string::utf8(PROPERTY_KEY_LAST_TIMESTAMP_UPDATED),
],
vector[
string::utf8(b"0x1::string::String"),
string::utf8(b"0x1::string::String"),
string::utf8(b"u64"),
string::utf8(b"u64"),
string::utf8(b"u64"),
string::utf8(b"u64"),
string::utf8(b"u64"),
string::utf8(b"u64"),
],
vector[
bcs::to_bytes<String>(&pet_name),
bcs::to_bytes<vector<u8>>(&*vector::borrow(&PET_TYPES, pet_type_code)),
bcs::to_bytes<u64>(&STARTING_VALUE_PET_HEALTH),
bcs::to_bytes<u64>(&STARTING_VALUE_PET_HAPPINESS),
bcs::to_bytes<u64>(¤t_time),
bcs::to_bytes<u64>(¤t_time),
bcs::to_bytes<u64>(¤t_time),
bcs::to_bytes<u64>(¤t_time),
],
);
property_map::init(&token_ref, input);
// TODO: Create the DigiPetToken object and move it to the new token object signer
let digi_pet_token = DigiPetToken {
mutator_ref: token::generate_mutator_ref(&token_ref),
burn_ref: token::generate_burn_ref(&token_ref),
property_mutator_ref: property_map::generate_mutator_ref(&token_ref),
toys: vector::empty<Toy>()
};
let object_signer = object::generate_signer(&token_ref);
move_to(&object_signer, digi_pet_token);
// TODO: Emit a new AdoptPetEvent
let event = AdoptPetEvent {
adopter: adopter_address,
pet_name: pet_token_name,
pet: pet_address,
pet_type: string::utf8(*vector::borrow(&PET_TYPES, pet_type_code)),
};
event::emit_event(&mut state_ref.adopt_pet_events, event);
}
/*
Mints food tokens in exchange for apt
@param buyer - signer representing the buyer of the food tokens
@param amount - amount of food tokens to purchase
*/
public entry fun buy_pet_food(buyer: &signer, amount: u64) acquires AccessoryToken {
// TODO: Ensure the buyer has enough APT
//
// HINT:
// - Use check_if_user_has_enough_apt function below
// - Use `amount` and FOOD_TOKEN_PRICE to calculate the correct amount of APT to check
let buyer_address = signer::address_of(buyer);
let apt_needed = amount * FOOD_TOKEN_PRICE;
check_if_user_has_enough_apt(buyer_address, apt_needed);
// TODO: Transfer the correct amount of APT from the buyer to the module's resource account
//
// HINT: Use `amount` and FOOD_TOKEN_PRICE to calculate the correct amount of APT to transfer
coin::transfer<AptosCoin>(buyer, get_resource_account_address(), apt_needed);
// TODO: Mint `amount` of food tokens to the buyer
//
// HINT: Use the mint_fungible_token_internal function
mint_fungible_token_internal(food_token_address(), amount, buyer_address);
}
/*
Creates a new Toy resource for the buyer's pet
@param buyer - signer representing the account that is buying a toy for their pet
@param pet - address of the pet to buy a toy for
*/
public entry fun buy_pet_toy(buyer: &signer, pet: address) acquires DigiPetToken {
// TODO: Ensure the buyer owns the pet
//
// HINT:
// - Use check_if_user_owns_pet function below
let buyer_address = signer::address_of(buyer);
check_if_user_owns_pet(buyer_address, pet);
// TODO: Ensure the buyer has enough APT
//
// HINT:
// - Use check_if_user_has_enough_apt function below
// - Use TOY_PRICE_APT as the amount of APT to transfer
check_if_user_has_enough_apt(buyer_address, TOY_PRICE_APT);
// TODO: Transfer the correct amount of APT from the buyer to the module's resource account
//
// HINT: Use TOY_PRICE_APT as the amount of APT to transfer
coin::transfer<AptosCoin>(buyer, get_resource_account_address(), TOY_PRICE_APT);
// TODO: Get the correct toy name based on the token's pet_type property
//
// HINT: Use the get_toy_name function
let pet_token_object = object::address_to_object<token::Token>(pet);
let toy_name = get_toy_name(property_map::read_string(&pet_token_object, &string::utf8(PROPERTY_KEY_PET_TYPE)));
// TODO: Create a new toy object with the correct name and durability and push it to the
// pet's toy list
//
// HINT: Use STARTING_TOY_DURABILITY for the durability
let new_toy = Toy {
name: toy_name,
durability: STARTING_TOY_DURABILITY
};
let digi_pet_token_ref = borrow_global_mut<DigiPetToken>(pet);
vector::push_back(&mut digi_pet_token_ref.toys, new_toy);
}
/*
Burn food tokens to increase the health of a pet
@param owner - signer representing the owner of the pet
@param pet_to_feed - address of the pet to be fed
@param amount_to_feed - amount of food tokens to feed the pet
*/
public entry fun feed_pet(
owner: &signer,
pet_to_feed: address,
amount_to_feed: u64
) acquires State, DigiPetToken, AccessoryToken {
// TODO: Ensure the owner owns the pet
//
// HINT:
// - Use check_if_user_owns_pet function below
let owner_address = signer::address_of(owner);
check_if_user_owns_pet(owner_address, pet_to_feed);
// TODO: Ensure the buyer has enough food to feed the pet
//
// HINT:
// - Use check_if_user_has_enough_food function below
check_if_user_has_enough_food(owner_address, amount_to_feed);
// TODO: Update the pet status. If the pet is dead, call bury_pet and return
//
// HINT: Use the update_pet_stats function
let pet_stat = update_pet_stats(pet_to_feed);
if (!pet_stat) {
bury_pet(pet_to_feed);
return
};
// TODO: Burn the correct amount of food tokens
//
// HINT: Use the burn_fungible_token_internal function
burn_fungible_token_internal(owner, food_token_address(), amount_to_feed);
// TODO: Add the amount of food to the pet's PROPERTY_KEY_PET_HEALTH
let digi_pet_token_ref = borrow_global<DigiPetToken>(pet_to_feed);
let pet_token_object = object::address_to_object<token::Token>(pet_to_feed);
let pet_health = property_map::read_u64(&pet_token_object, &string::utf8(PROPERTY_KEY_PET_HEALTH)) + amount_to_feed;
property_map::update(
&digi_pet_token_ref.property_mutator_ref,
&string::utf8(PROPERTY_KEY_PET_HEALTH),
string::utf8(b"u64"),
bcs::to_bytes<u64>(&pet_health)
);
// TODO: Update the pet's PROPERTY_KEY_LAST_TIMESTAMP_FED
property_map::update(
&digi_pet_token_ref.property_mutator_ref,
&string::utf8(PROPERTY_KEY_LAST_TIMESTAMP_FED),
string::utf8(b"u64"),
bcs::to_bytes<u64>(×tamp::now_seconds())
);
// TODO: Emit a new FeedPetEvent
let state_ref = borrow_global_mut<State>(get_resource_account_address());
let event = FeedPetEvent {
owner: owner_address,
pet: pet_to_feed
};
event::emit_event(&mut state_ref.feed_pet_events, event);
}
/*
Reset the pet's happiness
@param owner - signer representing the owner of the pet
@param pet_to_play_with - address of the pet to be played with
*/
public entry fun play_with_pet(owner: &signer, pet_to_play_with: address) acquires State, DigiPetToken {
// TODO: Ensure the owner owns the pet
//
// HINT:
// - Use check_if_user_owns_pet function below
let owner_address = signer::address_of(owner);
check_if_user_owns_pet(owner_address, pet_to_play_with);
// TODO: Update the pet status. If the pet is dead, call bury_pet and return
//
// HINT: Use the update_pet_stats function
let pet_stat = update_pet_stats(pet_to_play_with);
if (!pet_stat) {
bury_pet(pet_to_play_with);
return
};
// TODO: Set the pet's PROPERTY_KEY_PET_HAPPINESS to 150
// TODO: Update the pet's PROPERTY_KEY_LAST_TIMESTAMP_PLAYED_WITH
let digi_pet_token_ref = borrow_global<DigiPetToken>(pet_to_play_with);
property_map::update(
&digi_pet_token_ref.property_mutator_ref,
&string::utf8(PROPERTY_KEY_PET_HAPPINESS),
string::utf8(b"u64"),
bcs::to_bytes<u64>(&150u64)
);
property_map::update(
&digi_pet_token_ref.property_mutator_ref,
&string::utf8(PROPERTY_KEY_LAST_TIMESTAMP_PLAYED_WITH),
string::utf8(b"u64"),
bcs::to_bytes<u64>(×tamp::now_seconds())
);
// TODO: Emit a new PlayWithPetEvent
let state_ref = borrow_global_mut<State>(get_resource_account_address());
let event = PlayWithPetEvent{
owner: owner_address,
pet: pet_to_play_with
};
event::emit_event(&mut state_ref.play_with_pet_events, event);
}
/*
Update's a pet's stats. Will bury the pet if the pet has died. A pet can be updated by
anyone.
@param pet - address of the pet to be updated
*/
public entry fun update_pet_stats_entry(pet: address) acquires State, DigiPetToken {
// TODO: Update the pet status. If the pet is dead, call bury_pet and return
//
// HINT: Use the update_pet_stats function
let pet_stat = update_pet_stats(pet);
if (!pet_stat) {
bury_pet(pet);
return
}
}
//==============================================================================================
// Helper functions
//==============================================================================================
/*
Fetches the toy name for the given type of pet
@param pet_type - string representing the type of pet
@return - the name of the toy for the given pet type
*/
inline fun get_toy_name(pet_type: String): String {
// TODO: Return the correct toy name based on the type of pet:
// - "Dog": TOY_FOR_DOG
// - "Cat": TOY_FOR_CAT
// - "Snake": TOY_FOR_SNAKE
// - "Monkey": TOY_FOR_MONKEY
//
// HINT: Abort with code: EInvalidPetType, if pet_type is not any of the above types
let _name = string::utf8(b"");
if (pet_type == string::utf8(b"Dog")) {
_name = string::utf8(TOY_FOR_DOG)
} else if (pet_type == string::utf8(b"Cat")) {
_name = string::utf8(TOY_FOR_CAT)
} else if (pet_type == string::utf8(b"Snake")) {
_name = string::utf8(TOY_FOR_SNAKE)
} else if (pet_type == string::utf8(b"Monkey")) {
_name = string::utf8(TOY_FOR_MONKEY)
} else {
abort EInvalidPetType
};
_name
}
/*
Update the pet's stats, and returns true if the pet is still alive and false otherwise.
@param pet - address of the pet to update
@return - true if the pet is still alive and false otherwise.
*/
inline fun update_pet_stats(
pet: address
): bool acquires DigiPetToken {
// TODO: Fetch the PROPERTY_KEY_LAST_TIMESTAMP_FED and PROPERTY_KEY_PET_HEALTH properties
// and calculate the amount of health to decrease from the pet
//
// HINT: Use this formula to calculate the amount of health:
// health to decrease = time since last fed * 100 / DAY_IN_SECONDS
let is_alive = true;
let pet_token_object = object::address_to_object<token::Token>(pet);
let time_last_fed = property_map::read_u64(&pet_token_object, &string::utf8(PROPERTY_KEY_LAST_TIMESTAMP_FED));
let health_to_decrease = (timestamp::now_seconds() - time_last_fed) * 100 / DAY_IN_SECONDS;
// TODO: If the pet's current health is greater than the health to decrease, update the
// pet's health (PROPERTY_KEY_PET_HEALTH) with the new health. Otherwise, set the
// health to 0.
//
// HINT:
// - new health = old health - heal to decrease
// - the 'return' keyword is not allowed in inline functions, use other ways to return
// values
let token_ref = borrow_global_mut<DigiPetToken>(pet);
let current_health = property_map::read_u64(&pet_token_object, &string::utf8(PROPERTY_KEY_PET_HEALTH));
if (current_health > health_to_decrease) {
current_health = current_health - health_to_decrease;
property_map::update(
&token_ref.property_mutator_ref,
&string::utf8(PROPERTY_KEY_PET_HEALTH),
string::utf8(b"u64"),
bcs::to_bytes<u64>(¤t_health));
} else {
is_alive = false; //pet is dead
};
// TODO: Fetch the PROPERTY_KEY_LAST_TIMESTAMP_PLAYED_WITH and
// PROPERTY_KEYPROPERTY_KEY_PET_HAPPINESS_PET_HEALTH properties and calculate the
// amount of happiness to decrease from the pet
//
// HINT: Use this formula to calculate the amount of health:
// health to decrease = time since last played with * 100 / DAY_IN_SECONDS
let current_happiness = property_map::read_u64(&pet_token_object, &string::utf8(PROPERTY_KEY_PET_HAPPINESS));
let time_last_played = property_map::read_u64(&pet_token_object, &string::utf8(PROPERTY_KEY_LAST_TIMESTAMP_PLAYED_WITH));
let happiness_to_decrease = (timestamp::now_seconds() - time_last_played) * 100 / DAY_IN_SECONDS;
// TODO: While the pet has toys and until the amount of happiness to decrease is not 0, pull
// toys from the pet's toy list and subtract the toy's durability from the amount
// of happiness to decrease. If the amount of happiness to decrease is less than a
// toy's durability, subtract the amount from the durability and push it back to
// the toy list.
//
// HINT: If the pet has any toys at all, update the PROPERTY_KEY_LAST_TIMESTAMP_PLAYED_WITH
// with the current timestamp.
let number_of_toys = vector::length(&token_ref.toys);
if (number_of_toys > 0) {
property_map::update(
&token_ref.property_mutator_ref,
&string::utf8(PROPERTY_KEY_LAST_TIMESTAMP_PLAYED_WITH),
string::utf8(b"u64"),
bcs::to_bytes<u64>(×tamp::now_seconds())
);
let total_durability = 0;
vector::for_each<Toy>(token_ref.toys, |toy| {
let toy : Toy = toy;
total_durability = total_durability + toy.durability;
});
if (happiness_to_decrease >= total_durability) {
happiness_to_decrease = happiness_to_decrease - total_durability;
total_durability = 0; //used all toys'durability
} else {
total_durability = total_durability - happiness_to_decrease;
happiness_to_decrease = 0;
};
if (total_durability == 0) {
token_ref.toys = vector::empty();
} else {
vector::trim(&mut token_ref.toys, 1); //leave just one toy to store the remaining durability
let toy = vector::borrow_mut(&mut token_ref.toys, 0);
toy.durability = total_durability;
};
};
// TODO: If the pet's current happiness is greater than the happiness to decrease, update
// the pet's happiness (PROPERTY_KEY_PET_HAPPINESS) with the new health. Otherwise,
// set the happiness to 0.
//
// HINT:
// - new happiness = old happiness - happiness to decrease
// - the 'return' keyword is not allowed in inline functions, use other ways to return
// values
if (current_happiness > happiness_to_decrease) {
current_happiness = current_happiness - happiness_to_decrease;
property_map::update(
&token_ref.property_mutator_ref,
&string::utf8(PROPERTY_KEY_PET_HAPPINESS),
string::utf8(b"u64"),
bcs::to_bytes<u64>(¤t_happiness)
);
} else {
is_alive = false; //0 happiness, pet is dead
};
// TODO: Update the PROPERTY_KEY_LAST_TIMESTAMP_UPDATED property with the current timestamp
property_map::update(
&token_ref.property_mutator_ref,
&string::utf8(PROPERTY_KEY_LAST_TIMESTAMP_UPDATED),
string::utf8(b"u64"),
bcs::to_bytes<u64>(×tamp::now_seconds())
);
// TODO: Return true if the pet is still alive and false otherwise.
is_alive
}
/*
Burns the specified pet token
@param pet_to_bury - address of the pet token to burn
*/
inline fun bury_pet(pet_to_bury: address) acquires State, DigiPetToken {
// TODO: Move DigiPetToken from the pet address and destructure it
let DigiPetToken {
mutator_ref: _,
burn_ref: bref,
property_mutator_ref: pmref,
toys: _} = move_from<DigiPetToken>(pet_to_bury);
let state_ref = borrow_global_mut<State>(get_resource_account_address());
let pet_object = object::address_to_object<token::Token>(pet_to_bury);
let owner_address = object::owner(pet_object);
// TODO: Burn the token's property_map and the token
//
// HINT: Use property_map::burn and token::burn
property_map::burn(pmref);
token::burn(bref);
// TODO: Emit a new BuryPetEvent
let event = BuryPetEvent{
owner: owner_address,
pet: pet_to_bury
};
event::emit_event(&mut state_ref.bury_pet_events, event);
}
/*
Mints fungible tokens for an address
@param token_address - address of the fungible token to mint more of
@param amount - amount of fungible tokens to minted
@param buyer_address - address for the fungible tokens to be transferred to
*/
inline fun mint_fungible_token_internal(
token_address: address,
amount: u64,
buyer_address: address
) acquires AccessoryToken {
// TODO: Fetch the Accessory token from the token address
let accessory_token_ref = borrow_global<AccessoryToken>(token_address);
// TODO: Use the token's mint_ref to mint `amount` of the food token fungible asset
//
// HINT: Use fungible_asset::mint
let asset = fungible_asset::mint(&accessory_token_ref.mint_ref, amount);
// TODO: Deposit the new fungible asset to the buyer
//
// HINT: Use primary_fungible_store::deposit
primary_fungible_store::deposit(buyer_address, asset);
}
/*
Burns fungible tokens from an address
@param from - address of the account to burn the tokens from
@param token_address - address of the fungible token to be burned
@param amount - amount of fungible tokens to burned
*/
inline fun burn_fungible_token_internal(
from: &signer,
token_address: address,
amount: u64
) acquires AccessoryToken {
// TODO: Fetch the Accessory token from the token address
let accessory_token_ref = borrow_global<AccessoryToken>(token_address);
// TODO: Fetch the primary fungible store of the `from` account
//
// HINT: Use primary_fungible_store::primary_store
// TODO: Burn `amount` of the food token from the primary store
//
// HINT: Use fungible_asset::burn_from
let from_address = signer::address_of(from);
primary_fungible_store::burn(&accessory_token_ref.burn_ref, from_address, amount);
}
/*
Create the fungible food token
@param creator - signer representing the creator of the collection
*/
inline fun create_food_token(creator: &signer) {
// TODO: Create a new named token with the following aspects:
// - collection name: DIGI_PET_ACCESSORY_COLLECTION_NAME
// - token description: FOOD_TOKEN_DESCRIPTION
// - token name: FOOD_TOKEN_NAME
// - royalty: no royalty
// - uri: FOOD_TOKEN_URI
let token_ref = token::create_named_token(
creator,
string::utf8(DIGI_PET_ACCESSORY_COLLECTION_NAME),
string::utf8(FOOD_TOKEN_DESCRIPTION),
string::utf8(FOOD_TOKEN_NAME),
option::none(),
string::utf8(FOOD_TOKEN_URI)
);
// TODO: Create a new property_map for the token
let input = property_map::prepare_input(
vector[],
vector[],
vector[],
);
property_map::init(&token_ref, input);
// TODO: Create a fungible asset for the food token with the following aspects:
// - max supply: no max supply
// - name: FOOD_TOKEN_DESCRFOOD_TOKEN_FUNGIBLE_ASSET_NAMEIPTION
// - symbol: FOOD_TOKEN_FUNGIBLE_ASSET_SYMBOL
// - decimals: FOOD_TOKEN_DECIMALS
// - icon uri: FOOD_TOKEN_ICON_URI
// - project uri: FOOD_TOKEN_PROJECT_URI
primary_fungible_store::create_primary_store_enabled_fungible_asset(
&token_ref,
option::none(),
string::utf8(FOOD_TOKEN_FUNGIBLE_ASSET_NAME),
string::utf8(FOOD_TOKEN_FUNGIBLE_ASSET_SYMBOL),
FOOD_TOKEN_DECIMALS,
string::utf8(FOOD_TOKEN_ICON_URI),
string::utf8(FOOD_TOKEN_PROJECT_URI)
);
// TODO: Create a new AccessoryToken object and move it to the token's object signer
let accessory_token = AccessoryToken {
mutator_ref: property_map::generate_mutator_ref(&token_ref),
mint_ref: fungible_asset::generate_mint_ref(&token_ref),
burn_ref: fungible_asset::generate_burn_ref(&token_ref),
};
let object_signer = object::generate_signer(&token_ref);
move_to(&object_signer, accessory_token);
}
/*
Fetchs the address of the fungible food token
@return - address of the fungible food token
*/
#[view]
public fun food_token_address(): address {
// TODO: Return the address of the food token
let food_token_address = token::create_token_address(
&get_resource_account_address(),
&string::utf8(DIGI_PET_ACCESSORY_COLLECTION_NAME),
&string::utf8(FOOD_TOKEN_NAME)
);
food_token_address
}
/*
Fetches the balance of food token for an account
@param owner_addr - address to check the balance of
@return - balance of food token
*/
#[view]
public fun food_balance(owner_addr: address): u64 {
// TODO: Get the object of the AccessoryToken
let food_token_object =
object::address_to_object<AccessoryToken>(food_token_address());
// TODO: Convert the AccessoryToken object to a Metadata object
//
// HINT: Use object::convert
let metadata = object::convert<AccessoryToken, Metadata>(food_token_object);
// TODO: Create or fetch the owner's primary fungible store
//
// HINT: Use primary_fungible_store::ensure_primary_store_exists
let store = primary_fungible_store::ensure_primary_store_exists(owner_addr, metadata);
// TODO: Get the balance of the fungible store
//
// HINT: Use fungible_asset::balance
fungible_asset::balance(store)
}
/*
Returns the number of toys a pet has
@param pet - address of the pet to check
@return - number of toys the pet has
*/
#[view]
public fun number_of_toys(pet: address): u64 acquires DigiPetToken {
// TODO: Return the number of toys in the pet's DigiPetToken object
let digi_pet_token_ref = borrow_global<DigiPetToken>(pet);
vector::length(&digi_pet_token_ref.toys)
}
/*
Returns the total durability of all of a pet's toys
@param pet - address of the pet to check
@return - The sum of durability for all toys belong to the pet
*/
#[view]
public fun total_toy_durability(pet: address): u64 acquires DigiPetToken {
// TODO: Return the total sum of durability of every toy in the pet's toy list
let total_durability = 0;
let digi_pet_token_ref = borrow_global<DigiPetToken>(pet);
vector::for_each<Toy>(digi_pet_token_ref.toys, |toy| {
let toy : Toy = toy;
total_durability = total_durability + toy.durability;
});
total_durability
}
/*
Returns the address of the pet token with the given name
@param token_name - name of the pet token
@return - address of the pet token
*/
#[view]
public fun get_pet_token_address_with_token_name(token_name: String): address {
// TODO: Return the address of the Digi-pet token with the given name
let pet_address = token::create_token_address(
&get_resource_account_address(),
&string::utf8(DIGI_PET_COLLECTION_NAME),
&token_name
);
pet_address
}
/*
Retrieves the address of this module's resource account
*/
inline fun get_resource_account_address(): address {
// TODO: Create the module's resource account address and return it
account::create_resource_address(&@overmind, SEED)
}
//==============================================================================================
// Validation functions
//==============================================================================================
inline fun check_if_user_has_enough_apt(user: address, amount_to_check_apt: u64) {
// TODO: Ensure that the user's balance of apt is greater than or equal to the given amount.
// If false, abort with code: EInsufficientAptBalance
assert!(coin::balance<AptosCoin>(user) >= amount_to_check_apt, EInsufficientAptBalance);
}
inline fun check_if_user_has_enough_food(user: address, amount_to_check_food: u64) {
// TODO: Ensure that the user's balance of food token is greater than or equal to the given
// amount. If false, abort with code: EInsufficientFoodBalance
assert!(food_balance(user) >= amount_to_check_food, EInsufficientFoodBalance);
}
inline fun check_if_user_owns_pet(user: address, pet: address) {
// TODO: Ensure the given user is the owner of the given pet token. If not, abort with code:
// ENotOwnerOfPet
assert!(object::is_owner(object::address_to_object<token::Token>(pet), user), ENotOwnerOfPet);
}
//==============================================================================================
// Tests - DO NOT MODIFY
//==============================================================================================
#[test(admin = @overmind, adopter = @0xA)]
fun test_init_module_success(
admin: &signer,