Class pTokensAlgorandAsset

Hierarchy

pTokensAsset
- pTokensAlgorandAsset

Index

Constructors

Properties

_customTransactions _provider

Accessors

assetInfo blockchain chainId identity network node provider symbol tokenAddress vaultAddress weight

Methods

hostToInterim nativeToInterim setCustomTransactions

Constructors

constructor

new pTokensAlgorandAsset(_config: pTokenAlgorandAssetConfig): pTokensAlgorandAsset
Create and initialize a pTokensAlgorandAsset object. pTokensAlgorandAsset objects shall be created with a pTokensAlgorandAssetBuilder instance.
Parameters
- _config: pTokenAlgorandAssetConfig
Returns pTokensAlgorandAsset
Overrides pTokensAsset.constructor
- Defined in ptokens-assets-algorand/src/ptokens-algorand-asset.ts:33

Properties

`Private` _customTransactions

_customTransactions: Transaction[]

`Private` _provider

_provider: pTokensAlgorandProvider

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

Returns pTokensAlgorandProvider
Overrides pTokensAsset.provider
- Defined in ptokens-assets-algorand/src/ptokens-algorand-asset.ts:39

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-algorand/src/ptokens-algorand-asset.ts:59

`Protected` nativeToInterim

nativeToInterim(): default<string>
Returns default<string>
Overrides pTokensAsset.nativeToInterim
- Defined in ptokens-assets-algorand/src/ptokens-algorand-asset.ts:55

setCustomTransactions

setCustomTransactions(_transactions: EncodedTransaction[]): pTokensAlgorandAsset
Set custom transactions to be pushed on-chain when swapping. These will override the standard transactions used to interact with the pNetwork. Use carefully.

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

Generated using TypeDoc