From 75c277c6761b598f6d1c5ca16851390c274516a6 Mon Sep 17 00:00:00 2001 From: manoahLinks Date: Tue, 19 Dec 2023 09:23:24 +0100 Subject: [PATCH 1/2] feat: implementing erc20 token --- src/bwc_erc20_token.cairo | 112 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 106 insertions(+), 6 deletions(-) diff --git a/src/bwc_erc20_token.cairo b/src/bwc_erc20_token.cairo index 9efe06f..2244c6a 100644 --- a/src/bwc_erc20_token.cairo +++ b/src/bwc_erc20_token.cairo @@ -1,16 +1,116 @@ #[starknet::contract] - // minimalistic implementation of ERC20 token mod BWCERC20Token { - use starknet::{ContractAddress}; + use core::zeroable::Zeroable; + use starknet::{ContractAddress, get_caller_address}; #[storage] struct Storage { name: felt252, - symbols: felt252, - decimals: u256, - allowances: LegacyMap::<(ContractAddress, ContractAddress), u256>, + symbol: felt252, + decimals: u8, + totalSupply: u256, + allowances: LegacyMap::<(ContractAddress, ContractAddress), u256>, balances: LegacyMap:: } + #[event] + #[derive(Drop, starknet::Event)] + enum Event { + transfer: Transfer, + approval: Approval + } + + #[derive(Drop, starknet::Event)] + struct Transfer { + sender: ContractAddress, + reciever: ContractAddress, + value: u256 + } + + #[derive(Drop, starknet::Event)] + struct Approval { + owner: ContractAddress, + spender: ContractAddress, + value: u256 + } + + // contruct value to insert important perequsite values + #[constructor] + fn constructor( + ref self: ContractState, + _owner: ContractAddress, + _name: felt252, + _symbol: felt252, + _decimals: u8 + ) { + self.name.write(_name); + self.symbol.write(_symbol); + self.decimals.write(_decimals); + } + + // errors + mod Errors { + const ZERO_ADDRESS_ERROR: felt252 = 'This address is not allowed'; + const ZERO_VALUE: felt252 = 'this value is below minimum'; + const INSUFFICIENT_BALANCE: felt252 = 'insufficient balance'; + const ONLY_OWNER_ERROR: felt252 = 'caller not owner'; + } + + // fn to get total supply + #[external(v0)] + fn get_total_supply(self: @ContractState) -> u256 { + self.totalSupply.read() + } -} \ No newline at end of file + // fn to get balance of any user using address as key + #[external(v0)] + fn balanceOf(self: @ContractState, user_bal: ContractAddress) -> u256 { + self.balances.read(user_bal) + } + + // fn to transfer funds + #[external(v0)] + fn transfer(ref self: ContractState, _to: ContractAddress, _amount: u256) { + let caller = get_caller_address(); + let caller_balance = self.balances.read(caller); + let recievers_balance = self.balances.read(_to); + + // asserting amount is greatthan zero + assert(_amount > 0, Errors::ZERO_VALUE); + // asserting if caller_balance greater than amount to be sent + assert(caller_balance > _amount, Errors::INSUFFICIENT_BALANCE); + // asserting caller is not address zero + assert(!caller.is_zero(), Errors::ZERO_ADDRESS_ERROR); + + // deduct amount from caller + self.balances.write(caller, caller_balance - _amount); + // adding amount to reciever + self.balances.write(_to, recievers_balance + _amount); + + // emmit success event + self.emit(Transfer { sender: caller, reciever: _to, value: _amount}); + } + + // fn transfer from + #[external(v0)] + fn transferFrom( + ref self: ContractState, to: ContractAddress, from: ContractAddress, amount: u256 + ) { + let caller = get_caller_address(); + let sender_balance = self.balances.read(from); + let recievers_balance = self.balances.read(to); + + // asserting amount is greatthan zero + assert(amount > 0, Errors::ZERO_VALUE); + // asserting if caller_balance greater than amount to be sent + assert(sender_balance > amount, Errors::INSUFFICIENT_BALANCE); + // asserting caller is not address zero + assert(!caller.is_zero(), Errors::ZERO_ADDRESS_ERROR); + + self.balances.write(from, sender_balance - amount); + self.balances.write(to, recievers_balance + amount); + + // emmit success event + self.emit(Transfer { sender: from, reciever: to, value: amount}); + } +} From 324ed9cc77b19071b9313598d1b5073149a00d85 Mon Sep 17 00:00:00 2001 From: manoahLinks Date: Tue, 19 Dec 2023 23:09:32 +0100 Subject: [PATCH 2/2] feat: class_character_v3 contract deployed --- src/bwc_erc20_token.cairo | 6 +- src/class_character_v3.cairo | 188 +++++++++++++++++++++++++++++++++++ src/lib.cairo | 1 + 3 files changed, 192 insertions(+), 3 deletions(-) create mode 100644 src/class_character_v3.cairo diff --git a/src/bwc_erc20_token.cairo b/src/bwc_erc20_token.cairo index 2244c6a..220726b 100644 --- a/src/bwc_erc20_token.cairo +++ b/src/bwc_erc20_token.cairo @@ -88,7 +88,7 @@ mod BWCERC20Token { self.balances.write(_to, recievers_balance + _amount); // emmit success event - self.emit(Transfer { sender: caller, reciever: _to, value: _amount}); + self.emit(Transfer { sender: caller, reciever: _to, value: _amount }); } // fn transfer from @@ -110,7 +110,7 @@ mod BWCERC20Token { self.balances.write(from, sender_balance - amount); self.balances.write(to, recievers_balance + amount); - // emmit success event - self.emit(Transfer { sender: from, reciever: to, value: amount}); + // emmit success event + self.emit(Transfer { sender: from, reciever: to, value: amount }); } } diff --git a/src/class_character_v3.cairo b/src/class_character_v3.cairo new file mode 100644 index 0000000..18ca2b7 --- /dev/null +++ b/src/class_character_v3.cairo @@ -0,0 +1,188 @@ +// ============================================= +// ========= TRIATS ============================ +// trait definition +use starknet::{ContractAddress}; +#[starknet::interface] +trait IClassCharacter { + fn set_owner(ref self: T, new_owner: ContractAddress) -> bool; + fn get_owner(self: @T) -> ContractAddress; + fn set_student( + ref self: T, + _studentAddr: ContractAddress, + _name: felt252, + _age: u8, + _is_active: bool, + _has_reward: bool, + _xp_earnings: u256 + ) -> bool; + fn get_student(self: @T, studentAddr: ContractAddress) -> Student; +} + +// triat with access control +#[starknet::interface] +trait IClassCharacterWithAccessControl { + fn set_owner_with_access_control(ref self: T, new_owner: ContractAddress) -> bool; + fn get_owner_with_access_control(self: @T) -> ContractAddress; + fn set_student_with_access_control( + ref self: T, + _studentAddr: ContractAddress, + _name: felt252, + _age: u8, + _is_active: bool, + _has_reward: bool, + _xp_earnings: u256 + ) -> bool; + fn get_student_with_access_control(self: @T, student_addr: ContractAddress) -> Student; +} + +// ============================================== +// ======= Global vars ========================== +// student struct +#[derive(Copy, Drop, Serde, starknet::Store)] +struct Student { + name: felt252, + age: u8, + is_active: bool, + has_reward: bool, + xp_earnings: u256 +} + + +// ================================================ +// ========== SMART CONTRACT ====================== + +// classCharacterV3 smart contract +#[starknet::contract] +mod ClassCharacterV3 { + // libraries and trait imports + use core::zeroable::Zeroable; + use starknet::{ContractAddress, get_caller_address}; + use super::{IClassCharacter, IClassCharacterWithAccessControl, Student}; + + // ================================================ + // ================ CONSTRUCTOR =================== + #[constructor] + fn constructor(ref self: ContractState, _init_owner: ContractAddress) { + self.owner.write(_init_owner); + } + + // ================================================= + // ============ ERRORS ============================= + mod Errors { + const ZERO_ADDRESS_ERROR: felt252 = 'cant be called by address zero'; + const ONLY_OWNER_ERROR: felt252 = 'Only owner allowed'; + const ONLY_ACCOUNT_OWNER: felt252 = 'Only ACCT owner allowed'; + } + + // storage + #[storage] + struct Storage { + owner: ContractAddress, + students: LegacyMap:: + } + + //=========================================== + // ======= IMPLEMENTATIONS ================== + // triat without access control implementation + #[external(v0)] + impl classCharacterv3 of IClassCharacter { + fn get_owner(self: @ContractState) -> ContractAddress { + self.owner.read() + } + + fn set_owner(ref self: ContractState, new_owner: ContractAddress) -> bool { + self.owner.write(new_owner); + true + } + + fn get_student(self: @ContractState, studentAddr: ContractAddress) -> Student { + self.students.read(studentAddr) + } + + fn set_student( + ref self: ContractState, + _studentAddr: ContractAddress, + _name: felt252, + _age: u8, + _is_active: bool, + _has_reward: bool, + _xp_earnings: u256 + ) -> bool { + let student_instance = Student { + name: _name, + age: _age, + is_active: _is_active, + has_reward: _has_reward, + xp_earnings: _xp_earnings + }; + + self.students.write(_studentAddr, student_instance); + true + } + } + + // triat with access control implementation + #[external(v0)] + impl classCharacterv3WithAccessControl of IClassCharacterWithAccessControl { + fn get_owner_with_access_control(self: @ContractState) -> ContractAddress { + self.zero_address(); + self.owner.read() + } + + fn set_owner_with_access_control( + ref self: ContractState, new_owner: ContractAddress + ) -> bool { + self.zero_address(); + self.only_owner(); + self.owner.write(new_owner); + true + } + + fn get_student_with_access_control( + self: @ContractState, student_addr: ContractAddress + ) -> Student { + self.caller_is_student(student_addr); + self.students.read(student_addr) + } + + fn set_student_with_access_control( + ref self: ContractState, + _studentAddr: ContractAddress, + _name: felt252, + _age: u8, + _is_active: bool, + _has_reward: bool, + _xp_earnings: u256 + ) -> bool { + let student_instance = Student { + name: _name, + age: _age, + is_active: _is_active, + has_reward: _has_reward, + xp_earnings: _xp_earnings + }; + self.only_owner(); + self.students.write(_studentAddr, student_instance); + true + } + } + + #[generate_trait] + impl Private of PrivateTrait { + fn only_owner(self: @ContractState) { + let caller = get_caller_address(); + let owner = self.owner.read(); + assert(caller == owner, Errors::ONLY_OWNER_ERROR) + } + + fn zero_address(self: @ContractState) { + let caller = get_caller_address(); + assert(!caller.is_zero(), Errors::ZERO_ADDRESS_ERROR) + } + + fn caller_is_student(self: @ContractState, studentAddr: ContractAddress) { + let caller = get_caller_address(); + assert(caller == studentAddr, Errors::ONLY_ACCOUNT_OWNER) + } + } +} diff --git a/src/lib.cairo b/src/lib.cairo index 5aa9be5..c981019 100644 --- a/src/lib.cairo +++ b/src/lib.cairo @@ -1,4 +1,5 @@ mod class_character; mod class_character_v2; +mod class_character_v3; mod owner_contract; mod bwc_erc20_token;