-
Notifications
You must be signed in to change notification settings - Fork 42
/
myalgowallet-mode.ts
340 lines (317 loc) · 9.88 KB
/
myalgowallet-mode.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
import type {
Accounts,
Address,
AlgorandTxn,
Base64,
ConnectionSettings,
EncodedTransaction,
SignedTx,
SignTransactionOptions,
} from "@randlabs/myalgo-connect";
import algosdk, { SignedTransaction, Transaction } from "algosdk";
import { mkTxParams } from "..";
import {
ExecParams,
HttpNetworkConfig,
isSDKTransactionAndSign,
Sign,
SignType,
TransactionInGroup,
TxnReceipt,
} from "../types";
import { algoexplorerAlgod } from "./api";
import { WAIT_ROUNDS } from "./constants";
import { error, log } from "./logger";
import { mkTransaction } from "./txn";
interface MyAlgoConnect {
/**
* @async
* @description Receives user's accounts from MyAlgo.
* @param {ConnectionSettings} [settings] Connection settings
* @returns Returns an array of Algorand addresses.
*/
connect(settings?: ConnectionSettings): Promise<Accounts[]>;
/**
* @async
* @description Sign an Algorand Transaction.
* @param transaction Expect a valid Algorand transaction
* @param signOptions Sign transactions options object.
* @returns Returns signed transaction
*/
signTransaction(
transaction: AlgorandTxn | EncodedTransaction,
signOptions?: SignTransactionOptions
): Promise<SignedTx>;
/**
* @async
* @description Sign an Algorand Transaction.
* @param transaction Expect a valid Algorand transaction array.
* @param signOptions Sign transactions options object.
* @returns Returns signed an array of signed transactions.
*/
signTransaction(
transaction: (AlgorandTxn | EncodedTransaction)[],
signOptions?: SignTransactionOptions
): Promise<SignedTx[]>;
/**
* @async
* @description Sign a teal program
* @param logic Teal program
* @param address Signer Address
* @returns Returns signed teal
*/
signLogicSig(logic: Uint8Array | Base64, address: Address): Promise<Uint8Array>;
}
export class MyAlgoWalletSession {
connector!: MyAlgoConnect;
private readonly algodClient: algosdk.Algodv2;
accounts: Accounts[] = [];
addresses: Address[] = [];
constructor(walletURL: HttpNetworkConfig, connector?: MyAlgoConnect) {
this.algodClient = algoexplorerAlgod(walletURL);
try {
const MyAlgoConnect = require("@randlabs/myalgo-connect"); // eslint-disable-line @typescript-eslint/no-var-requires
if (connector) {
this.connector = connector;
} else {
this.connector = new MyAlgoConnect();
}
} catch (err) {
error(err);
throw err
}
}
// https://connect.myalgo.com/docs/interactive-examples/Connect
async connectToMyAlgo(): Promise<void> {
try {
this.accounts = await this.connector.connect({
shouldSelectOneAccount: false, // for multisig we need to allow multiple accounts login
openManager: true,
});
this.addresses = this.accounts.map((account) => account.address);
} catch (err) {
error(err);
throw new Error("Error while connecting to MyAlgo Wallet" + err);
}
}
/**
* https://connect.myalgo.com/docs/interactive-examples/PaymentTransaction
* Sign a single transaction from a my algo wallet session
* @param txn { SDK transaction object, shouldSign, signers, msig } object
* @returns raw signed txn
*/
async signTransaction(
txn: algosdk.Transaction,
signOptions?: SignTransactionOptions
): Promise<SignedTx> {
try {
return await this.connector.signTransaction(txn.toByte(), signOptions);
}
catch (err) {
error(err);
throw err
}
}
/**
* https://connect.myalgo.com/docs/interactive-examples/GroupedTransaction
* Sign a group of transaction(s) from a my algo wallet session
* @param txns { SDK transaction object, shouldSign, signers, msig } object
* @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).
*/
async signTransactionGroup(
txns: TransactionInGroup[],
signOptions?: SignTransactionOptions
): Promise<SignedTx[]> {
try {
const txnsGroup = txns.map((v) => v.txn);
const groupID = algosdk.computeGroupID(txnsGroup);
for (let i = 0; i < txns.length; i++) {
// called from executeTx where groupID is already assigned
if (!txnsGroup[i].group) {
txnsGroup[i].group = groupID;
}
}
return await this.connector.signTransaction(
txnsGroup.map((txn) => txn.toByte()),
signOptions
);
}
catch (err) {
error(err);
throw err
}
}
/**
* Send signed transaction to network and wait for confirmation
* @param rawTxns Signed Transaction(s)
* @param waitRounds number of rounds to wait for transaction to be confirmed - default is 10
* @returns TxnReceipt which includes confirmed txn response along with txID
*/
async sendAndWait(
rawTxns: Uint8Array | Uint8Array[],
waitRounds = WAIT_ROUNDS
): Promise<TxnReceipt> {
try {
const txInfo = await this.algodClient.sendRawTransaction(rawTxns).do();
return await this.waitForConfirmation(txInfo.txId, waitRounds);
}
catch (err) {
error(err);
throw err
}
}
/**
* Function used to wait for a tx confirmation
* @param txId txn ID for which confirmation is required
* @param waitRounds number of rounds to wait for transaction to be confirmed - default is 10
* @returns TxnReceipt which includes confirmed txn response along with txID
*/
async waitForConfirmation(
txId: string,
waitRounds = WAIT_ROUNDS
): Promise<TxnReceipt> {
try {
const pendingInfo = await algosdk.waitForConfirmation(this.algodClient, txId, waitRounds);
if (pendingInfo["pool-error"]) {
throw new Error(`Transaction Pool Error: ${pendingInfo["pool-error"] as string}`);
}
const txnReceipt = { txID: txId, ...pendingInfo };
return txnReceipt as TxnReceipt;
}
catch (err) {
error(err);
throw err
}
}
/**
* Execute single transaction or group of transactions (atomic transaction)
* @param execParams transaction parameters or atomic transaction parameters
*/
async executeTx(execParams: ExecParams[]): Promise<TxnReceipt> {
try {
let signedTxn: SignedTx[] | undefined;
let txns: Transaction[] = [];
if (execParams.length > 16) {
throw new Error("Maximum size of an atomic transfer group is 16");
}
if (isSDKTransactionAndSign(execParams[0]))
throw new Error("We don't support this case now");
for (const [_, txn] of execParams.entries()) {
txns.push(mkTransaction(txn, await mkTxParams(this.algodClient, txn.payFlags)));
}
txns = algosdk.assignGroupID(txns);
// with logic signature we set shouldSign to false
const toBeSignedTxns: TransactionInGroup[] = execParams.map(
(txn: ExecParams, index: number) => {
return txn.sign === SignType.LogicSignature
? { txn: txns[index], shouldSign: false } // logic signature
: { txn: txns[index], shouldSign: true }; // to be signed
}
);
// only shouldSign txn are to be signed, algowallet doesn't accept lsig ones
const nonLsigTxn = toBeSignedTxns.filter((txn) => txn.shouldSign);
if (nonLsigTxn.length) {
signedTxn = await this.signTransactionGroup(nonLsigTxn);
}
// sign smart signature transaction
for (const [index, txn] of txns.entries()) {
const signer: Sign = execParams[index];
if (signer.sign === SignType.LogicSignature) {
signer.lsig.lsig.args = signer.args ? signer.args : [];
if (!Array.isArray(signedTxn)) signedTxn = [];
signedTxn.splice(index, 0, algosdk.signLogicSigTransaction(txn, signer.lsig));
}
}
signedTxn = signedTxn?.filter((stxn) => stxn);
const Uint8ArraySignedTx = signedTxn?.map((stxn) => stxn.blob);
const confirmedTx = await this.sendAndWait(Uint8ArraySignedTx as Uint8Array[]);
log("confirmedTx: ", confirmedTx);
return confirmedTx;
}
catch (err) {
error(err);
throw err
}
}
/**
* Creates an algosdk.Transaction object based on execParams and suggestedParams
* @param execParams execParams containing all txn info
* @param txParams suggestedParams object
* @returns array of algosdk.Transaction objects
*/
makeTx(execParams: ExecParams[], txParams: algosdk.SuggestedParams): Transaction[] {
try {
const txns: Transaction[] = [];
for (const [_, txn] of execParams.entries()) {
txns.push(mkTransaction(txn, txParams));
}
return txns;
}
catch (err) {
error(err);
throw err
}
}
/**
* Signs a Transaction object with with myAlgoWallet
* @param transaction transaction object.
* @returns SignedTransaction
*/
async signTx(transaction: algosdk.Transaction): Promise<SignedTransaction> {
try {
const signedTx = await this.connector.signTransaction(transaction.toByte());
const blob = signedTx.blob;
return algosdk.decodeSignedTransaction(blob);
}
catch (err) {
error(err);
throw err
}
}
/**
* Creates an algosdk.Transaction object based on execParams and suggestedParams
* and signs with myAlgoWallet
* @param execParams execParams containing all txn info
* @param txParams suggestedParams object
* @returns array of algosdk.SignedTransaction objects
*/
async makeAndSignTx(
execParams: ExecParams[],
txParams: algosdk.SuggestedParams
): Promise<SignedTransaction[]> {
try {
const signedTxns: SignedTransaction[] = [];
const txns: Transaction[] = this.makeTx(execParams, txParams);
for (const transaction of txns) {
const signedTransaction = await this.signTx(transaction)
signedTxns.push(signedTransaction)
}
return signedTxns;
}
catch (err) {
error(err);
throw err
}
}
/**
* Sends signedTransaction and waits for the response
* @param transactions array of signedTransaction objects.
* @param rounds number of rounds to wait for response
* @returns TxnReceipt which includes confirmed txn response along with txID
*/
async sendTxAndWait(transactions: SignedTransaction[], rounds?: number): Promise<TxnReceipt> {
try {
if (transactions.length < 1) {
throw new Error("No transactions to process");
} else {
const Uint8ArraySignedTx = transactions.map((txn) => algosdk.encodeObj(txn));
return await this.sendAndWait(Uint8ArraySignedTx, rounds);
}
}
catch (err) {
error(err);
throw err
}
}
}