Merge pull request #37 from blooo-io/docs/LDG-639-documentation

doc: added StakeHub smart contract and methods to the README file

Makefile

@@ -21,6 +21,6 @@ APPNAME = "StakeKit"
 # Application version
 APPVERSION_M = 1
 APPVERSION_N = 3
-APPVERSION_P = 0
+APPVERSION_P = 1
 
 include ethereum-plugin-sdk/standard_plugin.mk

README.md

@@ -39,14 +39,15 @@ Smart contracts covered by this plugin are:
 | GRT Native Staking | Ethereum  | GraphProxy | 0xf55041e37e12cd407ad00ce2910b8269b01263b9| L1Staking | 0x20a14D78848BC8B3F3d4B77239F2adC3C0259A10 |
 | SUSHI xSUSHI Staking | Ethereum  | SushiBar | 0x8798249c2e607446efb7ad49ec89dd1865ff4272| X | X |
 | Compound V3 USDC | <table>  <tbody>  <tr> <td><code>Ethereum</code></td></tr> <tr><td><code>Ethereum</code></td></tr> <tr><td><code>Polygon</code></td></tr> <tr><td><code>Polygon</code></td></tr></tbody> </table>  | <table>  <tbody>  <tr> <td><code>TransparentUpgradeableProxy</code></td></tr> <tr><td><code>CometRewards</code></td></tr> <tr><td><code>TransparentUpgradeableProxy</code></td></tr> <tr><td><code>CometRewards</code></td></tr> </tbody> </table> |  <table>  <tbody>  <tr> <td><code>0xc3d688b66703497daa19211eedff47f25384cdc3</code></td></tr> <tr><td><code>0x1b0e765f6224c21223aea2af16c1c46e38885a40</code></td></tr> <tr><td><code>0xf25212e676d1f7f89cd72ffee66158f541246445</code></td></tr> <tr><td><code>0x45939657d1ca34a8fa39a924b71d28fe8431e581</code></td></tr></tbody> </table> | <table>  <tbody>  <tr> <td><code>Comet</code></td></tr> <tr><td><code>X</code></td></tr></tbody> <tr><td><code>Comet</code></td></tr> <tr><td><code>X</code></td></tr></table> | <table>  <tbody>  <tr> <td><code>0xBFC4FeEc175996C08C8F3a0469793a7979526065</code></td></tr> <tr><td><code>X</code></td></tr> <tr><td><code>0x4149BF3b11a90817B138b1D25BE640Ac4925a175</code></td></tr> <tr><td><code>X</code></td></tr></tbody> </table> |
