Class pTokensEosioAsset

Hierarchy

pTokensAsset
- pTokensEosioAsset

Index

Constructors

constructor

new pTokensEosioAsset(_config: pTokenEosioAssetConfig): pTokensEosioAsset
Create and initialize a pTokensEosioAsset object. pTokensEosioAsset objects shall be created with a pTokensEosioAssetBuilder instance.
Parameters
- _config: pTokenEosioAssetConfig
Returns pTokensEosioAsset
Overrides pTokensAsset.constructor
- Defined in ptokens-assets-eosio/src/ptokens-eosio-asset.ts:29

Properties

`Private` _customActions

_customActions: Action[]

`Private` _provider

_provider: pTokensEosioProvider

Accessors

assetInfo

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

Returns AssetInfo
Inherited from pTokensAsset.assetInfo
- Defined in ptokens-entities/dist/index.d.ts:54

blockchain

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

Returns Blockchain
Inherited from pTokensAsset.blockchain
- Defined in ptokens-entities/dist/index.d.ts:42

chainId

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

Returns ChainId
Inherited from pTokensAsset.chainId
- Defined in ptokens-entities/dist/index.d.ts:40

identity

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

Returns string
Inherited from pTokensAsset.identity
- Defined in ptokens-entities/dist/index.d.ts:50

network

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

Returns Network
Inherited from pTokensAsset.network
- Defined in ptokens-entities/dist/index.d.ts:44

node

get node(): pTokensNode
Returns pTokensNode
Inherited from pTokensAsset.node
- Defined in ptokens-entities/dist/index.d.ts:36

provider

get provider(): pTokensEosioProvider
Return the pTokensAssetProvider eventually assigned

Returns pTokensEosioProvider
Overrides pTokensAsset.provider
- Defined in ptokens-assets-eosio/src/ptokens-eosio-asset.ts:35

symbol

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

Returns string
Inherited from pTokensAsset.symbol
- Defined in ptokens-entities/dist/index.d.ts:38

tokenAddress

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

Returns string
Inherited from pTokensAsset.tokenAddress
- Defined in ptokens-entities/dist/index.d.ts:48

vaultAddress

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

Returns string
Inherited from pTokensAsset.vaultAddress
- Defined in ptokens-entities/dist/index.d.ts:46

weight

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

Returns number
Inherited from pTokensAsset.weight
- Defined in ptokens-entities/dist/index.d.ts:52

Methods

`Protected` 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>
Overrides pTokensAsset.hostToInterim
- Defined in ptokens-assets-eosio/src/ptokens-eosio-asset.ts:106

`Protected` 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>
Overrides pTokensAsset.nativeToInterim
- Defined in ptokens-assets-eosio/src/ptokens-eosio-asset.ts:51

setCustomActions

setCustomActions(_actions: Action[]): pTokensEosioAsset
Set custom actions to be pushed on-chain when swapping. These will override the standard actions used to interact with the pNetwork. Use carefully.

Returns
The same asset. This allows methods chaining.
Parameters
- _actions: Action[]
  
  An array of algosdk.EncodedTransaction objects (https://algorand.github.io/js-algorand-sdk/interfaces/EncodedTransaction.html).
Returns pTokensEosioAsset
- Defined in ptokens-assets-eosio/src/ptokens-eosio-asset.ts:44

Class pTokensEosioAsset

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_config: pTokenEosioAssetConfig

Returns pTokensEosioAsset

Properties

Private _customActions

Private _provider

Accessors

assetInfo

Returns AssetInfo

blockchain

Returns Blockchain

chainId

Returns ChainId

identity

Returns string

network

Returns Network

node

Returns pTokensNode

provider

Returns pTokensEosioProvider

symbol

Returns string

tokenAddress

Returns string

vaultAddress

Returns string

weight

Returns number

Methods

Protected hostToInterim

Parameters

_amount: BigNumber

_destinationAddress: string

_destinationChainId: string

Optional _userData: Uint8Array

Returns default<string>

Protected nativeToInterim

Parameters

_amount: BigNumber

_destinationAddress: string

_destinationChainId: string

Optional _userData: Uint8Array

Returns default<string>

setCustomActions

Returns

Parameters

_actions: Action[]

Returns pTokensEosioAsset

Settings

Member Visibility

Theme

`Private` _customActions

`Private` _provider

`Protected` hostToInterim

`Optional` _userData: Uint8Array

`Protected` nativeToInterim

`Optional` _userData: Uint8Array