docs: src-5 implement #233

Jemiiah · 2024-07-08T18:22:19Z

**Issue(s) : #109

julio4

The PR is empty, please double check that you actually committed your changes

Jemiiah · 2024-07-10T13:03:10Z

my apologies

Jemiiah · 2024-07-10T14:36:41Z

hello @julio could you please review i made another commit

listings/src-5 interface.md

julio4 · 2024-07-10T15:38:00Z

listings/src-5 interface.md

+* Detect if a contract implements SRC-5.
+* Detect if a contract implements any given interface.


SRC-5 is an interface, so you can just say

Detect if a contract implements any given interface. (including SRC-5)

julio4 · 2024-07-10T15:39:03Z

listings/src-5 interface.md

+
+### SRC-5 offers a standardized method to:
+
+* Identify interfaces.


Identify has the same meaning of detection. Maybe you meant provide a way to generate an unique identifier for each interface.

julio4 · 2024-07-10T15:42:05Z

listings/src-5 interface.md

+
+    trait IMyContract {
+    fn foo(some: u256) -> felt252;
+    }
+With Cairo 2.0, generic traits can represent a set of interfaces:


put the code content:

in code block with
```rust
...
```

include codes from a listing (to ensure that all codes in the book is always compilable)

julio4 · 2024-07-10T15:42:58Z

listings/src-5 interface.md

+The function selector in Starknet is the starknet_keccak hash of the function name. The extended function selector, for SRC-5, is the starknet_keccak hash of the function signature:
+
+
+    fn_name(param1_type,param2_type,...)->output_type


this will not be in a listing, so use `fn_name(param1_type,param2_type,...)->output_type`

julio4 · 2024-07-15T06:05:37Z

listings/src-5 interface.md

+``` use openzeppelin::account::interface::ISRC5_ID;
+use openzeppelin::introspection::src5::SRC5Component;
+use starknet::contract::ContractAddress;
+use starknet::syscalls::call_contract_syscall;
+use starknet::alloc::arrays::ArrayTrait;
+use starknet::core::keccak::starknet_keccak;
+
+// Define ISRC5 interface
+trait ISRC5 {
+    fn supports_interface(interface_id: felt252) -> bool;
+}
+
+// Define example interfaces
+trait IExample1 {
+    fn example_function1(param1: felt252) -> felt252;
+}
+
+trait IExample2 {
+    fn example_function2(param1: felt252, param2: felt252) -> felt252;
+}
+
+// Storage structure
+struct Storage {
+    public_key: felt252,
+    src5: SRC5Component::Storage,
+}
+
+// Event definitions
+enum Event {
+    AccountCreated: felt252,
+    SRC5Event: SRC5Component::Event,
+}
+
+// Contract implementation
+@contract
+namespace ExampleContract {
+    struct State {
+        storage: Storage,
+    }
+
+    // Constructor
+    #[constructor]
+    fn constructor(ref state: State, public_key: felt252) {
+        state.storage.public_key = public_key;
+        emit(Event::AccountCreated(public_key));
+        state.storage.src5.register_interface(ISRC5_ID);
+    }
+
+    // Implementation of ISRC5
+    #[external]
+    fn supports_interface(ref state: State, interface_id: felt252) -> bool {
+        state.storage.src5.supports_interface(interface_id)
+    }
+
+    // Implementation of IExample1
+    #[external]
+    fn example_function1(param1: felt252) -> felt252 {
+        // Your implementation here
+        return starknet_keccak(param1.to_bytes());
+    }
+
+    // Implementation of IExample2
+    #[external]
+    fn example_function2(param1: felt252, param2: felt252) -> felt252 {
+        // Your implementation here
+        return param1 + param2;
+    }
+
+    // Additional functions or internal logic can be added here
+}
+
+// ISRC5 trait implementation
+impl ISRC5 for State {
+    fn supports_interface(ref self, interface_id: felt252) -> bool {
+        self.storage.src5.supports_interface(interface_id)
+    }
+}
+
+// Interface registration during contract deployment
+fn main() {
+    let state = ExampleContract::State {
+        storage: Storage {
+            public_key: felt252::default(),
+            src5: SRC5Component::Storage::default(),
+        },
+    };
+    ExampleContract::constructor(state, 12345.into());
+}
+```


This should be in a listing

julio4 · 2024-07-15T06:06:19Z