-| BNB Native Staking | BSC  | TokenHub | 0x0000000000000000000000000000000000001004| X | X |
+| BNB Native Staking (Legacy) | BSC  | TokenHub | 0x0000000000000000000000000000000000001004| X | X |
 | Celo Native Staking | Celo  | <table> <tbody> <tr> <td><code>AccountsProxy</code></td></tr> <tr><td><code>LockedGoldProxy</code></td></tr> <tr><td><code>ElectionProxy</code></td></tr></tbody> </table> | <table> <tbody> <tr> <td><code>0x7d21685c17607338b313a7174bab6620bad0aab7</code></td></tr> <tr><td><code>0x6cc083aed9e3ebe302a6336dbc7c921c9f03349e</code></td></tr> <tr><td><code>0x8d6677192144292870907e3fa8a5527fe55a7ff6</code></td></tr></tbody> </table>| <table> <tbody> <tr> <td><code>Accounts</code></td></tr> <tr><td><code>LockedGold</code></td></tr> <tr><td><code>Election</code></td></tr></tbody> </table> |<table> <tbody> <tr> <td><code>0x75Ec00c4B09574945F7d407797f8b61ca5AD9Cef</code></td></tr> <tr><td><code>0xdEBe38061Db542E8c2AF2427a312f70816965E93</code></td></tr> <tr><td><code>0xCdE5039e3AcB3483aEebEBd59Cf6936056c455D4</code></td></tr></tbody> </table>  |
 | Avalanche Liquid Staking | Avalanche  | TransparentUpgradeableProxy | 0x2b2c81e08f1af8835a78bb2a90ae924ace0ea4be| StakedAvax | 0x0CE7F620Eb645a4FbF688a1C1937bC6CB0CbDd29 |
 |Aave v3 Lending DAI | <table>  <tbody>  <tr> <td><code>Optimism</code></td></tr> <tr><td><code>Polygon</code></td></tr> <tr><td><code>Arbitrum</code></td></tr> <tr><td><code>Avalanche</code></td></tr> </tbody> </table>   |InitializableImmutableAdminUpgradeabilityProxy | 0x794a61358d6845594f94dc1db02a252b5b4814ad | <table>  <tbody>  <tr> <td><code>Pool</code></td></tr> <tr><td><code>Pool</code></td></tr> <tr><td><code>L2Pool</code></td></tr> <tr><td><code>L2Pool</code></td></tr> </tbody> </table> | <table>  <tbody>  <tr> <td><code>0xb77fc84a549ecc0b410d6fa15159C2df207545a3</code></td></tr> <tr><td><code>0xCf85FF1c37c594a10195F7A9Ab85CBb0a03f69dE</code></td></tr> <tr><td><code>0x764594F8e9757edE877B75716f8077162B251460</code></td></tr> <tr><td><code>0xbCb167bDCF14a8F791d6f4A6EDd964aed2F8813B</code></td></tr> </tbody> </table>
 |Yearn Vault | <table>  <tbody>  <tr> <td><code>Ethereum</code></td></tr> <tr><td><code>Optimism</code></td></tr> <tr><td><code>Fantom</code></td></tr> </tbody> </table>   | Yearn Vault | [Token json](./tokens.json) |
 | Angle Protocol | <table><tbody> <tr><td><code>Ethereum</code></td></tr> <tr><td><code>Arbitrum</code></td></tr> </tbody></table> | TransparentUpgradeableProxy | 0x004626A008B1aCdC4c74ab51644093b155e59A23| Savings | 0xfD2cCc920d498db30FBE9c13D5705aE2C72670F9 |
 | Lido stETH Withdrawal NFT | Ethereum | OssifiableProxy | 0x889edC2eDab5f40e902b864aD4d7AdE8E412F9B1| WithdrawalQueueERC721 | 0xE42C659Dc09109566720EA8b2De186c2Be7D94D9 |
 | VIC Native Staking | Viction | TomoValidator | 0x0000000000000000000000000000000000000088| X | X |
+| BNB Native Staking | BSC        | StakeHub       | 0x0000000000000000000000000000000000002002| X | X |
 
 
 ## Methods
@@ -66,15 +67,15 @@ Methods covered by this plugin are:
 | GRT Native Staking | L1Staking    | <table><tbody>  <tr><td><code>0x026e402b</code></td></tr> <tr><td><code>0x4d99dd16</code></td></tr> <tr><td><code>0x51a60b02</code></td></tr> </tbody></table>  | <table><tbody> <tr><td><code>delegate</code></td></tr> <tr><td><code>undelegate</code></td></tr> <tr><td><code>withdrawDelegated</code></td></tr> </tbody></table> |
 | SUSHI xSUSHI Staking | SushiBar    | <table><tbody>  <tr><td><code>0xa59f3e0c</code></td></tr> <tr><td><code>0x67dfd4c9</code></td></tr> </tbody></table> | <table><tbody>  <tr><td><code>enter</code></td></tr> <tr><td><code>leave</code></td></tr> </tbody></table> |
 |Compound V3 USDC | <table><tbody>  <tr><td><code>Comet</code></td></tr> <tr><td><code>Comet</code></td></tr> <tr><td><code>CometRewards</code></td></tr> </tbody></table>    | <table><tbody>  <tr><td><code>0xf2b9fdb8</code></td></tr> <tr><td><code>0xf3fef3a3</code></td></tr> <tr><td><code>0xb7034f7e</code></td></tr> </tbody></table> | <table><tbody>  <tr><td><code>supply</code></td></tr> <tr><td><code>withdraw</code></td></tr> <tr><td><code>claim</code></td></tr> </tbody></table> |
