Skip to main content

quill sns stake-neuron

Reference

Signs messages needed to stake governance tokens for a neuron. First, stake-neuron will sign a ledger transfer to a subaccount of the Governance canister calculated from the provided private key and memo. Second, stake-neuron will sign a ManageNeuron message for Governance to claim the neuron for the principal derived from the provided private key.

Basic usage

The basic syntax for running quill sns stake-neuron commands is:

quill sns stake-neuron --memo <MEMO> [option]

Flags

FlagDescription
-h, --helpDisplays usage information.
--claim-onlyNo transfer will be made.

Options

OptionDescriptio
--amount <AMOUNT>The amount of tokens in e8s to be transferred to the Governance canister.
--fee <FEE>The amount that the caller pays for the transaction.
--from-subaccount <FROM_SUBACCOUNT>The subaccount to make the transfer from.
--memo <MEMO> An arbitrary number used in calculating the neuron's subaccount.

Remarks

The amount of specified tokens will be transferred to the governance canister's ledger subaccount (the neuron's account ID) from the account ID derived from the provided private key. This is known as a staking transfer. These funds will be returned when disbursing the neuron. If an amount is not specified, no transfer will be made, and only a neuron claim command will be signed. This is useful for situations where the transfer was initially made with some other command or tool.

The memo must be unique among the neurons claimed for a single principal. More information on ledger accounts and subaccounts can be found here: Ledger Canister Overview

The default fee is 0.0001 tokens. Use the --fee flag when using an SNS that sets its own transaction fee.

If --claim-only is specified, then only the neuron claim message will be generated. This is useful if there was an error previously submitting the notification which you have since rectified, or if you have made the transfer with another tool.