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
//! An NFT game inspired by cryptokitties.
//! This is a game which allows for kitties to be bred based on a few factors
//! 1.) Mom and Tired have to be in a state where they are ready to breed
//! 2.) Each Mom and Dad have some DNA and the child will have unique DNA combined from the both of them
//! Linkable back to the Mom and Dad
//! 3.) The game also allows Kitties to have a cooling off period inbetween breeding before they can be bred again.
//! 4.) A rest operation allows for a Mom Kitty and a Dad Kitty to be cooled off
//!
//! In order to submit a valid transaction you must strutucture it as follows:
//! 1.) Input must contain 1 mom and 1 dad
//! 2.) Output must contain Mom, Dad, and newly created Child
//! 3.) A child's DNA is calculated by:
//! BlakeTwo256::hash_of(MomDna, DadDna, MomCurrNumBreedings, DadCurrNumberBreedings)
//!
//! There are a only a finite amount of free breedings available before it starts to cost money
//! to breed kitties.
#![cfg_attr(not(feature = "std"), no_std)]
use parity_scale_codec::{Decode, Encode};
use scale_info::TypeInfo;
use serde::{Deserialize, Serialize};
use sp_core::H256;
use sp_runtime::{
traits::{BlakeTwo256, Hash as HashT},
transaction_validity::TransactionPriority,
};
use sp_std::prelude::*;
use tuxedo_core::{
dynamic_typing::{DynamicallyTypedData, UtxoData},
ensure,
types::Transaction,
SimpleConstraintChecker, Verifier,
};
#[cfg(test)]
mod tests;
#[derive(
Serialize,
Deserialize,
PartialEq,
Eq,
PartialOrd,
Ord,
Clone,
Encode,
Decode,
Hash,
Debug,
TypeInfo,
)]
pub struct FreeKittyConstraintChecker;
#[derive(
Serialize,
Deserialize,
PartialEq,
Eq,
PartialOrd,
Ord,
Default,
Clone,
Encode,
Decode,
Hash,
Debug,
TypeInfo,
)]
pub enum DadKittyStatus {
#[default]
RearinToGo,
Tired,
}
#[derive(
Serialize,
Deserialize,
PartialEq,
Eq,
PartialOrd,
Ord,
Default,
Clone,
Encode,
Decode,
Hash,
Debug,
TypeInfo,
)]
pub enum MomKittyStatus {
#[default]
RearinToGo,
HadBirthRecently,
}
#[derive(
Serialize,
Deserialize,
PartialEq,
Eq,
PartialOrd,
Ord,
Clone,
Encode,
Decode,
Hash,
Debug,
TypeInfo,
)]
pub enum Parent {
Mom(MomKittyStatus),
Dad(DadKittyStatus),
}
impl Parent {
pub fn dad() -> Self {
Parent::Dad(DadKittyStatus::RearinToGo)
}
pub fn mom() -> Self {
Parent::Mom(MomKittyStatus::RearinToGo)
}
}
impl Default for Parent {
fn default() -> Self {
Parent::Mom(MomKittyStatus::RearinToGo)
}
}
#[derive(
Serialize,
Deserialize,
PartialEq,
Eq,
PartialOrd,
Ord,
Default,
Clone,
Encode,
Decode,
Hash,
Debug,
TypeInfo,
)]
pub struct KittyDNA(pub H256);
#[derive(
Serialize,
Deserialize,
PartialEq,
Eq,
PartialOrd,
Ord,
Clone,
Encode,
Decode,
Hash,
Debug,
TypeInfo,
)]
pub struct KittyData {
pub parent: Parent,
pub free_breedings: u64, // Ignore in breed for money case
pub dna: KittyDNA,
pub num_breedings: u128,
}
impl KittyData {
/// Create a mint transaction for a single Kitty.
pub fn mint<V, OV, OC>(parent: Parent, dna_preimage: &[u8], v: V) -> Transaction<OV, OC>
where
V: Verifier,
OV: Verifier + From<V>,
OC: tuxedo_core::ConstraintChecker + From<FreeKittyConstraintChecker>,
{
Transaction {
inputs: vec![],
peeks: vec![],
outputs: vec![(
KittyData {
parent,
dna: KittyDNA(BlakeTwo256::hash(dna_preimage)),
..Default::default()
},
v,
)
.into()],
checker: FreeKittyConstraintChecker.into(),
}
}
}
impl Default for KittyData {
fn default() -> Self {
Self {
parent: Parent::Mom(MomKittyStatus::RearinToGo),
free_breedings: 2,
dna: KittyDNA(H256::from_slice(b"mom_kitty_1asdfasdfasdfasdfasdfa")),
num_breedings: 3,
}
}
}
impl UtxoData for KittyData {
const TYPE_ID: [u8; 4] = *b"Kitt";
}
#[derive(
Serialize,
Deserialize,
PartialEq,
Eq,
PartialOrd,
Ord,
Clone,
Encode,
Decode,
Hash,
Debug,
TypeInfo,
)]
pub enum ConstraintCheckerError {
/// Dynamic typing issue.
/// This error doesn't discriminate between badly typed inputs and outputs.
BadlyTyped,
/// The Kitties piece does not allow any evictions at all.
NoEvictionsAllowed,
/// Needed when spending for breeding.
MinimumSpendAndBreedNotMet,
/// Need two parents to breed.
TwoParentsDoNotExist,
/// Incorrect number of outputs when it comes to breeding.
NotEnoughFamilyMembers,
/// Mom has recently given birth and isnt ready to breed.
MomNotReadyYet,
/// Dad cannot breed because he is still too tired.
DadTooTired,
/// Cannot have two moms when breeding.
TwoMomsNotValid,
/// Cannot have two dads when breeding.
TwoDadsNotValid,
/// New Mom after breeding should be in HadBirthRecently state.
NewMomIsStillRearinToGo,
/// New Dad after breeding should be in Tired state.
NewDadIsStillRearinToGo,
/// Number of free breedings of new parent is not correct.
NewParentFreeBreedingsIncorrect,
/// New parents DNA does not match the old one parent has to still be the same kitty.
NewParentDnaDoesntMatchOld,
/// New parent Breedings has not incremented or is incorrect.
NewParentNumberBreedingsIncorrect,
/// New child DNA is not correct given the protocol.
NewChildDnaIncorrect,
/// New child doesnt have the correct number of free breedings.
NewChildFreeBreedingsIncorrect,
/// New child has non zero breedings which is impossible because it was just born.
NewChildHasNonZeroBreedings,
/// New child parent info is either in Tired state or HadBirthRecently state which is not possible.
NewChildIncorrectParentInfo,
/// Too many breedings for this kitty can no longer breed.
TooManyBreedingsForKitty,
/// Not enough free breedings available for these parents.
NotEnoughFreeBreedings,
}
trait Breed {
/// The Cost to breed a kitty if it is not free.
const COST: u128;
/// Number of free breedings a kitty will have.
const NUM_FREE_BREEDINGS: u64;
/// Error type for all Kitty errors.
type Error: Into<ConstraintCheckerError>;
/// Check if the two parents (Mom, Dad) proposed are capable of breeding.
fn can_breed(mom: &KittyData, dad: &KittyData) -> Result<(), Self::Error>;
/// Checks if mom is in the correct state and capable of breeding.
fn check_mom_can_breed(mom: &KittyData) -> Result<(), Self::Error>;
/// Checks if dad is in the correct state and capable of breeding.
fn check_dad_can_breed(dad: &KittyData) -> Result<(), Self::Error>;
/// Makes sure each parent has a non-zero number of free breedings.
fn check_free_breedings(mom: &KittyData, dad: &KittyData) -> Result<(), Self::Error>;
/// Checks outputs which consists of (Mom, Dad, Child) is correctly formulated.
fn check_new_family(
old_mom: &KittyData,
old_dad: &KittyData,
new_family: &[DynamicallyTypedData],
) -> Result<(), Self::Error>;
/// Checks if new mom matches the old ones DNA and changes state correctly.
fn check_new_mom(old_mom: &KittyData, new_mom: &KittyData) -> Result<(), Self::Error>;
/// Checks if new dad matches the old ones DNA and changes state correctly.
fn check_new_dad(old_dad: &KittyData, new_dad: &KittyData) -> Result<(), Self::Error>;
/// Checks if new child DNA is formulated correctly and is initialized to the proper state.
fn check_child(
new_mom: &KittyData,
new_dad: &KittyData,
child: &KittyData,
) -> Result<(), Self::Error>;
}
pub struct KittyHelpers;
impl Breed for KittyHelpers {
const COST: u128 = 5u128;
const NUM_FREE_BREEDINGS: u64 = 2u64;
type Error = ConstraintCheckerError;
/// Checks:
/// - Mom can breed
/// - Dad can breed
///
fn can_breed(mom: &KittyData, dad: &KittyData) -> Result<(), Self::Error> {
Self::check_mom_can_breed(mom)?;
Self::check_dad_can_breed(dad)?;
Self::check_free_breedings(mom, dad)?;
Ok(())
}
/// Checks:
/// - Mom is in `RearinToGo` state
/// - Mom number of breedings is not maxed out
///
fn check_mom_can_breed(mom: &KittyData) -> Result<(), Self::Error> {
match &mom.parent {
Parent::Mom(status) => {
if let MomKittyStatus::HadBirthRecently = status {
return Err(Self::Error::MomNotReadyYet);
}
}
Parent::Dad(_) => return Err(Self::Error::TwoDadsNotValid),
}
mom.num_breedings
.checked_add(1)
.ok_or(Self::Error::TooManyBreedingsForKitty)?;
Ok(())
}
/// Checks:
/// - Dad is in `RearinToGo` state
/// - Dad number of breedings is not maxed out
///
fn check_dad_can_breed(dad: &KittyData) -> Result<(), Self::Error> {
match &dad.parent {
Parent::Dad(status) => {
if let DadKittyStatus::Tired = status {
return Err(Self::Error::DadTooTired);
}
}
Parent::Mom(_) => return Err(Self::Error::TwoMomsNotValid),
}
dad.num_breedings
.checked_add(1)
.ok_or(Self::Error::TooManyBreedingsForKitty)?;
Ok(())
}
/// Checks:
/// - Both parents free breedings is non-zero
///
fn check_free_breedings(mom: &KittyData, dad: &KittyData) -> Result<(), Self::Error> {
let mom_breedings = mom.free_breedings;
let dad_breedings = dad.free_breedings;
if (mom_breedings == 0) || (dad_breedings == 0) {
return Err(Self::Error::NotEnoughFreeBreedings);
}
Ok(())
}
fn check_new_family(
old_mom: &KittyData,
old_dad: &KittyData,
new_family: &[DynamicallyTypedData],
) -> Result<(), Self::Error> {
// Output Side
ensure!(new_family.len() == 3, Self::Error::NotEnoughFamilyMembers);
let new_mom = KittyData::try_from(&new_family[0])?;
let new_dad = KittyData::try_from(&new_family[1])?;
let child = KittyData::try_from(&new_family[2])?;
Self::check_new_mom(old_mom, &new_mom)?;
Self::check_new_dad(old_dad, &new_dad)?;
Self::check_child(&new_mom, &new_dad, &child)?;
Ok(())
}
/// Checks:
/// - Mom is now in `HadBirthRecently`
/// - Mom has 1 less `free_breedings`
/// - Mom's DNA matches old Mom
/// - Mom's num breedings is incremented
///
fn check_new_mom(old_mom: &KittyData, new_mom: &KittyData) -> Result<(), Self::Error> {
match &new_mom.parent {
Parent::Mom(status) => {
if let MomKittyStatus::RearinToGo = status {
return Err(Self::Error::NewMomIsStillRearinToGo);
}
}
Parent::Dad(_) => return Err(Self::Error::TwoDadsNotValid),
}
ensure!(
new_mom.free_breedings == old_mom.free_breedings - 1,
Self::Error::NewParentFreeBreedingsIncorrect
);
ensure!(
new_mom.num_breedings == old_mom.num_breedings + 1,
Self::Error::NewParentNumberBreedingsIncorrect
);
ensure!(
new_mom.dna == old_mom.dna,
Self::Error::NewParentDnaDoesntMatchOld
);
Ok(())
}
/// Checks:
/// - Dad is now `Tired`
/// - Dad has 1 less `free_breedings`
/// - Dad's DNA matches old Dad
/// - Dad's num breedings is incremented
///
fn check_new_dad(old_dad: &KittyData, new_dad: &KittyData) -> Result<(), Self::Error> {
match &new_dad.parent {
Parent::Dad(status) => {
if let DadKittyStatus::RearinToGo = status {
return Err(Self::Error::NewDadIsStillRearinToGo);
}
}
Parent::Mom(_) => return Err(Self::Error::TwoMomsNotValid),
}
ensure!(
new_dad.free_breedings == old_dad.free_breedings - 1,
Self::Error::NewParentFreeBreedingsIncorrect
);
ensure!(
new_dad.num_breedings == old_dad.num_breedings + 1,
Self::Error::NewParentNumberBreedingsIncorrect
);
ensure!(
new_dad.dna == old_dad.dna,
Self::Error::NewParentDnaDoesntMatchOld
);
Ok(())
}
/// Checks:
/// - DNA formation correct -> `hash_of(mom_dna + dad_dna + mom_num_breedings + dad_num_breedings)
/// - Free breedings is correct given the trait implementation in this case 2
/// - has non-zero bredings
/// - If Mom is in RearinToGo
/// - If Dad is in RearinToGo
///
fn check_child(
new_mom: &KittyData,
new_dad: &KittyData,
child: &KittyData,
) -> Result<(), Self::Error> {
let new_dna = BlakeTwo256::hash_of(&(
&new_mom.dna,
&new_dad.dna,
&new_mom.num_breedings,
&new_dad.num_breedings,
));
ensure!(
child.dna == KittyDNA(new_dna),
Self::Error::NewChildDnaIncorrect,
);
ensure!(
child.free_breedings == Self::NUM_FREE_BREEDINGS,
Self::Error::NewChildFreeBreedingsIncorrect
);
ensure!(
child.num_breedings == 0,
Self::Error::NewChildHasNonZeroBreedings,
);
match &child.parent {
Parent::Mom(status) => {
if let MomKittyStatus::HadBirthRecently = status {
return Err(Self::Error::NewChildIncorrectParentInfo);
}
}
Parent::Dad(status) => {
if let DadKittyStatus::Tired = status {
return Err(Self::Error::NewChildIncorrectParentInfo);
}
}
}
Ok(())
}
}
impl TryFrom<&DynamicallyTypedData> for KittyData {
type Error = ConstraintCheckerError;
fn try_from(a: &DynamicallyTypedData) -> Result<Self, Self::Error> {
a.extract::<KittyData>()
.map_err(|_| ConstraintCheckerError::BadlyTyped)
}
}
impl SimpleConstraintChecker for FreeKittyConstraintChecker {
type Error = ConstraintCheckerError;
/// Checks:
/// - `input_data` is of length 2
/// - `output_data` is of length 3
///
fn check(
&self,
input_data: &[DynamicallyTypedData],
evicted_input_data: &[DynamicallyTypedData],
_peeks: &[DynamicallyTypedData],
output_data: &[DynamicallyTypedData],
) -> Result<TransactionPriority, Self::Error> {
// Can't evict anything
ensure!(
evicted_input_data.is_empty(),
ConstraintCheckerError::NoEvictionsAllowed
);
// Input must be a Mom and a Dad
ensure!(input_data.len() == 2, Self::Error::TwoParentsDoNotExist);
let mom = KittyData::try_from(&input_data[0])?;
let dad = KittyData::try_from(&input_data[1])?;
KittyHelpers::can_breed(&mom, &dad)?;
// Output must be Mom, Dad, Child
ensure!(output_data.len() == 3, Self::Error::NotEnoughFamilyMembers);
KittyHelpers::check_new_family(&mom, &dad, output_data)?;
Ok(0)
}
}