Class pTokensAsset`Abstract`

Hierarchy

pTokensAsset

Index

Constructors

Properties

_assetInfo _node _symbol _type _weight

Accessors

assetInfo blockchain chainId identity network node provider symbol tokenAddress vaultAddress weight

Methods

hostToInterim nativeToInterim

Constructors

constructor

new pTokensAsset(_config: pTokenAssetConfig, _type: BlockchainType): pTokensAsset
Create and initialize a pTokensAsset object. pTokensAsset objects shall be created with a pTokensAssetBuilder instance.
Parameters
- _config: pTokenAssetConfig
- _type: BlockchainType
Returns pTokensAsset
- Defined in ptokens-entities/src/ptokens-asset.ts:30

Properties

`Private` _assetInfo

_assetInfo: AssetInfo

`Private` _node

_node: pTokensNode

`Private` _symbol

_symbol: string

`Private` _type

_type: BlockchainType

`Private` _weight

_weight: number

Accessors

assetInfo

get assetInfo(): AssetInfo
Return technical details related to the token.

Returns AssetInfo
- Defined in ptokens-entities/src/ptokens-asset.ts:87

blockchain

get blockchain(): Blockchain
Return the blockchain of the token.

Returns Blockchain
- Defined in ptokens-entities/src/ptokens-asset.ts:57

chainId

get chainId(): ChainId
Return the chain ID of the token.

Returns ChainId
- Defined in ptokens-entities/src/ptokens-asset.ts:52

identity

get identity(): string
Return the pNetwork enclave address for the token.

Returns string
- Defined in ptokens-entities/src/ptokens-asset.ts:77

network

get network(): Network
Return the blockchain's network of the token.

Returns Network
- Defined in ptokens-entities/src/ptokens-asset.ts:62

node

get node(): pTokensNode
Returns pTokensNode
- Defined in ptokens-entities/src/ptokens-asset.ts:42

`Abstract` provider

get provider(): pTokensAssetProvider
Return the pTokensAssetProvider eventually assigned

Returns pTokensAssetProvider
- Defined in ptokens-entities/src/ptokens-asset.ts:92

symbol

get symbol(): string
Return the token's symbol.

Returns string
- Defined in ptokens-entities/src/ptokens-asset.ts:47

tokenAddress

get tokenAddress(): string
Return token smart contract address.

Returns string
- Defined in ptokens-entities/src/ptokens-asset.ts:72

vaultAddress

get vaultAddress(): string
Return the vault address for the token.

Returns string
- Defined in ptokens-entities/src/ptokens-asset.ts:67

weight

get weight(): number
Return the weight associated to the token during the swap. Its usage is currently not supported.

Returns number
- Defined in ptokens-entities/src/ptokens-asset.ts:82

Methods

`Protected` `Abstract` hostToInterim

hostToInterim(_amount: BigNumber, _destinationAddress: string, _destinationChainId: string, _userData?: Uint8Array): default<string>
Parameters
- _amount: BigNumber
- _destinationAddress: string
- _destinationChainId: string
- Optional _userData: Uint8Array
Returns default<string>
- Defined in ptokens-entities/src/ptokens-asset.ts:101

`Protected` `Abstract` nativeToInterim

nativeToInterim(_amount: BigNumber, _destinationAddress: string, _destinationChainId: string, _userData?: Uint8Array): default<string>
Parameters
- _amount: BigNumber
- _destinationAddress: string
- _destinationChainId: string
- Optional _userData: Uint8Array
Returns default<string>
- Defined in ptokens-entities/src/ptokens-asset.ts:94

Generated using TypeDoc