api.procedures.types.BondPolyxParams

Interface: BondPolyxParams

api/procedures/types.BondPolyxParams

Table of contents

Properties

• amount
• autoStake
• controller
• payee

Properties

amount

• amount: BigNumber

The amount of POLYX to bond (up to 6 decimals of precision)

Note

It is strongly recommended against bonding 100% an account's POLYX balance. At the minimum a stash account needs enough POLYX to sign the unbond extrinsic ()

Defined in

api/procedures/types.ts:1811

---

autoStake

• autoStake: boolean

Can be set to true if rewardDestination is the signing account. Auto stake will stake all rewards so the balance will compound

Defined in

api/procedures/types.ts:1803

---

controller

• controller: string | Account

The controller is the account responsible for managing staked POLYX. This can be the stash, but designating a different key can make it easier to update nomination preferences and maintain the POLYX in a more secure, but inconvenient, stash key.

Defined in

api/procedures/types.ts:1793

---

payee

• payee: string | Account

The account that should receive the stashing rewards

Defined in

api/procedures/types.ts:1798