status-im
/
samyoul-notes
mirror of https://github.com/status-im/samyoul-notes.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Refactored the analysis dirs

This commit is contained in:
Samuel Hawksby-Robinson 2024-05-14 17:23:28 +01:00
parent a2a6428bee
commit 29e2d87ec3
4 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -4,9 +4,9 @@
- Wallet Router - Wallet Router
- I've analysed the main components of the wallet router, see here: - I've analysed the main components of the wallet router, see here:
- [wallet/Router file analysis](./analysis/wallet_router.md) - [wallet/Router file analysis](./analysis/wallet/Router/overview.md)
- [wallet/Router struct usage](./analysis/wallet_router_usage.md) - [wallet/Router struct usage](./analysis/wallet/Router/usage.md)
- [wallet/Router `newSuggestedRoutes()`](./analysis/wallet_router_newSuggestedRoutes.md) - [wallet/Router `newSuggestedRoutes()`](./analysis/wallet/Router/newSuggestedRoutes.md)
## Schedule ## Schedule
- I raised an axe to the crew meetings, swung hard and true. Toppled and prostrate they settled motionless. Tonight we revel in the light of their embers! - I raised an axe to the crew meetings, swung hard and true. Toppled and prostrate they settled motionless. Tonight we revel in the light of their embers!

4
analysis/wallet_router.md → analysis/wallet/Router/README.md
View File

@ -17,7 +17,7 @@
- Represents a transaction path including details like from/to networks, fees, and estimated costs. - Represents a transaction path including details like from/to networks, fees, and estimated costs.
- `Router` - `Router`
- Manages routing of transactions using different bridges defined for various transaction types. - Manages routing of transactions using different bridges defined for various transaction types.
- [Usage analysis](./wallet_router_usage.md) - [Usage analysis](./usage.md)
- **Functions:** - **Functions:**
- `requireApproval()` - `requireApproval()`
- Determines if token approval is required before executing a transaction over a bridge. - Determines if token approval is required before executing a transaction over a bridge.
@ -30,7 +30,7 @@
- Determines if a specified blockchain network's Chain ID is present within a given list of Chain IDs - Determines if a specified blockchain network's Chain ID is present within a given list of Chain IDs
- `newSuggestedRoutes()` - `newSuggestedRoutes()`
- newSuggestedRoutes function is a crucial part of the route selection and optimization process routing transactions across potentially complex network paths. - newSuggestedRoutes function is a crucial part of the route selection and optimization process routing transactions across potentially complex network paths.
- [Detailed Analysis of `newSuggestedRoutes()`](./wallet_router_newSuggestedRoutes.md) - [Detailed Analysis of `newSuggestedRoutes()`](./newSuggestedRoutes.md)
# Transaction Handling # Transaction Handling
- The code handles transactions through various bridges which abstract the different transaction types. - The code handles transactions through various bridges which abstract the different transaction types.

0
analysis/wallet_router_newSuggestedRoutes.md → analysis/wallet/Router/newSuggestedRoutes.md
View File

4
analysis/wallet_router_usage.md → analysis/wallet/Router/usage.md
View File

@ -1,5 +1,7 @@
# Initialisation # Initialisation
The `Router` struct is only initialised in one place in the application, in `wallet/api.go`: The `Router` struct is only initialised in one place in the application, in `wallet/api.go`.
The consumption complexity is very low:
```go ```go
func NewAPI(s *Service) *API { func NewAPI(s *Service) *API {