listings/src-5 interface.md

+
+
+    fn_name(param1_type,param2_type,...)->output_type
+For example, for a function with zero parameters and no return     value:


Be sure to double check whitespaces and typos.

julio4 · 2024-07-15T06:08:20Z

listings/src-5 interface.md

+        interface_id ^= function_id
+    print('IAccount ID:', hex(interface_id))
+
+    compute_interface_id()


You can add link to https://github.com/ericnordelo/src5-rs

Jemiiah · 2024-07-15T16:40:07Z

@julio4 made all necessary corrections

julio4

You might have been a bit confused with the separation between listings and src:

listings contains only scarb projects, with the actual contracts sources
src contains all the .md files, and use mdbook include directive to add the source to each examples from listings

We do that way so we can compile, tests, lint, exports all examples and only add documentation "on top of it".

So in your case you should keep all the markdown documentation inside src, and only add a listing as a scarb project. Take a look at other examples if you're not sure how to do it.

Jemiiah · 2024-07-19T13:54:15Z

would implement the corrections today and make the push

julio4

Looks good! Lots of small changes requested, and also I think it's best to simplify the example. But overall looking great, thank you!
Be sure to review and resolve all change requests, it makes reviewing faster!

listings/src5_interface/src/lib.cairo

julio4 · 2024-07-24T07:20:54Z

listings/src5_interface/src/lib.cairo

+#[cfg(test)]
+mod tests;


You can add test module directly inside main module behind a test anchor

You moved test functions so you can remove tests module definition here

julio4 · 2024-07-24T07:21:22Z

src/src5 implementation.md

+
+
+


julio4 · 2024-07-24T07:23:21Z

src/src5 implementation.md

