Class MyAlgoWalletSession

Hierarchy

MyAlgoWalletSession

Index

Constructors

Properties

Methods

connectToMyAlgo executeTx makeAndSignTx makeTx sendAndWait sendTxAndWait signLogic signLogicSigTx signTransaction signTransactionGroup signTx waitForConfirmation

Constructors

constructor

new MyAlgoWalletSession(walletURL: HttpNetworkConfig, connector?: MyAlgoConnect): MyAlgoWalletSession
Parameters
- walletURL: HttpNetworkConfig
- Optional connector: MyAlgoConnect
Returns MyAlgoWalletSession
- Defined in packages/web/src/lib/myalgowallet-mode.ts:77

Properties

accounts

accounts: Accounts[] = []

addresses

addresses: string[] = []

connector

connector: MyAlgoConnect

Methods

connectToMyAlgo

connectToMyAlgo(allowMultipleAccounts?: boolean): Promise<void>
Async

Description
Connects to the MyAlgo Wallet by opening up its dialog box to login
Parameters
- allowMultipleAccounts: boolean = true
  
  allow selection of multiple accounts from MyAlgo Wallet, default is true For Multisig you need to allow multiple accounts login for more info visit: https://connect.myalgo.com/docs/interactive-examples/Connect
Returns Promise<void>
- Defined in packages/web/src/lib/myalgowallet-mode.ts:133

executeTx

executeTx(execParams: ExecParams[]): Promise<TxnReceipt>
Execute single transaction or group of transactions (atomic transaction)
Parameters
- execParams: ExecParams[]
  
  transaction parameters or atomic transaction parameters
Returns Promise<TxnReceipt>
- Defined in packages/web/src/lib/myalgowallet-mode.ts:237

makeAndSignTx

makeAndSignTx(execParams: ExecParams[], txParams: SuggestedParams): Promise<SignedTransaction[]>
Creates an algosdk.Transaction object based on execParams and suggestedParams and signs with myAlgoWallet

Returns
array of algosdk.SignedTransaction objects
Parameters
- execParams: ExecParams[]
  
  execParams containing all txn info
- txParams: SuggestedParams
  
  suggestedParams object
Returns Promise<SignedTransaction[]>
- Defined in packages/web/src/lib/myalgowallet-mode.ts:331

makeTx

makeTx(execParams: ExecParams[], txParams: SuggestedParams): Transaction[]
Creates an algosdk.Transaction object based on execParams and suggestedParams

Returns
array of algosdk.Transaction objects
Parameters
- execParams: ExecParams[]
  
  execParams containing all txn info
- txParams: SuggestedParams
  
  suggestedParams object
Returns Transaction[]
- Defined in packages/web/src/lib/myalgowallet-mode.ts:295

sendAndWait

sendAndWait(rawTxns: Uint8Array | Uint8Array[], waitRounds?: number): Promise<TxnReceipt>
Send signed transaction to network and wait for confirmation

Returns
TxnReceipt which includes confirmed txn response along with txID
Parameters
- rawTxns: Uint8Array | Uint8Array[]
  
  Signed Transaction(s)
- waitRounds: number = WAIT_ROUNDS
  
  number of rounds to wait for transaction to be confirmed - default is 10
Returns Promise<TxnReceipt>
- Defined in packages/web/src/lib/myalgowallet-mode.ts:200

sendTxAndWait

sendTxAndWait(transactions: SignedTransaction[], rounds?: number): Promise<TxnReceipt>
Sends signedTransaction and waits for the response

Returns
TxnReceipt which includes confirmed txn response along with txID
Parameters
- transactions: SignedTransaction[]
  
  array of signedTransaction objects.
- Optional rounds: number
  
  number of rounds to wait for response
Returns Promise<TxnReceipt>
- Defined in packages/web/src/lib/myalgowallet-mode.ts:355

signLogic

signLogic(logic: string | Uint8Array, address: string): Promise<Uint8Array>
Async

