Skip to content

Commit

Permalink
deploy: bdd0d26
Browse files Browse the repository at this point in the history
  • Loading branch information
@iohk-bors
iohk-bors[bot] committed Apr 30, 2021
1 parent 4258368 commit c0756bd
Showing 1 changed file with 111 additions and 27 deletions.
138 changes: 111 additions & 27 deletions api/edge/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2097,18 +2097,58 @@ components:
fingerprint: *assetFingerprint
metadata: *assetMetadata

ApiWalletMigrationBalance: &ApiWalletMigrationBalance
type: object
required:
- ada
- assets
properties:
ada: *amount
assets: *walletAssets

ApiWalletMigrationInfo: &ApiWalletMigrationInfo
type: object
required:
- migration_cost
- leftovers
- selections
- total_fee
- balance_leftover
- balance_selected
properties:
migration_cost:
<<: *amount
description: Total amount which will be paid as fees for the migration.
leftovers:
selections:
type: array
items: *ApiCoinSelection
description: |
The complete set of selections required for a migration.
Each selection is the basis for a single transaction.
The ordering of selections within the list is not significant.
After conversion into transactions, the transactions can be
broadcast to the network in any order to perform the migration.
total_fee:
<<: *amount
description: Leftovers dust coins which won't be migrated nor spent as fees.
description: |
The total amount to be paid in fees for a migration.
This is the total sum of the fees of the individual selections.
balance_leftover:
<<: *ApiWalletMigrationBalance
description: |
The total balance of assets that **cannot** be migrated.
The **ada** component of this balance is the total sum of all dust
ada entries in the UTxO set. An ada entry is considered to be dust
if its value is not large enough to pay for the marginal cost of
including it in a transaction.
The **assets** component of this balance is the total sum of all
non-ada assets that cannot currently be migrated. Tokens of a
non-ada asset cannot be migrated if there is insufficient ada
available to pay for their inclusion in a transaction.
balance_selected:
<<: *ApiWalletMigrationBalance
description: |
The total balance of assets that **can** be migrated.
ApiWalletPassphrase: &ApiWalletPassphrase
type: object
Expand Down Expand Up @@ -4533,16 +4573,24 @@ paths:
<strong>⚠️IMPORTANT⚠️</strong> This endpoint has been temporarily disabled with the introduction of multi-assets UTxO. It will be enabled again soon.
<hr/>
Migrate the UTxO balance of this wallet to the given set of addresses.
Submit one or more transactions which transfers all funds from a Shelley
wallet to a set of addresses.
This operation will attempt to transfer as much of the wallet's balance
as possible to the given set of addresses, by creating and submitting
as many transactions as may be necessary to migrate the entire balance.
This operation attempts to preserve the UTxO "shape" of a wallet as far as possible.
That is, coins will not be agglomerated. Therefore, if the wallet has
a large UTxO set, several transactions may be needed.
In order to minimize the total transaction fee required, UTxO entries
are coalesced together to the greatest extent possible in the resulting
transactions. No attempt is made to preserve the wallet's UTxO
distribution.
A typical usage would be when one wants to move all funds from an old wallet to another
by providing addresses coming from the new wallet.
This operation is performed on a best-effort basis. If there is
insufficient ada available to pay for the entire UTxO set to be
migrated, then only a subset of the wallet's UTxO set will be migrated.
A typical use of this operation would be to move all funds from an old
wallet to a new wallet, by providing addresses that belong to the new
wallet.
parameters:
- <<: *parametersWalletId
name: walletId
Expand All @@ -4562,9 +4610,23 @@ paths:
<strong>⚠️IMPORTANT⚠️</strong> This endpoint has been temporarily disabled with the introduction of multi-assets UTxO. It will be enabled again soon.
<hr/>
Calculate the exact cost of sending all funds from particular Shelley wallet
to a set of addresses.
Generate a plan for migrating the UTxO balance of this wallet to
another wallet, without executing the plan.
This operation generates a plan that transfers as much of the wallet's
balance as possible, by creating as many selections as may be necessary
to migrate the entire balance. Each selection created is the basis for
a transaction.
In order to minimize the total transaction fee required, UTxO entries
are coalesced together to the greatest extent possible in the resulting
selections. No attempt is made to preserve the wallet's UTxO
distribution.
The plan is generated on a best-effort basis. If there is insufficient
ada available to pay for the entire UTxO set to be migrated, then only
a subset of the wallet's UTxO set will be included in the resultant
plan.
parameters:
- <<: *parametersWalletId
name: walletId
Expand Down Expand Up @@ -4915,16 +4977,24 @@ paths:
<strong>⚠️IMPORTANT⚠️</strong> This endpoint has been temporarily disabled with the introduction of multi-assets UTxO. It will be enabled again soon.
<hr/>
Migrate the UTxO balance of this wallet to the given set of addresses.
Submit one or more transactions which transfers all funds from a Byron
wallet to a set of addresses.
This operation will attempt to transfer as much of the wallet's balance
as possible to the given set of addresses, by creating and submitting
as many transactions as may be necessary to migrate the entire balance.
This operation attempts to preserve the UTxO "shape" of a wallet as far as possible.
That is, coins will not be agglomerated. Therefore, if the wallet has
a large UTxO set, several transactions may be needed.
In order to minimize the total transaction fee required, UTxO entries
are coalesced together to the greatest extent possible in the resulting
transactions. No attempt is made to preserve the wallet's UTxO
distribution.
A typical usage would be when one wants to move all funds from an old wallet to another (Shelley
or Byron) by providing addresses coming from the new wallet.
This operation is performed on a best-effort basis. If there is
insufficient ada available to pay for the entire UTxO set to be
migrated, then only a subset of the wallet's UTxO set will be migrated.
A typical use of this operation would be to move all funds from an old
wallet to a new wallet, by providing addresses that belong to the new
wallet.
parameters:
- <<: *parametersWalletId
name: walletId
Expand All @@ -4944,9 +5014,23 @@ paths:
<strong>⚠️IMPORTANT⚠️</strong> This endpoint has been temporarily disabled with the introduction of multi-assets UTxO. It will be enabled again soon.
<hr/>
Calculate the exact cost of sending all funds from particular Byron wallet to
a set of addresses.
Generate a plan for migrating the UTxO balance of this wallet to
another wallet, without executing the plan.
This operation generates a plan that transfers as much of the wallet's
balance as possible, by creating as many selections as may be necessary
to migrate the entire balance. Each selection created is the basis for
a transaction.
In order to minimize the total transaction fee required, UTxO entries
are coalesced together to the greatest extent possible in the resulting
selections. No attempt is made to preserve the wallet's UTxO
distribution.
The plan is generated on a best-effort basis. If there is insufficient
ada available to pay for the entire UTxO set to be migrated, then only
a subset of the wallet's UTxO set will be included in the resultant
plan.
parameters:
- <<: *parametersWalletId
name: walletId
Expand Down

0 comments on commit c0756bd

Please sign in to comment.