Replace¶
Calls¶
accept_replace¶
Accept request of vault replacement
# Arguments
origin- the initiator of the transaction: the new vaultold_vault- id of the old vault that we are (possibly partially) replacingcollateral- the collateral for replacementbtc_address- the address that old-vault should transfer the btc to
Attributes¶
| Name | Type |
|---|---|
| currency_pair | DefaultVaultCurrencyPair<T> |
| old_vault | DefaultVaultId<T> |
| amount_btc | BalanceOf<T> |
| collateral | BalanceOf<T> |
| btc_address | BtcAddress |
Python¶
call = substrate.compose_call(
'Replace', 'accept_replace', {
'amount_btc': 'u128',
'btc_address': {
'P2PKH': '[u8; 20]',
'P2SH': '[u8; 20]',
'P2WPKHv0': '[u8; 20]',
'P2WSHv0': 'scale_info::12',
},
'collateral': 'u128',
'currency_pair': {
'collateral': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': (
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
),
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
'wrapped': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': (
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
),
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
},
'old_vault': {
'account_id': 'AccountId',
'currencies': {
'collateral': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': (
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
),
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
'wrapped': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': (
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
),
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
},
},
}
)
cancel_replace¶
Cancel vault replacement
# Arguments
origin- sender of the transaction: anyonereplace_id- the ID of the replacement request
Attributes¶
| Name | Type |
|---|---|
| replace_id | H256 |
Python¶
call = substrate.compose_call(
'Replace', 'cancel_replace', {'replace_id': 'scale_info::12'}
)
execute_replace¶
Execute vault replacement
# Arguments
origin- sender of the transaction: the new vaultreplace_id- the ID of the replacement request- 'merkle_proof' - the merkle root of the block
raw_tx- the transaction id in bytes
Attributes¶
| Name | Type |
|---|---|
| replace_id | H256 |
| unchecked_transaction | FullTransactionProof |
Python¶
call = substrate.compose_call(
'Replace', 'execute_replace', {
'replace_id': 'scale_info::12',
'unchecked_transaction': {
'coinbase_proof': {
'merkle_proof': {
'block_header': {
'hash': {
'content': '[u8; 32]',
},
'hash_prev_block': {
'content': '[u8; 32]',
},
'merkle_root': {
'content': '[u8; 32]',
},
'nonce': 'u32',
'target': 'scale_info::187',
'timestamp': 'u32',
'version': 'i32',
},
'flag_bits': ['bool'],
'hashes': [
{
'content': '[u8; 32]',
},
],
'transactions_count': 'u32',
},
'transaction': {
'inputs': [
{
'script': 'Bytes',
'sequence': 'u32',
'source': {
'Coinbase': (
None,
'u32',
),
'FromOutput': (
'scale_info::95',
'u32',
),
},
'witness': [
'Bytes',
],
},
],
'lock_at': {
'BlockHeight': 'u32',
'Time': 'u32',
},
'outputs': [
{
'script': {
'bytes': 'Bytes',
},
'value': 'i64',
},
],
'version': 'i32',
},
'tx_encoded_len': 'u32',
},
'user_tx_proof': {
'merkle_proof': {
'block_header': {
'hash': {
'content': '[u8; 32]',
},
'hash_prev_block': {
'content': '[u8; 32]',
},
'merkle_root': {
'content': '[u8; 32]',
},
'nonce': 'u32',
'target': 'scale_info::187',
'timestamp': 'u32',
'version': 'i32',
},
'flag_bits': ['bool'],
'hashes': [
{
'content': '[u8; 32]',
},
],
'transactions_count': 'u32',
},
'transaction': {
'inputs': [
{
'script': 'Bytes',
'sequence': 'u32',
'source': {
'Coinbase': (
None,
'u32',
),
'FromOutput': (
'scale_info::95',
'u32',
),
},
'witness': [
'Bytes',
],
},
],
'lock_at': {
'BlockHeight': 'u32',
'Time': 'u32',
},
'outputs': [
{
'script': {
'bytes': 'Bytes',
},
'value': 'i64',
},
],
'version': 'i32',
},
'tx_encoded_len': 'u32',
},
},
}
)
request_replace¶
Request the replacement of a new vault ownership
# Arguments
origin- sender of the transactionamount- amount of issued tokensgriefing_collateral- amount of collateral
Attributes¶
| Name | Type |
|---|---|
| currency_pair | DefaultVaultCurrencyPair<T> |
| amount | BalanceOf<T> |
Python¶
call = substrate.compose_call(
'Replace', 'request_replace', {
'amount': 'u128',
'currency_pair': {
'collateral': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': (
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
),
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
'wrapped': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': (
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
),
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
},
}
)
set_replace_period¶
Set the default replace period for tx verification.
# Arguments
origin- the dispatch origin of this call (must be Root)period- default period for new requests
# Weight: O(1)
Attributes¶
| Name | Type |
|---|---|
| period | T::BlockNumber |
Python¶
call = substrate.compose_call(
'Replace', 'set_replace_period', {'period': 'u32'}
)
withdraw_replace¶
Withdraw a request of vault replacement
# Arguments
origin- sender of the transaction: the old vault
Attributes¶
| Name | Type |
|---|---|
| currency_pair | DefaultVaultCurrencyPair<T> |
| amount | BalanceOf<T> |
Python¶
call = substrate.compose_call(
'Replace', 'withdraw_replace', {
'amount': 'u128',
'currency_pair': {
'collateral': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': (
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
),
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
'wrapped': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': (
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
{
'ForeignAsset': 'u32',
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
),
'StableLpToken': 'u32',
'Token': (
'DOT',
'IBTC',
'INTR',
'KSM',
'KBTC',
'KINT',
),
},
},
}
)
Events¶
AcceptReplace¶
Attributes¶
| Name | Type | Composition |
|---|---|---|
| replace_id | H256 |
scale_info::12 |
| old_vault_id | DefaultVaultId<T> |
{'account_id': 'AccountId', 'currencies': {'collateral': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}, 'wrapped': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}}} |
| new_vault_id | DefaultVaultId<T> |
{'account_id': 'AccountId', 'currencies': {'collateral': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}, 'wrapped': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}}} |
| amount | BalanceOf<T> |
u128 |
| collateral | BalanceOf<T> |
u128 |
| btc_address | BtcAddress |
{'P2PKH': '[u8; 20]', 'P2SH': '[u8; 20]', 'P2WPKHv0': '[u8; 20]', 'P2WSHv0': 'scale_info::12'} |
CancelReplace¶
Attributes¶
| Name | Type | Composition |
|---|---|---|
| replace_id | H256 |
scale_info::12 |
| new_vault_id | DefaultVaultId<T> |
{'account_id': 'AccountId', 'currencies': {'collateral': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}, 'wrapped': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}}} |
| old_vault_id | DefaultVaultId<T> |
{'account_id': 'AccountId', 'currencies': {'collateral': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}, 'wrapped': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}}} |
| griefing_collateral | BalanceOf<T> |
u128 |
ExecuteReplace¶
Attributes¶
| Name | Type | Composition |
|---|---|---|
| replace_id | H256 |
scale_info::12 |
| old_vault_id | DefaultVaultId<T> |
{'account_id': 'AccountId', 'currencies': {'collateral': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}, 'wrapped': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}}} |
| new_vault_id | DefaultVaultId<T> |
{'account_id': 'AccountId', 'currencies': {'collateral': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}, 'wrapped': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}}} |
ReplacePeriodChange¶
Attributes¶
| Name | Type | Composition |
|---|---|---|
| period | T::BlockNumber |
u32 |
RequestReplace¶
Attributes¶
| Name | Type | Composition |
|---|---|---|
| old_vault_id | DefaultVaultId<T> |
{'account_id': 'AccountId', 'currencies': {'collateral': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}, 'wrapped': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}}} |
| amount | BalanceOf<T> |
u128 |
| griefing_collateral | BalanceOf<T> |
u128 |
WithdrawReplace¶
Attributes¶
| Name | Type | Composition |
|---|---|---|
| old_vault_id | DefaultVaultId<T> |
{'account_id': 'AccountId', 'currencies': {'collateral': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}, 'wrapped': {'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'), 'ForeignAsset': 'u32', 'LendToken': 'u32', 'LpToken': ({'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}, {'Token': 'scale_info::52', 'ForeignAsset': 'u32', 'StableLpToken': 'u32'}), 'StableLpToken': 'u32'}}} |
| withdrawn_tokens | BalanceOf<T> |
u128 |
| withdrawn_griefing_collateral | BalanceOf<T> |
u128 |
Storage functions¶
ReplaceBtcDustValue¶
The minimum amount of btc that is accepted for replace requests; any lower values would risk the bitcoin client to reject the payment
Python¶
result = substrate.query(
'Replace', 'ReplaceBtcDustValue', []
)
Return value¶
'u128'
ReplacePeriod¶
The time difference in number of blocks between when a replace request is created and required completion time by a vault. The replace period has an upper limit to prevent griefing of vault collateral.
Python¶
result = substrate.query(
'Replace', 'ReplacePeriod', []
)
Return value¶
'u32'
ReplaceRequests¶
Vaults create replace requests to transfer locked collateral.
This mapping provides access from a unique hash to a ReplaceRequest.
Python¶
result = substrate.query(
'Replace', 'ReplaceRequests', ['scale_info::12']
)
Return value¶
{
'accept_time': 'u32',
'amount': 'u128',
'btc_address': {
'P2PKH': '[u8; 20]',
'P2SH': '[u8; 20]',
'P2WPKHv0': '[u8; 20]',
'P2WSHv0': 'scale_info::12',
},
'btc_height': 'u32',
'collateral': 'u128',
'griefing_collateral': 'u128',
'new_vault': {
'account_id': 'AccountId',
'currencies': {
'collateral': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': ('scale_info::53', 'scale_info::53'),
'StableLpToken': 'u32',
'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'),
},
'wrapped': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': ('scale_info::53', 'scale_info::53'),
'StableLpToken': 'u32',
'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'),
},
},
},
'old_vault': {
'account_id': 'AccountId',
'currencies': {
'collateral': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': ('scale_info::53', 'scale_info::53'),
'StableLpToken': 'u32',
'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'),
},
'wrapped': {
'ForeignAsset': 'u32',
'LendToken': 'u32',
'LpToken': ('scale_info::53', 'scale_info::53'),
'StableLpToken': 'u32',
'Token': ('DOT', 'IBTC', 'INTR', 'KSM', 'KBTC', 'KINT'),
},
},
},
'period': 'u32',
'status': ('Pending', 'Completed', 'Cancelled'),
}
StorageVersion¶
Build storage at V1 (requires default 0).
Python¶
result = substrate.query(
'Replace', 'StorageVersion', []
)
Return value¶
('V0', )
Errors¶
AmountBelowDustAmount¶
Replace amount is too small.
InvalidWrappedCurrency¶
Vault cannot replace different currency.
NoPendingRequest¶
No replace request found.
ReplaceAmountZero¶
Replace requires non-zero increase.
ReplaceCancelled¶
Replace request already cancelled.
ReplaceCompleted¶
Replace request already completed.
ReplaceIdNotFound¶
Replace request not found.
ReplacePeriodNotExpired¶
Replace request has not expired.
ReplaceSelfNotAllowed¶
Cannot replace self.
UnauthorizedVault¶
Unexpected vault account.
VaultHasEnabledNomination¶
Cannot replace with nominated collateral.