-| BNB Native Staking | TokenHub    | 0xaa7415f5 | transferOut |
+| BNB Native Staking (Legacy) | TokenHub    | 0xaa7415f5 | transferOut |
 | Celo Native Staking | <table><tbody>  <tr><td><code>Accounts</code></td></tr> <tr><td><code>LockedGold</code></td></tr> <tr><td><code>LockedGold</code></td></tr> <tr><td><code>LockedGold</code></td></tr> <tr><td><code>Election</code></td></tr> <tr><td><code>Election</code></td></tr> </tbody></table>    | <table><tbody>  <tr><td><code>0x9dca362f</code></td></tr> <tr><td><code>0xf83d08ba</code></td></tr> <tr><td><code>0x6198e339</code></td></tr> <tr><td><code>0x2e1a7d4d</code></td></tr> <tr><td><code>0x580d747a</code></td></tr> <tr><td><code>0x6e198475</code></td></tr> </tbody></table> | <table><tbody>  <tr><td><code>createAccount</code></td></tr> <tr><td><code>lock</code></td></tr> <tr><td><code>unlock</code></td></tr> <tr><td><code>withdraw</code></td></tr> <tr><td><code>vote</code></td></tr> <tr><td><code>revokeActive</code></td></tr> </tbody></table> |
 | Aave v3 Lending DAI | <table><tbody>  <tr><td><code>L2Pool</code></td></tr> <tr><td><code>Pool</code></td></tr> </tbody></table> | <table><tbody>  <tr><td><code>0x617ba037</code></td></tr> <tr><td><code>0x69328dec</code></td></tr> </tbody></table> | <table><tbody>  <tr><td><code>supply</code></td></tr> <tr><td><code>withdraw</code></td></tr> </tbody></table> |
 | Avalanche Liquid Staking | StakedAvax    | <table><tbody>  <tr><td><code>0x5bcb2fc6</code></td></tr> <tr><td><code>0xc9d2ff9d</code></td></tr> <tr><td><code>0xdb006a75</code></td></tr> <tr><td><code>0xbe040fb0</code></td></tr> <tr><td><code>0x0d10d32c</code></td></tr> <tr><td><code>0x0f7e2048</code></td></tr> </tbody></table> | <table><tbody>  <tr><td><code>submit</code></td></tr> <tr><td><code>requestUnlock</code></td></tr> <tr><td><code>redeem</code></td></tr> <tr><td><code>redeem</code></td></tr> <tr><td><code>redeemOverdueShares</code></td></tr> <tr><td><code>redeemOverdueShares</code></td></tr> </tbody></table> |
 | Yearn Vault | Yearn Vault    | <table><tbody>  <tr><td><code>0xd0e30db0</code></td></tr> <tr><td><code>0xb6b55f25</code></td></tr> <tr><td><code>0x6e553f65</code></td></tr> <tr><td><code>0x3ccfd60b</code></td></tr> <tr><td><code>0x2e1a7d4d</code></td></tr> <tr><td><code>0x00f714ce</code></td></tr> </tbody></table> | <table><tbody>  <tr><td><code>deposit</code></td></tr> <tr><td><code>deposit</code></td></tr> <tr><td><code>deposit</code></td></tr> <tr><td><code>withdraw</code></td></tr> <tr><td><code>withdraw</code></td></tr> <tr><td><code>withdraw</code></td></tr> </tbody></table> |
 | Angle Protocol | Savings | <table><tbody>  <tr><td><code>0x6e553f65</code></td></tr> <tr><td><code>0xb460af94</code></td></tr>  </tbody></table> | <table><tbody>  <tr><td><code>deposit</code></td></tr><tr><td><code>withdraw</code></td></tr> </tbody></table> |
 | Lido stETH Withdrawal NFT | WithdrawalQueueERC721 | <table><tbody>  <tr><td><code>0xd6681042</code></td></tr> <tr><td><code>0xe3afe0a3</code></td></tr>  </tbody></table> | <table><tbody>  <tr><td><code>requestWithdrawals</code></td></tr><tr><td><code>claimWithdrawals</code></td></tr> </tbody></table> |
 | VIC Native Staking | TomoValidator | <table><tbody>  <tr><td><code>0x6dd7d8ea</code></td></tr> <tr><td><code>0x02aa9be2</code></td></tr> <tr><td><code>0xae6e43f5</code></td></tr> <tr><td><code>0x441a3e70</code></td></tr>  </tbody></table> | <table><tbody>  <tr><td><code>vote</code></td></tr> <tr><td><code>unvote</code></td></tr> <tr><td><code>resign</code></td></tr> <tr><td><code>withdraw</code></td></tr> </tbody></table> |
-
+| BNB Native Staking | StakeHub | <table><tbody>  <tr><td><code>0xaad3ec96</code></td></tr> <tr><td><code>0x982ef0a7</code></td></tr> <tr><td><code>0x4d99dd16</code></td></tr> <tr><td><code>0x59491871</code></td></tr>  </tbody></table> | <table><tbody>  <tr><td><code>claim</code></td></tr> <tr><td><code>delegate</code></td></tr> <tr><td><code>undelegate</code></td></tr> <tr><td><code>redelegate</code></td></tr> </tbody></table> |
 
 ## Build