@@ -0,0 +1,113 @@
+## SRC-5: A comprhensive Overview
+
+SRC-5 is a standard for smart contract interface introspection in Starknet, inspired by the Ethereum ERC-165 standard. It provides a method for contracts to publish and detect the interfaces they implement, ensuring standardized interaction. It provides a method for contracts to publish and detect the interfaces they implement, ensuring standardized interaction.  You can find more information and details refer to the [SRC-5 specification](https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-5.md#simple-summary) and the [Ethereum ERC-165 standard](https://eips.ethereum.org/EIPS/eip-165).


Remove sentence duplications, add some breaklines, fix multiple whitespaces, move link for ERC-165 directly when you mention it first.

julio4 · 2024-07-24T07:23:29Z

src/src5 implementation.md

@@ -0,0 +1,113 @@
+## SRC-5: A comprhensive Overview


comprhensive typo

src/src5 implementation.md

julio4 · 2024-07-24T07:43:36Z

src/src5 implementation.md

+
+#### Detecting Any Given Interface
+* Confirm if the contract implements SRC-5.
+* If confirmed, call supports_interface(interface_id) to check for specific interfaces.


julio4 · 2024-07-24T07:53:55Z

src/src5 implementation.md

+* If confirmed, call supports_interface(interface_id) to check for specific interfaces.
+* If not, manually inspect the contract methods.
+
+Below shows a contract implementing the ```ISRC5``` trait :


add which interface it exposes as well
"Below shows a contract implementing SRC5 to expose the xxx interface:"

julio4 · 2024-07-24T07:54:51Z

src/src5 implementation.md

+    from starkware.starknet.public.abi import starknet_keccak
+
+    signatures = [
+    'supports_interface(felt252)->E((),())',
+    'is_valid_signature(felt252,Array<felt252>)->E((),())',
+    '__execute__(Array<(ContractAddress,felt252,Array<felt252>)>)->Array<(@Array<felt252>)>',
+    '__validate__(Array<(ContractAddress,felt252,Array<felt252>)>)->felt252',
+    '__validate_declare__(felt252)->felt252'
+    ]
+
+    def compute_interface_id():
+    interface_id = 0x0
+    for sig in signatures:
+        function_id = starknet_keccak(sig.encode())
+        interface_id ^= function_id
+    print('IAccount ID:', hex(interface_id))
+
+    compute_interface_id()


Also, it might be a good idea to move this code snippet inside the listing directory in a python file

listings/src5_interface/src/src5_interface.cairo

Jemiiah · 2024-07-24T14:55:20Z

@julio4 please review ser

julio4

Please review and resolve all change requests before requesting and run the verification script as well

julio4 · 2024-08-08T05:23:50Z

listings/src5_interface/src5_snippet.py

Wrong format, please try to run the code before pushing it

julio4 · 2024-08-08T05:28:14Z

listings/src5_interface/src/src5_interface.cairo

This is not valid cairo syntax, please refer to official documentation, or our counter example, and don't use AI generated content.

julio4 · 2024-08-08T05:29:27Z

listings/src5_interface/src/lib.cairo

+#[cfg(test)]
+mod tests;


You moved test functions so you can remove tests module definition here

feat: src-5 implement

434e473

Jemiiah changed the title ~~feat: src-5 implement~~ docs: src-5 implement Jul 8, 2024

julio4 reviewed Jul 10, 2024

View reviewed changes

feat: src5 implement

16f9f3e

julio4 requested changes Jul 15, 2024

View reviewed changes

feat: mdbook directory

9d2d4c1

julio4 requested changes Jul 19, 2024

View reviewed changes

BillXJ added 2 commits July 20, 2024 15:10

feat:src5 implement

7ca2112

feat:src5 docs

27fee4b

julio4 requested changes Jul 24, 2024

View reviewed changes

feat: src5 implement

4bb6302

Jemiiah mentioned this pull request Jul 29, 2024

Research: Explore the Explorers walnuthq/op-scan#44

Open

Jemiiah added 2 commits July 30, 2024 08:00

Merge branch 'NethermindEth:main' into main

cf325d8

feat: src5 documentation

4018036

julio4 requested changes Aug 8, 2024

View reviewed changes

Merge branch 'NethermindEth:main' into main

2757850

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: src-5 implement #233

docs: src-5 implement #233

Jemiiah commented Jul 8, 2024

julio4 left a comment

Jemiiah commented Jul 10, 2024

Jemiiah commented Jul 10, 2024

julio4 Jul 10, 2024

julio4 Jul 10, 2024

julio4 Jul 10, 2024

julio4 Jul 10, 2024

julio4 Jul 15, 2024

julio4 Jul 15, 2024

julio4 Jul 15, 2024

Jemiiah commented Jul 15, 2024

julio4 left a comment

Jemiiah commented Jul 19, 2024

julio4 left a comment •

edited

Loading

julio4 Jul 24, 2024

julio4 Aug 8, 2024

julio4 Jul 24, 2024

julio4 Jul 24, 2024

julio4 Jul 24, 2024

julio4 Jul 24, 2024

julio4 Jul 24, 2024

julio4 Jul 24, 2024

Jemiiah commented Jul 24, 2024

julio4 left a comment

julio4 Aug 8, 2024

julio4 Aug 8, 2024

julio4 Aug 8, 2024

		* Detect if a contract implements SRC-5.
		* Detect if a contract implements any given interface.


		### SRC-5 offers a standardized method to:

		* Identify interfaces.

		The function selector in Starknet is the starknet_keccak hash of the function name. The extended function selector, for SRC-5, is the starknet_keccak hash of the function signature:


		fn_name(param1_type,param2_type,...)->output_type



		fn_name(param1_type,param2_type,...)->output_type
		For example, for a function with zero parameters and no return value:

		@@ -0,0 +1,113 @@
		## SRC-5: A comprhensive Overview

		SRC-5 is a standard for smart contract interface introspection in Starknet, inspired by the Ethereum ERC-165 standard. It provides a method for contracts to publish and detect the interfaces they implement, ensuring standardized interaction. It provides a method for contracts to publish and detect the interfaces they implement, ensuring standardized interaction. You can find more information and details refer to the [SRC-5 specification](https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-5.md#simple-summary) and the [Ethereum ERC-165 standard](https://eips.ethereum.org/EIPS/eip-165).

		#[cfg(test)]
		mod tests;

		#[cfg(test)]
		mod tests;

docs: src-5 implement #233

Are you sure you want to change the base?

docs: src-5 implement #233

Conversation

Jemiiah commented Jul 8, 2024

julio4 left a comment

Choose a reason for hiding this comment

Jemiiah commented Jul 10, 2024

Jemiiah commented Jul 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jemiiah commented Jul 15, 2024

julio4 left a comment

Choose a reason for hiding this comment

Jemiiah commented Jul 19, 2024

julio4 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jemiiah commented Jul 24, 2024

julio4 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

julio4 left a comment •

edited

Loading