Class pTokensAssetBuilder`Abstract`

Hierarchy

pTokensAssetBuilder

Index

Constructors

Properties

_assetInfo _blockchain _chainId _decimals _network _node _symbol _type _weight

Methods

_build build setBlockchain setDecimals setProvider setSymbol setWeight validate

Constructors

constructor

new pTokensAssetBuilder(_node: pTokensNode, _type: BlockchainType): pTokensAssetBuilder
Create and initialize a pTokensAssetBuilder object.
Parameters
- _node: pTokensNode
  
  A pNetworkNode necessary for pNetworkSwap.
- _type: BlockchainType
  
  A type indicating the builder nature and used for validation.
Returns pTokensAssetBuilder
- Defined in ptokens-entities/src/ptokens-asset-builder.ts:23

Properties

`Protected` _assetInfo

_assetInfo: AssetInfo

`Protected` _blockchain

_blockchain: Blockchain

`Protected` _chainId

_chainId: ChainId

`Protected` _decimals

_decimals: number

`Protected` _network

_network: Network

`Protected` _node

_node: pTokensNode

`Protected` _symbol

_symbol: string

`Private` _type

_type: BlockchainType

`Protected` _weight

_weight: number

Methods

`Protected` _build

_build(): Promise<pTokensAsset>
Returns Promise<pTokensAsset>
- Defined in ptokens-entities/src/ptokens-asset-builder.ts:72

build

build(): Promise<pTokensAsset>
Build a pTokensAsset object from the parameters specified to the builder.

Returns
A Promise that resolves with the created pTokensAsset object.

Returns Promise<pTokensAsset>
- Defined in ptokens-entities/src/ptokens-asset-builder.ts:89

setBlockchain

setBlockchain(_chainId: ChainId): pTokensAssetBuilder
Set the blockchain chain ID for the token.

Returns
The same builder. This allows methods chaining.
Parameters
- _chainId: ChainId
  
  The chain ID.
Returns pTokensAssetBuilder
- Defined in ptokens-entities/src/ptokens-asset-builder.ts:53

setDecimals

setDecimals(_decimals: number): pTokensAssetBuilder
Set the number of decimals for the token.

Returns
The same builder. This allows methods chaining.
Parameters
- _decimals: number
  
  The number of decimals.
Returns pTokensAssetBuilder
- Defined in ptokens-entities/src/ptokens-asset-builder.ts:64

`Abstract` setProvider

setProvider(_provider: pTokensAssetProvider): pTokensAssetBuilder
Parameters
- _provider: pTokensAssetProvider
Returns pTokensAssetBuilder
- Defined in ptokens-entities/src/ptokens-asset-builder.ts:69

setSymbol

setSymbol(_symbol: string): pTokensAssetBuilder
Set the pTokensAsset symbol.

Returns
The same builder. This allows methods chaining.
Parameters
- _symbol: string
  
  The token symbol.
Returns pTokensAssetBuilder
- Defined in ptokens-entities/src/ptokens-asset-builder.ts:33

setWeight

setWeight(_weight: number): pTokensAssetBuilder
Set a weight for the asset during the swap. Its usage is currently not supported.

Returns
The same builder. This allows methods chaining.
Parameters
- _weight: number
  
  A weight for the token.
Returns pTokensAssetBuilder
- Defined in ptokens-entities/src/ptokens-asset-builder.ts:43

`Private` validate

validate(): Promise<void>
Returns Promise<void>
- Defined in ptokens-entities/src/ptokens-asset-builder.ts:76

Generated using TypeDoc