Class pTokensSwapBuilder

Hierarchy

pTokensSwapBuilder

Index

Constructors

Properties

_amount _destinationAssets _node _sourceAsset

Accessors

amount destinationAssets node sourceAsset

Methods

addDestinationAsset build isValidSwap setAmount setSourceAsset

Constructors

constructor

new pTokensSwapBuilder(_node: pTokensNode): pTokensSwapBuilder
Create and initialize a pTokensSwapBuilder object.
Parameters
- _node: pTokensNode
  
  A pNetworkNode necessary for pNetworkSwap.
Returns pTokensSwapBuilder
- Defined in ptokens-swap/src/ptokens-swap-builder.ts:18

Properties

`Private` _amount

_amount: BigNumber

`Private` _destinationAssets

_destinationAssets: DestinationInfo[] = []

`Private` _node

_node: pTokensNode

`Private` _sourceAsset

_sourceAsset: pTokensAsset

Accessors

amount

get amount(): string
Return the amount of source asset that will be swapped.

Returns string
- Defined in ptokens-swap/src/ptokens-swap-builder.ts:64

destinationAssets

get destinationAssets(): pTokensAsset[]
Return the pTokensAsset array set as destination assets for the swap. Actually, only one destination asset is supported by pNetwork v2.

Returns pTokensAsset[]
- Defined in ptokens-swap/src/ptokens-swap-builder.ts:43

node

get node(): pTokensNode
Return the pTokensNode set when creating the builder.

Returns pTokensNode
- Defined in ptokens-swap/src/ptokens-swap-builder.ts:81

sourceAsset

get sourceAsset(): pTokensAsset
Return the pTokensAsset set as source asset for the swap.

Returns pTokensAsset
- Defined in ptokens-swap/src/ptokens-swap-builder.ts:25

Methods

addDestinationAsset

addDestinationAsset(_asset: pTokensAsset, _destinationAddress: string, _userData?: Uint8Array): pTokensSwapBuilder
Add a destination pTokensAsset for the swap.

Returns
The same builder. This allows methods chaining.
Parameters
- _asset: pTokensAsset
  
  A pTokenAsset that will be one of the destination assets.
- _destinationAddress: string
  
  The destination address that will receive the _asset.
- _userData: Uint8Array = undefined
  
  Optional user data.
Returns pTokensSwapBuilder
- Defined in ptokens-swap/src/ptokens-swap-builder.ts:54

build

build(): pTokensSwap
Build a pTokensSwap object from the parameters set when interacting with the builder.

Returns
- An immutable pTokensSwap object.
Returns pTokensSwap
- Defined in ptokens-swap/src/ptokens-swap-builder.ts:113

`Private` isValidSwap

isValidSwap(): boolean
Returns boolean
- Defined in ptokens-swap/src/ptokens-swap-builder.ts:85

setAmount

setAmount(_amount: string | number): pTokensSwapBuilder
Set the amount of source asset that will be swapped.

Returns
The same builder. This allows methods chaining.
Parameters
- _amount: string | number
  
  The amount of source asset that will be swapped.
Returns pTokensSwapBuilder
- Defined in ptokens-swap/src/ptokens-swap-builder.ts:73

setSourceAsset

setSourceAsset(_asset: pTokensAsset): pTokensSwapBuilder
Set the source asset for the swap.

Returns
The same builder. This allows methods chaining.
Parameters
- _asset: pTokensAsset
  
  A pTokenAsset that will be the swap source asset.
Returns pTokensSwapBuilder
- Defined in ptokens-swap/src/ptokens-swap-builder.ts:34

Generated using TypeDoc