Deploying a token
Token deployment follows the same threshold signing process as any other movement. The owning vault's M-of-N requirement applies.
Required role: Owner, or a role with the Manage Workspace permission.
Required permissions: MANAGE_WORKSPACE
Prerequisites: The deploying vault must exist and its signers must have registered their keys.
#Step 1: Configure token parameters
- Navigate to the Vaults page.
- Select the vault that will own the token.
- Select the option to create a new token. The Create Token dialog opens.
- Enter the Token Name. This is the display name for the token.
- Enter the Symbol (Ticker). This is a short identifier, for example "ACME".
- Enter a Description. This is required.
- Enter the Icon URL. Provide a link to the token's icon, up to 256 characters.
- Set the Decimals. This is the number of decimal places, from 0 to 18, and determines the smallest unit of the token.
- Enter the Initial supply. This is the number of tokens to create at deployment.
- Enter the Max supply. This is the upper bound on tokens that can ever exist.
- Review your parameters and confirm.
The token is deployed on the network of the current workspace. Every token enforces whitelisting: only addresses on the token's whitelist can hold or receive it. See Token whitelist settings.
What happens next: SQRL creates the deployment transaction and presents it to the vault's signers.
#Step 2: The signing process
Each signer on the vault receives a notification that a deployment requires their signature.
- Open the pending deployment.
- Review the token parameters and deployment details.
- Using your external wallet software or hardware device, sign the transaction data provided by SQRL.
- Submit the signed result back to SQRL.
Repeat for each required signer until the vault's threshold is met.
When the required number of signatures is reached, the deployment is finalised and broadcast automatically. There is no additional confirmation step.
Once the deployment transaction has been broadcast, it cannot be reversed.
#Step 3: Tracking deployment status
A deployment moves through the following statuses.
| Status | Meaning | Action |
|---|---|---|
| Pending | Waiting for signatures | Continue collecting signatures |
| Broadcasting | Signed and broadcast to the Bitcoin network | Wait for confirmation |
| Confirmed | Deployed and confirmed on-chain | Done. The token is live. |
| Failed | Broadcast or confirmation failed | Review the error and retry if appropriate |
You can monitor deployment status on the Vaults page by viewing the token's details.
#If deployment fails
A failed deployment means the transaction did not confirm on the Bitcoin network. This can happen because of network conditions or transaction construction errors. Review the error details provided by SQRL. If the issue is transient, resubmit the deployment. Contact your administrator if the failure persists.