Withdraw Docs

[trajan0x]

Add documentation to docs/bridge for #2826

[greptile-apps]

To address issue #2826, add documentation for the withdraw functionality to docs/bridge. The relevant code can be found in services/explorer/contracts/bridge/bridgev1/withdraw.go and services/explorer/contracts/bridge/withdraw.go. Document the following methods:

1. GetRaw: Retrieves raw event logs.
2. GetToken: Gets the token address.
3. GetAmount: Gets the token amount.
4. GetEventType: Gets the event type.
5. GetFee: Gets the fee for the withdraw.
6. GetKappa: Gets the kappa value.
7. GetTxHash: Gets the transaction hash.
8. GetBlockNumber: Gets the block number.
9. GetContractAddress: Gets the contract address.
10. GetRecipient: Gets the recipient address.
11. GetSwapTokenIndex, GetSwapMinAmount, GetSwapDeadline, GetSwapSuccess: Document these methods for SynapseBridgeTokenWithdrawAndRemove.

References

/docs/bridge/docs
/services/explorer/contracts/bridge/bridgev1/withdraw.go
/services/explorer/contracts/bridge/withdraw.go

About Greptile

This response provides a starting point for your research, not a precise solution.

Help us improve! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

Ask Greptile · Edit Issue Bot Settings