fix: randomness requestor typos

NethermindEth · Oct 3, 2024 · 4e66004 · 4e66004
1 parent 4afb7e0
commit 4e66004
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 17 deletions.
diff --git a/_typos.toml b/_typos.toml
@@ -1,6 +1,9 @@
+[default]
+extend-ignore-identifiers-re = ["requestor", "REQUESTOR", "Requestor"]
+
 [type.po]
 extend-glob = ["*.po", "*.css", "*.js"]
 check-file = false
 
 [files]
-extend-exclude = ["po/*.po", "listings/**/*.json"]
+extend-exclude = ["po/*.po", "listings/**/*.json"]
diff --git a/listings/applications/coin_flip/src/contract.cairo b/listings/applications/coin_flip/src/contract.cairo
@@ -10,7 +10,7 @@ pub trait ICoinFlip<TContractState> {
 pub trait IPragmaVRF<TContractState> {
     fn receive_random_words(
         ref self: TContractState,
-        requester_address: ContractAddress,
+        requestor_address: ContractAddress,
         request_id: u64,
         random_words: Span<felt252>,
         calldata: Array<felt252>
@@ -65,7 +65,7 @@ pub mod CoinFlip {
         pub const CALLER_NOT_RANDOMNESS: felt252 = 'Caller not randomness contract';
         pub const INVALID_ADDRESS: felt252 = 'Invalid address';
         pub const INVALID_FLIP_ID: felt252 = 'No flip with the given ID';
-        pub const REQUESTER_NOT_SELF: felt252 = 'Requester is not self';
+        pub const REQUESTOR_NOT_SELF: felt252 = 'Requestor is not self';
         pub const TRANSFER_FAILED: felt252 = 'Transfer failed';
     }
 
@@ -103,7 +103,7 @@ pub mod CoinFlip {
     impl PragmaVRF of super::IPragmaVRF<ContractState> {
         fn receive_random_words(
             ref self: ContractState,
-            requester_address: ContractAddress,
+            requestor_address: ContractAddress,
             request_id: u64,
             random_words: Span<felt252>,
             calldata: Array<felt252>
@@ -114,7 +114,7 @@ pub mod CoinFlip {
             );
 
             let this = get_contract_address();
-            assert(requester_address == this, Errors::REQUESTER_NOT_SELF);
+            assert(requestor_address == this, Errors::REQUESTOR_NOT_SELF);
 
             self._process_coin_flip(request_id, random_words.at(0));
         }

diff --git a/listings/applications/coin_flip/src/mock_randomness.cairo b/listings/applications/coin_flip/src/mock_randomness.cairo
@@ -62,7 +62,7 @@ pub mod MockRandomness {
         fn submit_random(
             ref self: ContractState,
             request_id: u64,
-            requester_address: ContractAddress,
+            requestor_address: ContractAddress,
             seed: u64,
             minimum_block_number: u64,
             callback_address: ContractAddress,
@@ -72,11 +72,11 @@ pub mod MockRandomness {
             proof: Span<felt252>,
             calldata: Array<felt252>
         ) {
-            let requester = IPragmaVRFDispatcher { contract_address: callback_address };
-            requester.receive_random_words(requester_address, request_id, random_words, calldata);
+            let requestor = IPragmaVRFDispatcher { contract_address: callback_address };
+            requestor.receive_random_words(requestor_address, request_id, random_words, calldata);
             let eth_dispatcher = self.eth_dispatcher.read();
             let success = eth_dispatcher
-                .transfer(requester_address, (callback_fee_limit - callback_fee).into());
+                .transfer(requestor_address, (callback_fee_limit - callback_fee).into());
             assert(success, Errors::TRANSFER_FAILED);
         }
 
@@ -92,7 +92,7 @@ pub mod MockRandomness {
         }
         fn update_status(
             ref self: ContractState,
-            requester_address: ContractAddress,
+            requestor_address: ContractAddress,
             request_id: u64,
             new_status: RequestStatus
         ) {
@@ -102,7 +102,7 @@ pub mod MockRandomness {
         fn cancel_random_request(
             ref self: ContractState,
             request_id: u64,
-            requester_address: ContractAddress,
+            requestor_address: ContractAddress,
             seed: u64,
             minimum_block_number: u64,
             callback_address: ContractAddress,
@@ -113,22 +113,22 @@ pub mod MockRandomness {
         }
 
         fn get_pending_requests(
-            self: @ContractState, requester_address: ContractAddress, offset: u64, max_len: u64
+            self: @ContractState, requestor_address: ContractAddress, offset: u64, max_len: u64
         ) -> Span<felt252> {
             panic!("unimplemented")
         }
 
         fn get_request_status(
-            self: @ContractState, requester_address: ContractAddress, request_id: u64
+            self: @ContractState, requestor_address: ContractAddress, request_id: u64
         ) -> RequestStatus {
             panic!("unimplemented")
         }
-        fn requester_current_index(
-            self: @ContractState, requester_address: ContractAddress
+        fn requestor_current_index(
+            self: @ContractState, requestor_address: ContractAddress
         ) -> u64 {
             panic!("unimplemented")
         }
-        fn get_public_key(self: @ContractState, requester_address: ContractAddress) -> felt252 {
+        fn get_public_key(self: @ContractState, requestor_address: ContractAddress) -> felt252 {
             panic!("unimplemented")
         }
         fn get_payment_token(self: @ContractState) -> ContractAddress {
@@ -146,7 +146,7 @@ pub mod MockRandomness {
             panic!("unimplemented")
         }
         fn get_out_of_gas_requests(
-            self: @ContractState, requester_address: ContractAddress,
+            self: @ContractState, requestor_address: ContractAddress,
         ) -> Span<u64> {
             panic!("unimplemented")
         }