Class pTokensEvmAsset

Hierarchy

pTokensAsset
- pTokensEvmAsset

Index

Constructors

Properties

Accessors

assetInfo blockchain chainId identity network node provider symbol tokenAddress vaultAddress weight

Methods

_callRedeem hostToInterim isWrappedToken nativeToInterim

Constructors

constructor

new pTokensEvmAsset(config: pTokenEvmAssetConfig): pTokensEvmAsset
Create and initialize a pTokensEvmAsset object. pTokensEvmAsset objects shall be created with a pTokensEvmAssetBuilder instance.
Parameters
- config: pTokenEvmAssetConfig
Returns pTokensEvmAsset
Overrides pTokensAsset.constructor
- Defined in ptokens-assets-evm/src/ptokens-evm-asset.ts:30

Properties

`Private` _provider

_provider: pTokensEvmProvider

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(): pTokensEvmProvider
Return the pTokensAssetProvider eventually assigned

Returns pTokensEvmProvider
Overrides pTokensAsset.provider
- Defined in ptokens-assets-evm/src/ptokens-evm-asset.ts:36

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

`Private` _callRedeem

_callRedeem(_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-assets-evm/src/ptokens-evm-asset.ts:99

`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-evm/src/ptokens-evm-asset.ts:143

`Private` isWrappedToken

isWrappedToken(): boolean
Returns boolean
- Defined in ptokens-assets-evm/src/ptokens-evm-asset.ts:40

`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-evm/src/ptokens-evm-asset.ts:46

Generated using TypeDoc