@aastar/sdk 0.16.8 → 0.16.11

package/docs/api/@aastar/core/type-aliases/StakingActions.md

@@ -0,0 +1,703 @@
+> **StakingActions** = `object`
+
+Defined in: [packages/core/src/actions/staking.ts:6](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L6)
+
+## Properties
+
+### authorizedSlashers()
+
+> **authorizedSlashers**: (`args`) => `Promise`\<`boolean`\>
+
+Defined in: [packages/core/src/actions/staking.ts:37](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L37)
+
+#### Parameters
+
+##### args
+
+###### slasher
+
+`Address`
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### availableBalance()
+
+> **availableBalance**: (`args`) => `Promise`\<`bigint`\>
+
+Defined in: [packages/core/src/actions/staking.ts:24](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L24)
+
+#### Parameters
+
+##### args
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+***
+
+### getLockedStake()
+
+> **getLockedStake**: (`args`) => `Promise`\<`bigint`\>
+
+Defined in: [packages/core/src/actions/staking.ts:21](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L21)
+
+#### Parameters
+
+##### args
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+***
+
+### getStakeInfo()
+
+> **getStakeInfo**: (`args`) => `Promise`\<`any`\>
+
+Defined in: [packages/core/src/actions/staking.ts:19](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L19)
+
+#### Parameters
+
+##### args
+
+###### operator
+
+`Address`
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+#### Returns
+
+`Promise`\<`any`\>
+
+***
+
+### getStakingBalance()
+
+> **getStakingBalance**: (`args`) => `Promise`\<`bigint`\>
+
+Defined in: [packages/core/src/actions/staking.ts:20](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L20)
+
+#### Parameters
+
+##### args
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+***
+
+### getTotalStaked()
+
+> **getTotalStaked**: () => `Promise`\<`bigint`\>
+
+Defined in: [packages/core/src/actions/staking.ts:39](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L39)
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+***
+
+### getUserRoleLocks()
+
+> **getUserRoleLocks**: (`args`) => `Promise`\<`any`[]\>
+
+Defined in: [packages/core/src/actions/staking.ts:22](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L22)
+
+#### Parameters
+
+##### args
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<`any`[]\>
+
+***
+
+### GTOKEN()
+
+> **GTOKEN**: () => `Promise`\<`Address`\>
+
+Defined in: [packages/core/src/actions/staking.ts:52](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L52)
+
+#### Returns
+
+`Promise`\<`Address`\>
+
+***
+
+### hasRoleLock()
+
+> **hasRoleLock**: (`args`) => `Promise`\<`boolean`\>
+
+Defined in: [packages/core/src/actions/staking.ts:23](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L23)
+
+#### Parameters
+
+##### args
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### lockStake()
+
+> **lockStake**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:8](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L8)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### entryBurn
+
+`bigint`
+
+###### payer
+
+`Address`
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+###### stakeAmount
+
+`bigint`
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### owner()
+
+> **owner**: () => `Promise`\<`Address`\>
+
+Defined in: [packages/core/src/actions/staking.ts:41](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L41)
+
+#### Returns
+
+`Promise`\<`Address`\>
+
+***
+
+### previewExitFee()
+
+> **previewExitFee**: (`args`) => `Promise`\<`bigint`\>
+
+Defined in: [packages/core/src/actions/staking.ts:25](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L25)
+
+#### Parameters
+
+##### args
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+***
+
+### REGISTRY()
+
+> **REGISTRY**: () => `Promise`\<`Address`\>
+
+Defined in: [packages/core/src/actions/staking.ts:51](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L51)
+
+#### Returns
+
+`Promise`\<`Address`\>
+
+***
+
+### renounceOwnership()
+
+> **renounceOwnership**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:45](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L45)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### roleExitConfigs()
+
+> **roleExitConfigs**: (`args`) => `Promise`\<`any`\>
+
+Defined in: [packages/core/src/actions/staking.ts:35](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L35)
+
+#### Parameters
+
+##### args
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+#### Returns
+
+`Promise`\<`any`\>
+
+***
+
+### roleLocks()
+
+> **roleLocks**: (`args`) => `Promise`\<`any`\>
+
+Defined in: [packages/core/src/actions/staking.ts:34](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L34)
+
+#### Parameters
+
+##### args
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<`any`\>
+
+***
+
+### setAuthorizedSlasher()
+
+> **setAuthorizedSlasher**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:16](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L16)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### authorized
+
+`boolean`
+
+###### slasher
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### setRegistry()
+
+> **setRegistry**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:28](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L28)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### registry
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### setRoleExitFee()
+
+> **setRoleExitFee**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:29](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L29)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### feePercent
+
+`bigint`
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### setTreasury()
+
+> **setTreasury**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:30](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L30)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### treasury
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### slash()
+
+> **slash**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:14](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L14)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### amount
+
+`bigint`
+
+###### reason
+
+`string`
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### slashByDVT()
+
+> **slashByDVT**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:15](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L15)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### amount
+
+`bigint`
+
+###### reason
+
+`string`
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### stakes()
+
+> **stakes**: (`args`) => `Promise`\<`any`\>
+
+Defined in: [packages/core/src/actions/staking.ts:33](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L33)
+
+#### Parameters
+
+##### args
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<`any`\>
+
+***
+
+### topUpStake()
+
+> **topUpStake**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L9)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### payer
+
+`Address`
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+###### stakeAmount
+
+`bigint`
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### totalStaked()
+
+> **totalStaked**: () => `Promise`\<`bigint`\>
+
+Defined in: [packages/core/src/actions/staking.ts:38](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L38)
+
+#### Returns
+
+`Promise`\<`bigint`\>
+
+***
+
+### transferOwnership()
+
+> **transferOwnership**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:44](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L44)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### newOwner
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### treasury()
+
+> **treasury**: () => `Promise`\<`Address`\>
+
+Defined in: [packages/core/src/actions/staking.ts:40](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L40)
+
+#### Returns
+
+`Promise`\<`Address`\>
+
+***
+
+### unlockAndTransfer()
+
+> **unlockAndTransfer**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:11](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L11)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### unlockStake()
+
+> **unlockStake**: (`args`) => `Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:10](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L10)
+
+#### Parameters
+
+##### args
+
+###### account?
+
+[`Account`](https://viem.sh/docs/index.html) \| `Address`
+
+###### roleId
+
+[`Hex`](https://viem.sh/docs/index.html)
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hash`](https://viem.sh/docs/index.html)\>
+
+***
+
+### userActiveRoles()
+
+> **userActiveRoles**: (`args`) => `Promise`\<[`Hex`](https://viem.sh/docs/index.html)\>
+
+Defined in: [packages/core/src/actions/staking.ts:36](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L36)
+
+#### Parameters
+
+##### args
+
+###### index
+
+`bigint`
+
+###### user
+
+`Address`
+
+#### Returns
+
+`Promise`\<[`Hex`](https://viem.sh/docs/index.html)\>
+
+***
+
+### version()
+
+> **version**: () => `Promise`\<`string`\>
+
+Defined in: [packages/core/src/actions/staking.ts:48](https://github.com/AAStarCommunity/aastar-sdk/blob/f3911a6f6e88b2f77186db63ad0182c2cfe13b9d/packages/core/src/actions/staking.ts#L48)
+
+#### Returns
+
+`Promise`\<`string`\>