Class pTokensAlgorandProvider

Hierarchy

pTokensAlgorandProvider

Implements

pTokensAssetProvider

Index

Constructors

Properties

_account _client _signer

Accessors

Methods

getTransactionParams setAccount transactInGroup waitForTransactionConfirmation

Constructors

constructor

new pTokensAlgorandProvider(_client: default, _signer?: SignatureProvider): pTokensAlgorandProvider
Create and initialize a pTokensAlgorandProvider object.
Parameters
- _client: default
  
  An algosdk.Algodv2 instance.
- Optional _signer: SignatureProvider
  
  A signature provider instance implementing signTxn().
Returns pTokensAlgorandProvider
- Defined in ptokens-assets-algorand/src/ptokens-algorand-provider.ts:56

Properties

`Private` _account

_account: string

`Private` _client

_client: default

`Private` _signer

_signer: SignatureProvider

Accessors

account

get account(): string
Return the account set with setAccount().

Returns string
- Defined in ptokens-assets-algorand/src/ptokens-algorand-provider.ts:63

Methods

getTransactionParams

getTransactionParams(): Promise<SuggestedParams>
Get suggested parameters for an Algorand transaction.

Returns
A SuggestedParams object (https://algorand.github.io/js-algorand-sdk/interfaces/SuggestedParams.html).

Returns Promise<SuggestedParams>
- Defined in ptokens-assets-algorand/src/ptokens-algorand-provider.ts:119

setAccount

setAccount(_account: string): pTokensAlgorandProvider
Set an account

Returns
The same provider. This allows methods chaining.
Parameters
- _account: string
  
  The account.
Returns pTokensAlgorandProvider
- Defined in ptokens-assets-algorand/src/ptokens-algorand-provider.ts:72

transactInGroup

transactInGroup(_txns: Transaction[]): default<string>
Push on-chain an array of transactions in a transactions group. The function returns a PromiEvent, i.e. a Promise that can also emit events. In particular, the events fired during the execution are the following:
- txBroadcasted -> fired with the transactions group ID when the transactions are broadcasted on-chain;
- txConfirmed -> fired with the transactions group ID when the transactions are confirmed on-chain;
Returns
A PromiEvent that resolves with the hash of the latest transaction in the input array.
Parameters
- _txns: Transaction[]
  
  The transactions to be broadcasted.
Returns default<string>
- Defined in ptokens-assets-algorand/src/ptokens-algorand-provider.ts:86

waitForTransactionConfirmation

waitForTransactionConfirmation(_txHash: string): Promise<string>
Wait for the confirmation of a transaction pushed on-chain.

Returns
A Promise that resolve with the same transaction hash _txHash.
Parameters
- _txHash: string
  
  The hash of the transaction.
Returns Promise<string>
Implementation of pTokensAssetProvider.waitForTransactionConfirmation
- Defined in ptokens-assets-algorand/src/ptokens-algorand-provider.ts:123

Generated using TypeDoc