src/path_call_builder.js

  1. import {CallBuilder} from './call_builder';
  3. /**
  4.  * The DigitalBits Network allows payments to be made across assets through path payments. A path payment specifies a
  5.  * series of assets to route a payment through, from source asset (the asset debited from the payer) to destination
  6.  * asset (the asset credited to the payee).
  7.  *
  8.  * A path search is specified using:
  9.  *
  10.  * * The destination address
  11.  * * The source address
  12.  * * The asset and amount that the destination account should receive
  13.  *
  14.  * As part of the search, frontier will load a list of assets available to the source address and will find any
  15.  * payment paths from those source assets to the desired destination asset. The search's amount parameter will be
  16.  * used to determine if there a given path can satisfy a payment of the desired amount.
  17.  *
  18.  * Do not create this object directly, use {@link Server#paths}.
  19.  * @see [Find Payment Paths](https://developer.digitalbits.io/frontier/reference/path-finding.html)
  20.  * @param {string} serverUrl Frontier server URL.
  21.  * @param {string} source The sender's account ID. Any returned path must use a source that the sender can hold.
  22.  * @param {string} destination The destination account ID that any returned path should use.
  23.  * @param {Asset} destinationAsset The destination asset.
  24.  * @param {string} destinationAmount The amount, denominated in the destination asset, that any returned path should be able to satisfy.
  25.  */
  26. export class PathCallBuilder extends CallBuilder {
  27.     constructor(serverUrl, source, destination, destinationAsset, destinationAmount) {
  28.         super(serverUrl);
  29.         this.url.segment('paths');
  30.         this.url.addQuery('destination_account', destination);
  31.         this.url.addQuery('source_account', source);
  32.         this.url.addQuery('destination_amount', destinationAmount);
  34.         if (!destinationAsset.isNative()) {
  35.             this.url.addQuery('destination_asset_type', destinationAsset.getAssetType());
  36.             this.url.addQuery('destination_asset_code', destinationAsset.getCode());
  37.             this.url.addQuery('destination_asset_issuer', destinationAsset.getIssuer());
  38.         } else {
  39.             this.url.addQuery('destination_asset_type', 'native');
  40.         }
  41.     }
  42. }