-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'BlocSoc-iitr:v0.1' into v0.1
- Loading branch information
Showing
7 changed files
with
238 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # This workflow will build a golang project | ||
| # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go | ||
|
|
||
| name: Go | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ "main" ] | ||
| pull_request: | ||
| branches: [ "main" ] | ||
|
|
||
| jobs: | ||
|
|
||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Go | ||
| uses: actions/setup-go@v4 | ||
| with: | ||
| go-version: '1.20' | ||
|
|
||
| - name: Test | ||
| run: make unit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2024 Blockchain Society IIT Roorkee | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,101 +1,5 @@ | ||
| # [Athena](https://github.com/BlocSoc-iitr/Athena/tree/main/athena) | ||
| # Athena | ||
|
|
||
| Go package for interacting with starknet. It is a tool which can be used in cli for the following tasks | ||
| > ⚠️ This project is undergoing heavy development and is still on its early stages. There will be constant breaking changes. | ||
| This is inspired from nethermind/entro but implemented in GoLang and is therefore much faster than Entro. | ||
| Unlike entro which is limited to being a cli tool , We have implemented frontend as well for Athena(Currently limited to backfilling ) | ||
| We plan to make the frontend fully functional soon. | ||
|
|
||
| The below graph compares the backfilling time taken by Athena and Entro . | ||
|
|
||
|
|
||
|
|
||
|
|
||
|  | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Tasks it can perform | ||
|
|
||
| - Backfill full blocks including events , tx & receipts | ||
| - Get implementation history | ||
| - ABI Decoding | ||
| - Decoding of functions & events from a transaction | ||
|
|
||
|
|
||
|
|
||
| # Usage/Examples | ||
|
|
||
| ## Specify this in the following fields | ||
| from :- block number | ||
|
|
||
| to :- block number | ||
|
|
||
| jsonRpcUrl - https://rpc.nethermind.io/mainnet-juno?x-apikey=YOUR_API_KEY | ||
|
|
||
| output :- your_file_name.csv | ||
|
|
||
|
|
||
| ## [ ABI Decoder](https://github.com/BlocSoc-iitr/Athena/blob/main/athena/decoder/abi_decoder.go) | ||
| abi parser , to parse each event and function ie to get its name and parameters and their datatype to help us in decoding | ||
|
|
||
| ```bash | ||
| go run cli/get/starknet.go --classHash 0x01a736d6ed154502257f02b1ccdf4d9d1089f80811cd6acad48e6b6a9d1f2003 --jsonRpcUrl "https://rpc.nethermind.io/mainnet-juno?x-apikey=MIkLH4AOTdTH9uqu8PqvSHUBNnAnMU1fXdROa3qc1DsSVxvOcGRrwr6kSj1zsNjT" --decode | ||
| ``` | ||
| Result - list of functions and events decoded in that ABI to your console. | ||
|  | ||
|
|
||
|
|
||
| ## [ Event Decoder](https://github.com/BlocSoc-iitr/Athena/blob/main/athena/decoder/event_decoder.go) | ||
| To decode an event , user provides the contract hash and the name of the event and block range , firstly the abi is fetched and parsed and the data for the particular event and block range is fetched | ||
| The data fetched contains the keys and data required to decode the event , the decoder then initiates a new decoder class for that particular event and the event’s data is decoded with the provided inputs of hash,block range and event name | ||
|
|
||
|
|
||
| ```bash | ||
| go run cli/get/dispatcher.go -event TransactionExecuted -contract 0x005a708f9c84bc709e967086572c6655e2b85eaf5a2ef752d92e24e64c5e392c_1 -from 691000 -to 692000 | ||
| ``` | ||
| Result - | ||
|
|
||
|
|
||
| ## [Function Decoder](https://github.com/BlocSoc-iitr/Athena/blob/main/athena/decoder/function_decoder.go) | ||
| Similar as above but instead of keys and data pairs we give call data as input that we will fetch in the provided blockrange | ||
|
|
||
|
|
||
|
|
||
| ## [Backfill Events](https://github.com/BlocSoc-iitr/Athena/tree/main/athena/backfill/importers) | ||
|
|
||
| From - Block Number | ||
|
|
||
| To - Block Number | ||
|
|
||
|
|
||
| ```bash | ||
| go run cli/backfill/starknet_events.go --from 67800 --to 67801 --rpc-url https://starknet-mainnet.public.blastapi.io/rpc/v0_7 --output events.csv --chunk-size 100 | ||
| ``` | ||
|
|
||
| [With Filters](https://github.com/BlocSoc-iitr/Athena/blob/main/athena/backfill/filters.go) | ||
| ```bash | ||
| go run cli/backfill/starknet_filters.go -rpc-url "https://rpc.nethermind.io/mainnet-juno?x-apikey=MIkLH4AOTdTH9uqu8PqvSHUBNnAnMU1fXdROa3qc1DsSVxvOcGRrwr6kSj1zsNjT" -contract-address "0x01a736d6ed154502257f02b1ccdf4d9d1089f80811cd6acad48e6b6a9d1f2003" -from 100000 -to 200000 -output "filtered_events.csv" | ||
| ``` | ||
|
|
||
| Result - all events decoded in your excel file | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## [Backfill full blocks](https://github.com/BlocSoc-iitr/Athena/blob/main/athena/backfill/importers/starknet.go) | ||
|
|
||
| ```bash | ||
| go run starknet.go --from 110 --to 130 --rpc-url https://rpc.nethermind.io/mainnet-juno?x-apikey=MIkLH4AOTdTH9uqu8PqvSHUBNnAnMU1fXdROa3qc1DsSVxvOcGRrwr6kSj1zsNjT --output blocks_details.csv --transactionhash (for block data) | ||
| ``` | ||
| Result - all blocks , transaction hashes , receipts & events of that txns data in your csv files. | ||
|
|
||
| ## [Backfill with filters](https://github.com/BlocSoc-iitr/Athena/blob/main/athena/backfill/filters.go) | ||
|
|
||
|
|
||
|
|
||
|  | ||
| This project aims to implement a blockchain data decoder using Go. This is one of the [other](https://github.com/NethermindEth/entro) implementations that are being developed in python. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| package athena_abi | ||
|
|
||
| import ( | ||
| "errors" | ||
| "log" | ||
| ) | ||
|
|
||
| type StarknetABI struct { | ||
| ABIName *string | ||
| ClassHash []byte | ||
| Functions map[string]AbiFunction | ||
| Events map[string]AbiEvent | ||
| Constructor []AbiParameter | ||
| L1Handler *AbiFunction | ||
| ImplementedInterfaces map[string]AbiInterface | ||
| } | ||
|
|
||
| // Declare errors | ||
| var ( | ||
| errParseDefinedTypes = errors.New("unable to parse defined types") | ||
| errParseInterfaces = errors.New("unable to parse interfaces") | ||
| errParseFunctions = errors.New("unable to parse functions") | ||
| errParseEvents = errors.New("unable to parse events") | ||
| errParseConstructor = errors.New("unable to parse constructor") | ||
| errParseL1Handler = errors.New("unable to parse L1 handler") | ||
| errParseImplementedInterfaces = errors.New("unable to parse implemented interfaces") | ||
| ) | ||
|
|
||
| // Parse Starknet ABI from JSON | ||
| // @param abiJSON | ||
| // @param abiname | ||
| // @param classHash | ||
| func StarknetAbiFromJSON(abiJson []map[string]interface{}, abiName string, classHash []byte) (*StarknetABI, error) { | ||
| groupedAbi := GroupAbiByType(abiJson) | ||
|
|
||
| // Parse defined types (structs and enums) | ||
| definedTypes, err := ParseEnumsAndStructs(groupedAbi["type_def"]) | ||
| if err != nil { | ||
| sortedDefs, errDef := TopoSortTypeDefs(groupedAbi["type_def"]) | ||
| if errDef == nil { | ||
| defineTypes, errDtypes := ParseEnumsAndStructs(sortedDefs) | ||
| definedTypes = defineTypes | ||
| errDef = errDtypes | ||
| } | ||
| if errDef != nil { | ||
| return nil, errParseDefinedTypes | ||
| } | ||
| log.Println("ABI Struct and Enum definitions out of order & required topological sorting") | ||
| } | ||
|
|
||
| // Parse interfaces | ||
| var definedInterfaces []AbiInterface | ||
| for _, iface := range groupedAbi["interface"] { | ||
| functions := []AbiFunction{} | ||
| for _, funcData := range iface["items"].([]interface{}) { | ||
| parsedAbi, errWhileParsing := ParseAbiFunction(funcData.(map[string]interface{}), definedTypes) | ||
| if errWhileParsing != nil { | ||
| return nil, errParseInterfaces | ||
| } | ||
| functions = append(functions, *parsedAbi) | ||
| } | ||
| definedInterfaces = append(definedInterfaces, AbiInterface{ | ||
| name: iface["name"].(string), | ||
| functions: functions, | ||
| }) | ||
| } | ||
|
|
||
| // Parse functions | ||
| functions := make(map[string]AbiFunction) | ||
| for _, functionData := range groupedAbi["function"] { | ||
| funcName := functionData["name"].(string) | ||
| abiFunc, errParsingFunctions := ParseAbiFunction(functionData, definedTypes) | ||
| if errParsingFunctions != nil { | ||
| return nil, errParseFunctions | ||
| } | ||
| functions[funcName] = *abiFunc | ||
| } | ||
|
|
||
| // Add functions from interfaces | ||
| for _, iface := range definedInterfaces { | ||
| for _, function := range iface.functions { | ||
| functions[function.name] = function | ||
| } | ||
| } | ||
|
|
||
| // Parse events | ||
| parsedAbiEvents := []AbiEvent{} | ||
| for _, eventData := range groupedAbi["event"] { | ||
| parsedEvent, errParsingEvent := ParseAbiEvent(eventData, definedTypes) | ||
| if errParsingEvent != nil { | ||
| return nil, errParseEvents | ||
| } | ||
| parsedAbiEvents = append(parsedAbiEvents, *parsedEvent) | ||
| } | ||
|
|
||
| events := make(map[string]AbiEvent) | ||
| for _, event := range parsedAbiEvents { | ||
| if event.name != "" { | ||
| events[event.name] = event | ||
| } | ||
| } | ||
|
|
||
| // Parse constructor | ||
| var constructor []AbiParameter | ||
| if len(groupedAbi["constructor"]) == 1 { | ||
| for _, paramData := range groupedAbi["constructor"][0]["inputs"].([]interface{}) { | ||
| param := paramData.(map[string]interface{}) | ||
| typed, errorParsingType := parseType(param["type"].(string), definedTypes) | ||
| if errorParsingType != nil { | ||
| return nil, errParseConstructor | ||
| } | ||
| constructor = append(constructor, AbiParameter{ | ||
| Name: param["name"].(string), | ||
| Type: typed, | ||
| }) | ||
| } | ||
| } else { | ||
| constructor = nil | ||
| } | ||
|
|
||
| // Parse L1 handler | ||
| var l1Handler *AbiFunction | ||
| if len(groupedAbi["l1_handler"]) == 1 { | ||
| handler, errorParsingFunction := ParseAbiFunction(groupedAbi["l1_handler"][0], definedTypes) | ||
| if errorParsingFunction != nil { | ||
| return nil, errParseL1Handler | ||
| } | ||
| l1Handler = handler | ||
| } else { | ||
| l1Handler = nil | ||
| } | ||
|
|
||
| // Parse implemented interfaces | ||
| implementedInterfaces := make(map[string]AbiInterface) | ||
| implArray, ok := groupedAbi["impl"] | ||
| if !ok { | ||
| return nil, errParseImplementedInterfaces | ||
| } | ||
| for _, implData := range implArray { | ||
| implMap := implData | ||
| if ifaceName, ok := implMap["interface_name"].(string); ok { | ||
| for _, iface := range definedInterfaces { | ||
| if iface.name == ifaceName { | ||
| implementedInterfaces[iface.name] = iface | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Return the populated StarknetAbi struct | ||
| return &StarknetABI{ | ||
| ABIName: &abiName, | ||
| ClassHash: classHash, | ||
| Functions: functions, | ||
| Events: events, | ||
| Constructor: constructor, | ||
| L1Handler: l1Handler, | ||
| ImplementedInterfaces: implementedInterfaces, | ||
| }, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.