Propose a new asset
This page provides a tutorial for submitting a proposal for a new ERC-20 asset to be used as collateral. It describes what can be proposed, what you need to propose a new asset, and provides proposal templates that you will need to edit before submitting.
Requirementsβ
You will need:
- A connected Vega wallet, with your wallet name and public key to hand
- A minimum of whichever is larger, associated with that public key: πgovernance.proposal.asset.minProposerBalance (π20000 tokens) or πspam.protection.proposal.min.tokens (π2000 tokens)
- Familiarity with governance on Vega, particularly assets at a protocol level
You should also share your proposal idea in the Asset Proposals forum β before submitting it to the network.
After a new asset vote passes, the change has to be submitted to the asset bridge on Ethereum. Until it has been submitted, no one can start depositing that asset. See the tutorial for how to do that.
Overviewβ
Vega currently supports adding ERC-20 assets β. ERC-20 assets that pass a governance vote can be enabled via the Vega bridge - which is to say that they are deposited from and withdrawn to Ethereum. More token standards and chains are on the roadmap.
You can see all of the currently supported assets using the REST endpoint.
If an asset that you would like to see on the network is not already available, a governance proposal can be made to list the asset.
If the vote passes, the network validators will then enable the asset on the bridge contract which will enable deposits and withdrawals for that token.
Anatomy of a new asset proposalβ
The key inputs on a new asset proposal are as follows.
The contents of a changes
object specifies what will be different after the proposal. In this case, these are the changes that will occur on the network, in the form of a new market.
Rationale requires a title and a description. They are free-text fields that describe the purpose of the proposal. Within the description, include links with more information about your proposal (such as to the IPFS content or forum post) that voters can reference to learn more about the asset proposal. Formatting your rationale with markdown makes it easier to read when it's displayed.
Field | Description | Example |
---|---|---|
name | Name of the asset (string) | Testnet DAI |
symbol | Symbol of the asset (string) | tDAI |
decimals | Number of decimal / precision handled by this asset (string) | 18 |
quantum | The minimum economically meaningful amount of the asset (string). This should be the amount of the asset roughly equal to 1 USD. It is used in a number of ways by the protocol but only requires precision to an order of magnitude level. For example, if one BTC = 26,583 USD, then in this case a quantum of 1 / 25,000 or 0.00004 is sufficient. Converted to asset decimals it would be 40000000000000. | 1000000000000000000 |
withdrawThreshold | The maximum you can withdraw instantly. All withdrawals over the threshold will be delayed by the withdrawal delay, which can be seen on the ERC-20 bridge per asset. Setting this to 1 means all withdrawals will be subject to the delay. It's measured in asset decimals, so 1 is the smallest increment of the market's asset. | 1 |
lifetimeLimit | The lifetime deposit limit per public key, in asset decimals. Users are able to opt out of this functionality using the exempt_depositor write function on the ERC20 contract if they wish to. Suggested value: equivalent of 10,000 USD | 10000000000000000000000 |
ERC-20 asset validationβ
When adding an ERC-20 asset to the bridge, the key details are compared to the smart contract on Ethereum. Specifically:
- The name and symbol must match
- The contract must be an ERC-20 asset
- There cannot be multiple assets on a Vega network for the same ERC-20 asset
Validation happens according to the validationTimestamp
parameter. The validation timestamp must be within the range between 1 second and 2 days from the time of submission. In most situations, this should be early on in the voting period so that any validation errors are caught before token holders start voting. However you could push the validation later in that range if the contract is not yet deployed.
Templates and submittingβ
In the tabs below you'll see:
- Annotated example describing what each field is for
- JSON example that can be shared with the community and then submitted with the governance dApp β
- Command line examples for different operating systems
Replace the example data with the relevant details before submitting.
- Annotated example
- Governance dApp (JSON)
- Command line (Linux / OSX)
- Command line (Windows)
{
rationale: {
title: "Add tDAI TEST (tDAI)",
description: "Proposal to add tDAI TEST (tDAI) as an asset"
},
terms: {
newAsset: {
changes: {
// Name of the asset (e.g: Great British Pound). (string)
name: "tDAI TEST",
// Symbol of the asset (e.g: GBP). (string)
symbol: "tDAI",
// Number of decimal / precision handled by this asset. (string)
decimals: "18",
// Minimum economically meaningful amount in the asset. (string)
quantum: "1",
// ERC20 token based asset, living on the ethereum network
erc20: {
// Address of the contract for the token, on the ethereum network. (string)
contractAddress: "0x26223f9C67871CFcEa329975f7BC0C9cB8FBDb9b",
// Maximum you can withdraw instantly. All withdrawals over the threshold will be delayed by the withdrawal delay.
// Thereβs no limit on the size of a withdrawal (string)
withdrawThreshold: "10",
// Lifetime limits deposit per address
// note: this is a temporary measure that can be changed by governance. (string)
lifetimeLimit: "10",
}
}
},
// Timestamp as Unix time in seconds when voting closes for this proposal,
// constrained by `minClose` and `maxClose` network parameters. (int64 as string)
closingTimestamp: 1700416773,
// Timestamp as Unix time in seconds when proposal gets enacted if passed,
// constrained by `minEnact` and `maxEnact` network parameters. (int64 as string)
enactmentTimestamp: 1700503173,
// Validation timestamp as Unix time in seconds. (int64 as string)
validationTimestamp: 1700503173
}
}
- Copy the JSON example below into a text editor.
- Replace the placeholder values with those you want for the market.
- Tip: Use markdown formatting in your proposal's rationale to make for easier community review.
- Submit your proposal on the governance dApp β.
- Check you can see your proposal under Open Proposals on the governance dApp β.
{
"rationale": {
"title": "Add tDAI TEST (tDAI)",
"description": "Proposal to add tDAI TEST (tDAI) as an asset"
},
"terms": {
"newAsset": {
"changes": {
"name": "tDAI TEST",
"symbol": "tDAI",
"decimals": "18",
"quantum": "1",
"erc20": {
"contractAddress": "0x26223f9C67871CFcEa329975f7BC0C9cB8FBDb9b",
"withdrawThreshold": "10",
"lifetimeLimit": "10"
}
}
},
"closingTimestamp": 1700416773,
"enactmentTimestamp": 1700503173,
"validationTimestamp": 1700503173
}
}
- Copy the command line example below into a text editor.
- Replace the placeholder values with those you want in the proposal.
- Tip: Use markdown formatting in your proposal's rationale to make for easier community review.
- Connect to your Vega wallet and use the command line to submit your proposal.
- Check you can see your proposal under Open Proposals on the governance dApp β.
./vegawallet transaction send --wallet YOUR_WALLETNAME --pubkey YOUR_PUBLIC_KEY --network NETWORK_NAME '{
"proposalSubmission": {
"rationale": {
"title": "Add tDAI TEST (tDAI)",
"description": "Proposal to add tDAI TEST (tDAI) as an asset"
},
"terms": {
"newAsset": {
"changes": {
"name": "tDAI TEST",
"symbol": "tDAI",
"decimals": "18",
"quantum": "1",
"erc20": {
"contractAddress": "0x26223f9C67871CFcEa329975f7BC0C9cB8FBDb9b",
"withdrawThreshold": "10",
"lifetimeLimit": "10"
}
}
},
"closingTimestamp": 1700416773,
"enactmentTimestamp": 1700503173,
"validationTimestamp": 1700503173
}
}
}'
- Copy the command line example below into a text editor.
- Replace the placeholder values with those you want in the proposal.
- Tip: Use markdown formatting in your proposal's rationale to make for easier community review.
- Connect to your Vega wallet and use the command line to submit your proposal.
- Check you can see your proposal under Open Proposals on the governance dApp β.
vegawallet.exe transaction send --wallet YOUR_WALLETNAME --pubkey YOUR_PUBLIC_KEY --network NETWORK_NAME ^
"{^
\"proposalSubmission\": {^
\"rationale\": {^
\"title\": \"Add tDAI TEST (tDAI)\",^
\"description\": \"Proposal to add tDAI TEST (tDAI) as an asset\"^
},^
\"terms\": {^
\"newAsset\": {^
\"changes\": {^
\"name\": \"tDAI TEST\",^
\"symbol\": \"tDAI\",^
\"decimals\": \"18\",^
\"quantum\": \"1\",^
\"erc20\": {^
\"contractAddress\": \"0x26223f9C67871CFcEa329975f7BC0C9cB8FBDb9b\",^
\"withdrawThreshold\": \"10\",^
\"lifetimeLimit\": \"10\"^
}^
}^
},^
\"closingTimestamp\": 1700416773,^
\"enactmentTimestamp\": 1700503173,^
\"validationTimestamp\": 1700503173^
}^
}^
}"
Votingβ
All proposals are voted on by the community.
Building support is down to you. Share your proposal in the Asset Proposals section β on the community forum. You may also wish to share on Discord β.
To vote, community members need, at a minimum, the larger of π1000000000000000000 tokens or π1 token associated with their Vega key.
Your proposal will need participation of π9% and a majority of π66%, so having community support is essential.
Proposers who invite feedback, engage with comments, and make revisions to meet the needs of the community are more likely to be successful.
Enactmentβ
If successful, the proposal will be enacted at the time you specify in the enactmentTimestamp
field.