Description
Signs a teal program (https://algorand.github.io/js-algorand-sdk/modules.html#tealSign)

Returns
Returns signed teal for more info: https://connect.myalgo.com/docs/interactive-examples/TealSign https://developer.algorand.org/docs/get-details/dapps/smart-contracts/smartsigs/modes/#delegated-approval
Parameters
- logic: string | Uint8Array
  
  Teal program
- address: string
  
  Signer Address
Returns Promise<Uint8Array>
- Defined in packages/web/src/lib/myalgowallet-mode.ts:101

signLogicSigTx

signLogicSigTx(transaction: Transaction, logicSig: LogicSigAccount): {
blob: Uint8Array;
txID: string;
}
Description
Takes a transaction and a LogicSig object and returns an encoded signed transaction.

Returns
Returns txID and blob object for more info: https://developer.algorand.org/docs/get-details/dapps/smart-contracts/smartsigs/modes/#contract-account
Parameters
- transaction: Transaction
  
  algosdk.Transaction object
- logicSig: LogicSigAccount
  
  Logic Sig Account
Returns {
blob: Uint8Array;
txID: string;
}
- blob: Uint8Array
- txID: string
- Defined in packages/web/src/lib/myalgowallet-mode.ts:117

signTransaction

signTransaction(txn: Transaction, signOptions?: SignTransactionOptions): Promise<SignedTx>
https://connect.myalgo.com/docs/interactive-examples/PaymentTransaction Sign a single transaction from a my algo wallet session

Returns
raw signed txn
Parameters
- txn: Transaction
  
  { SDK transaction object, shouldSign, signers, msig } object
- Optional signOptions: SignTransactionOptions
Returns Promise<SignedTx>
- Defined in packages/web/src/lib/myalgowallet-mode.ts:152

signTransactionGroup

signTransactionGroup(txns: TransactionInGroup[], signOptions?: SignTransactionOptions): Promise<SignedTx[]>
https://connect.myalgo.com/docs/interactive-examples/GroupedTransaction Sign a group of transaction(s) from a my algo wallet session

Returns
array of raw signed txns | null. null representes that the txn in array is NOT signed by wallet user (i.e signable by someone else).
Parameters
- txns: TransactionInGroup[]
  
  { SDK transaction object, shouldSign, signers, msig } object
- Optional signOptions: SignTransactionOptions
Returns Promise<SignedTx[]>
- Defined in packages/web/src/lib/myalgowallet-mode.ts:171

signTx

signTx(transaction: Transaction): Promise<SignedTransaction>
Signs a Transaction object with with myAlgoWallet

Returns
SignedTransaction
Parameters
- transaction: Transaction
  
  transaction object.
Returns Promise<SignedTransaction>
- Defined in packages/web/src/lib/myalgowallet-mode.ts:313

waitForConfirmation

waitForConfirmation(txId: string, waitRounds?: number): Promise<TxnReceipt>
Function used to wait for a tx confirmation

Returns
TxnReceipt which includes confirmed txn response along with txID
Parameters
- txId: string
  
  txn ID for which confirmation is required
- waitRounds: number = WAIT_ROUNDS
  
  number of rounds to wait for transaction to be confirmed - default is 10
Returns Promise<TxnReceipt>
- Defined in packages/web/src/lib/myalgowallet-mode.ts:219

Class MyAlgoWalletSession

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

walletURL: HttpNetworkConfig

Optional connector: MyAlgoConnect

Returns MyAlgoWalletSession

Properties

accounts

addresses

connector

Methods

connectToMyAlgo

Async

Description

Parameters

allowMultipleAccounts: boolean = true

Returns Promise<void>

executeTx

Parameters

execParams: ExecParams[]

Returns Promise<TxnReceipt>

makeAndSignTx

Returns

Parameters

execParams: ExecParams[]

txParams: SuggestedParams

Returns Promise<SignedTransaction[]>

makeTx

Returns

Parameters

execParams: ExecParams[]

txParams: SuggestedParams

Returns Transaction[]

sendAndWait

Returns

Parameters

rawTxns: Uint8Array | Uint8Array[]

waitRounds: number = WAIT_ROUNDS

Returns Promise<TxnReceipt>

sendTxAndWait

Returns

Parameters

transactions: SignedTransaction[]

Optional rounds: number

Returns Promise<TxnReceipt>

signLogic

Async

Description

Returns

Parameters

logic: string | Uint8Array

address: string

Returns Promise<Uint8Array>

signLogicSigTx

Description

Returns

Parameters

transaction: Transaction

logicSig: LogicSigAccount

Returns { blob: Uint8Array; txID: string; }

blob: Uint8Array

txID: string

signTransaction

Returns

Parameters

txn: Transaction

Optional signOptions: SignTransactionOptions

Returns Promise<SignedTx>

signTransactionGroup

Returns

Parameters

txns: TransactionInGroup[]

Optional signOptions: SignTransactionOptions

Returns Promise<SignedTx[]>

`Optional` connector: MyAlgoConnect

`Optional` rounds: number

Returns {
blob: Uint8Array;
txID: string;
}

`Optional` signOptions: SignTransactionOptions

`Optional` signOptions: SignTransactionOptions