@algorandfoundation/algokit-utils 6.3.0-beta.1 → 7.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/account/account.d.ts +7 -7
- package/account/account.js +7 -7
- package/account/account.mjs +7 -7
- package/account/get-account.d.ts +2 -2
- package/account/get-account.js +1 -1
- package/account/get-account.mjs +1 -1
- package/account/get-dispenser-account.d.ts +1 -1
- package/account/get-dispenser-account.js +1 -1
- package/account/get-dispenser-account.mjs +1 -1
- package/account/mnemonic-account.d.ts +1 -1
- package/account/mnemonic-account.js +1 -1
- package/account/mnemonic-account.mjs +1 -1
- package/app-deploy.d.ts +18 -1
- package/app-deploy.d.ts.map +1 -1
- package/app-deploy.js +142 -333
- package/app-deploy.js.map +1 -1
- package/app-deploy.mjs +145 -336
- package/app-deploy.mjs.map +1 -1
- package/app.d.ts +38 -1
- package/app.d.ts.map +1 -1
- package/app.js +113 -370
- package/app.js.map +1 -1
- package/app.mjs +114 -371
- package/app.mjs.map +1 -1
- package/asset.d.ts +5 -5
- package/asset.js +5 -5
- package/asset.mjs +5 -5
- package/debugging/debugging.js +2 -2
- package/debugging/debugging.js.map +1 -1
- package/debugging/debugging.mjs +2 -2
- package/debugging/debugging.mjs.map +1 -1
- package/index.d.ts +1 -1
- package/index.d.ts.map +1 -1
- package/index.js +12 -12
- package/index.mjs +1 -1
- package/localnet/get-kmd-wallet-account.d.ts +1 -1
- package/localnet/get-kmd-wallet-account.js +1 -1
- package/localnet/get-kmd-wallet-account.mjs +1 -1
- package/localnet/get-localnet-dispenser-account.d.ts +1 -1
- package/localnet/get-localnet-dispenser-account.js +1 -1
- package/localnet/get-localnet-dispenser-account.mjs +1 -1
- package/localnet/get-or-create-kmd-wallet-account.d.ts +1 -1
- package/localnet/get-or-create-kmd-wallet-account.js +1 -1
- package/localnet/get-or-create-kmd-wallet-account.mjs +1 -1
- package/localnet/is-localnet.d.ts +1 -1
- package/localnet/is-localnet.js +1 -1
- package/localnet/is-localnet.mjs +1 -1
- package/network-client.d.ts +2 -2
- package/network-client.d.ts.map +1 -1
- package/network-client.js +2 -2
- package/network-client.mjs +2 -2
- package/package.json +1 -1
- package/testing/fixtures/algorand-fixture.js +12 -12
- package/testing/fixtures/algorand-fixture.js.map +1 -1
- package/testing/fixtures/algorand-fixture.mjs +12 -12
- package/testing/fixtures/algorand-fixture.mjs.map +1 -1
- package/transaction/legacy-bridge.d.ts +31 -5
- package/transaction/legacy-bridge.d.ts.map +1 -1
- package/transaction/legacy-bridge.js +99 -5
- package/transaction/legacy-bridge.js.map +1 -1
- package/transaction/legacy-bridge.mjs +98 -7
- package/transaction/legacy-bridge.mjs.map +1 -1
- package/transfer/transfer-algos.d.ts +1 -1
- package/transfer/transfer-algos.js +1 -1
- package/transfer/transfer-algos.mjs +1 -1
- package/transfer/transfer.d.ts +1 -1
- package/transfer/transfer.js +1 -1
- package/transfer/transfer.mjs +1 -1
- package/types/account-manager.d.ts +1 -1
- package/types/account-manager.d.ts.map +1 -1
- package/types/algorand-client-transaction-creator.d.ts +450 -20
- package/types/algorand-client-transaction-creator.d.ts.map +1 -1
- package/types/algorand-client-transaction-creator.js +406 -22
- package/types/algorand-client-transaction-creator.js.map +1 -1
- package/types/algorand-client-transaction-creator.mjs +406 -22
- package/types/algorand-client-transaction-creator.mjs.map +1 -1
- package/types/algorand-client-transaction-sender.d.ts +750 -24
- package/types/algorand-client-transaction-sender.d.ts.map +1 -1
- package/types/algorand-client-transaction-sender.js +426 -12
- package/types/algorand-client-transaction-sender.js.map +1 -1
- package/types/algorand-client-transaction-sender.mjs +426 -12
- package/types/algorand-client-transaction-sender.mjs.map +1 -1
- package/types/algorand-client.d.ts +8 -0
- package/types/algorand-client.d.ts.map +1 -1
- package/types/algorand-client.js +14 -1
- package/types/algorand-client.js.map +1 -1
- package/types/algorand-client.mjs +14 -1
- package/types/algorand-client.mjs.map +1 -1
- package/types/app-client.d.ts +13 -1
- package/types/app-client.d.ts.map +1 -1
- package/types/app-client.js +8 -5
- package/types/app-client.js.map +1 -1
- package/types/app-client.mjs +9 -6
- package/types/app-client.mjs.map +1 -1
- package/types/app-deployer.d.ts +121 -0
- package/types/app-deployer.d.ts.map +1 -0
- package/types/app-deployer.js +354 -0
- package/types/app-deployer.js.map +1 -0
- package/types/app-deployer.mjs +352 -0
- package/types/app-deployer.mjs.map +1 -0
- package/types/app-manager.d.ts +235 -0
- package/types/app-manager.d.ts.map +1 -0
- package/types/app-manager.js +336 -0
- package/types/app-manager.js.map +1 -0
- package/types/app-manager.mjs +334 -0
- package/types/app-manager.mjs.map +1 -0
- package/types/app.d.ts +42 -7
- package/types/app.d.ts.map +1 -1
- package/types/app.js +1 -1
- package/types/app.js.map +1 -1
- package/types/app.mjs +1 -1
- package/types/app.mjs.map +1 -1
- package/types/client-manager.d.ts +2 -0
- package/types/client-manager.d.ts.map +1 -1
- package/types/client-manager.js +4 -0
- package/types/client-manager.js.map +1 -1
- package/types/client-manager.mjs +4 -0
- package/types/client-manager.mjs.map +1 -1
- package/types/composer.d.ts +150 -39
- package/types/composer.d.ts.map +1 -1
- package/types/composer.js +218 -62
- package/types/composer.js.map +1 -1
- package/types/composer.mjs +218 -62
- package/types/composer.mjs.map +1 -1
- package/types/expand.d.ts +8 -0
- package/types/expand.d.ts.map +1 -0
- package/types/expand.js +3 -0
- package/types/expand.js.map +1 -0
- package/types/expand.mjs +2 -0
- package/types/expand.mjs.map +1 -0
- package/types/transaction.d.ts +3 -0
- package/types/transaction.d.ts.map +1 -1
|
@@ -1,26 +1,31 @@
|
|
|
1
1
|
import algosdk from 'algosdk';
|
|
2
|
+
import { SendAppCreateTransactionResult, SendAppTransactionResult, SendAppUpdateTransactionResult } from './app';
|
|
3
|
+
import { AppManager } from './app-manager';
|
|
2
4
|
import { AssetManager } from './asset-manager';
|
|
3
|
-
import AlgoKitComposer, { AssetCreateParams, AssetOptOutParams, ExecuteParams } from './composer';
|
|
4
|
-
import {
|
|
5
|
-
/** Result from sending a single transaction. */
|
|
6
|
-
export type SendSingleTransactionResult = SendAtomicTransactionComposerResults & ConfirmedTransactionResult;
|
|
5
|
+
import AlgoKitComposer, { AppCallParams, AssetCreateParams, AssetOptOutParams, ExecuteParams } from './composer';
|
|
6
|
+
import { SendSingleTransactionResult } from './transaction';
|
|
7
7
|
/** Orchestrates sending transactions for `AlgorandClient`. */
|
|
8
8
|
export declare class AlgorandClientTransactionSender {
|
|
9
9
|
private _newGroup;
|
|
10
10
|
private _assetManager;
|
|
11
|
+
private _appManager;
|
|
11
12
|
/**
|
|
12
13
|
* Creates a new `AlgorandClientSender`
|
|
13
14
|
* @param newGroup A lambda that starts a new `AlgoKitComposer` transaction group
|
|
14
15
|
* @param assetManager An `AssetManager` instance
|
|
15
16
|
*/
|
|
16
|
-
constructor(newGroup: () => AlgoKitComposer, assetManager: AssetManager);
|
|
17
|
+
constructor(newGroup: () => AlgoKitComposer, assetManager: AssetManager, appManager: AppManager);
|
|
18
|
+
newGroup(): AlgoKitComposer;
|
|
17
19
|
private _send;
|
|
20
|
+
private _sendAppCall;
|
|
21
|
+
private _sendAppUpdateCall;
|
|
22
|
+
private _sendAppCreateCall;
|
|
18
23
|
/**
|
|
19
24
|
* Send a payment transaction to transfer Algo between accounts.
|
|
20
25
|
* @param params The parameters for the payment transaction
|
|
21
26
|
* @example Basic example
|
|
22
27
|
* ```typescript
|
|
23
|
-
* const result = await
|
|
28
|
+
* const result = await algorand.send.payment({
|
|
24
29
|
* sender: 'SENDERADDRESS',
|
|
25
30
|
* receiver: 'RECEIVERADDRESS',
|
|
26
31
|
* amount: (4).algo(),
|
|
@@ -28,7 +33,7 @@ export declare class AlgorandClientTransactionSender {
|
|
|
28
33
|
* ```
|
|
29
34
|
* @example Advanced example
|
|
30
35
|
* ```typescript
|
|
31
|
-
* const result = await
|
|
36
|
+
* const result = await algorand.send.payment({
|
|
32
37
|
* amount: (4).algo(),
|
|
33
38
|
* receiver: 'RECEIVERADDRESS',
|
|
34
39
|
* sender: 'SENDERADDRESS',
|
|
@@ -341,7 +346,7 @@ export declare class AlgorandClientTransactionSender {
|
|
|
341
346
|
*
|
|
342
347
|
* @param params The parameters for the asset opt-out transaction
|
|
343
348
|
*
|
|
344
|
-
* @example Basic example (without creator)
|
|
349
|
+
* @example Basic example (without creator, will be retrieved from algod)
|
|
345
350
|
* ```typescript
|
|
346
351
|
* await algorand.send.assetOptOut({sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true })
|
|
347
352
|
* ```
|
|
@@ -386,40 +391,761 @@ export declare class AlgorandClientTransactionSender {
|
|
|
386
391
|
* If this is set to `false` and the account has an asset balance it will lose those assets to the asset creator.
|
|
387
392
|
*/
|
|
388
393
|
ensureZeroBalance: boolean;
|
|
389
|
-
} & ExecuteParams) => Promise<
|
|
394
|
+
} & ExecuteParams) => Promise<{
|
|
395
|
+
groupId: string;
|
|
396
|
+
txIds: string[];
|
|
397
|
+
returns?: import("./app").ABIReturn[] | undefined;
|
|
398
|
+
confirmations: algosdk.modelsv2.PendingTransactionResponse[];
|
|
399
|
+
transactions: algosdk.Transaction[];
|
|
400
|
+
confirmation: algosdk.modelsv2.PendingTransactionResponse;
|
|
401
|
+
transaction: algosdk.Transaction;
|
|
402
|
+
}>;
|
|
403
|
+
/**
|
|
404
|
+
* Create a smart contract.
|
|
405
|
+
*
|
|
406
|
+
* Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
407
|
+
*
|
|
408
|
+
* @param params The parameters for the app creation transaction
|
|
409
|
+
* @example Basic example
|
|
410
|
+
* ```typescript
|
|
411
|
+
* const result = await algorand.send.appCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })
|
|
412
|
+
* const createdAppId = result.appId
|
|
413
|
+
* ```
|
|
414
|
+
* @example Advanced example
|
|
415
|
+
* ```typescript
|
|
416
|
+
* await algorand.send.appCreate({
|
|
417
|
+
* sender: 'CREATORADDRESS',
|
|
418
|
+
* approvalProgram: "TEALCODE",
|
|
419
|
+
* clearStateProgram: "TEALCODE",
|
|
420
|
+
* schema: {
|
|
421
|
+
* globalInts: 1,
|
|
422
|
+
* globalByteSlices: 2,
|
|
423
|
+
* localInts: 3,
|
|
424
|
+
* localByteSlices: 4
|
|
425
|
+
* },
|
|
426
|
+
* extraProgramPages: 1,
|
|
427
|
+
* onComplete: algosdk.OnApplicationComplete.OptInOC,
|
|
428
|
+
* args: [new Uint8Array(1, 2, 3, 4)]
|
|
429
|
+
* accountReferences: ["ACCOUNT_1"]
|
|
430
|
+
* appReferences: [123n, 1234n]
|
|
431
|
+
* assetReferences: [12345n]
|
|
432
|
+
* boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
433
|
+
* lease: 'lease',
|
|
434
|
+
* note: 'note',
|
|
435
|
+
* // You wouldn't normally set this field
|
|
436
|
+
* firstValidRound: 1000n,
|
|
437
|
+
* validityWindow: 10,
|
|
438
|
+
* extraFee: (1000).microAlgo(),
|
|
439
|
+
* staticFee: (1000).microAlgo(),
|
|
440
|
+
* // Max fee doesn't make sense with extraFee AND staticFee
|
|
441
|
+
* // already specified, but here for completeness
|
|
442
|
+
* maxFee: (3000).microAlgo(),
|
|
443
|
+
* // Signer only needed if you want to provide one,
|
|
444
|
+
* // generally you'd register it with AlgorandClient
|
|
445
|
+
* // against the sender and not need to pass it in
|
|
446
|
+
* signer: transactionSigner,
|
|
447
|
+
* maxRoundsToWaitForConfirmation: 5,
|
|
448
|
+
* suppressLog: true,
|
|
449
|
+
*})
|
|
450
|
+
* ```
|
|
451
|
+
*/
|
|
452
|
+
appCreate: (params: {
|
|
453
|
+
lease?: string | Uint8Array | undefined;
|
|
454
|
+
note?: string | Uint8Array | undefined;
|
|
455
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
456
|
+
args?: Uint8Array[] | undefined;
|
|
457
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
458
|
+
sender: string;
|
|
459
|
+
rekeyTo?: string | undefined;
|
|
460
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
461
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
462
|
+
validityWindow?: number | undefined;
|
|
463
|
+
firstValidRound?: bigint | undefined;
|
|
464
|
+
lastValidRound?: bigint | undefined;
|
|
465
|
+
onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
|
|
466
|
+
accountReferences?: string[] | undefined;
|
|
467
|
+
appReferences?: bigint[] | undefined;
|
|
468
|
+
assetReferences?: bigint[] | undefined;
|
|
469
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
470
|
+
approvalProgram: string | Uint8Array;
|
|
471
|
+
clearStateProgram: string | Uint8Array;
|
|
472
|
+
schema?: {
|
|
473
|
+
globalInts: number;
|
|
474
|
+
globalByteSlices: number;
|
|
475
|
+
localInts: number;
|
|
476
|
+
localByteSlices: number;
|
|
477
|
+
} | undefined;
|
|
478
|
+
extraProgramPages?: number | undefined;
|
|
479
|
+
} & ExecuteParams) => Promise<SendAppCreateTransactionResult>;
|
|
480
|
+
/**
|
|
481
|
+
* Update a smart contract.
|
|
482
|
+
*
|
|
483
|
+
* Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
484
|
+
*
|
|
485
|
+
* @param params The parameters for the app update transaction
|
|
486
|
+
* @example Basic example
|
|
487
|
+
* ```typescript
|
|
488
|
+
* await algorand.send.appUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' })
|
|
489
|
+
* ```
|
|
490
|
+
* @example Advanced example
|
|
491
|
+
* ```typescript
|
|
492
|
+
* await algorand.send.appUpdate({
|
|
493
|
+
* sender: 'CREATORADDRESS',
|
|
494
|
+
* approvalProgram: "TEALCODE",
|
|
495
|
+
* clearStateProgram: "TEALCODE",
|
|
496
|
+
* onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC,
|
|
497
|
+
* args: [new Uint8Array(1, 2, 3, 4)]
|
|
498
|
+
* accountReferences: ["ACCOUNT_1"]
|
|
499
|
+
* appReferences: [123n, 1234n]
|
|
500
|
+
* assetReferences: [12345n]
|
|
501
|
+
* boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
502
|
+
* lease: 'lease',
|
|
503
|
+
* note: 'note',
|
|
504
|
+
* // You wouldn't normally set this field
|
|
505
|
+
* firstValidRound: 1000n,
|
|
506
|
+
* validityWindow: 10,
|
|
507
|
+
* extraFee: (1000).microAlgo(),
|
|
508
|
+
* staticFee: (1000).microAlgo(),
|
|
509
|
+
* // Max fee doesn't make sense with extraFee AND staticFee
|
|
510
|
+
* // already specified, but here for completeness
|
|
511
|
+
* maxFee: (3000).microAlgo(),
|
|
512
|
+
* // Signer only needed if you want to provide one,
|
|
513
|
+
* // generally you'd register it with AlgorandClient
|
|
514
|
+
* // against the sender and not need to pass it in
|
|
515
|
+
* signer: transactionSigner,
|
|
516
|
+
* maxRoundsToWaitForConfirmation: 5,
|
|
517
|
+
* suppressLog: true,
|
|
518
|
+
*})
|
|
519
|
+
* ```
|
|
520
|
+
*/
|
|
521
|
+
appUpdate: (params: {
|
|
522
|
+
sender: string;
|
|
523
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
524
|
+
rekeyTo?: string | undefined;
|
|
525
|
+
note?: string | Uint8Array | undefined;
|
|
526
|
+
lease?: string | Uint8Array | undefined;
|
|
527
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
528
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
529
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
530
|
+
validityWindow?: number | undefined;
|
|
531
|
+
firstValidRound?: bigint | undefined;
|
|
532
|
+
lastValidRound?: bigint | undefined;
|
|
533
|
+
appId: bigint;
|
|
534
|
+
onComplete?: algosdk.OnApplicationComplete.UpdateApplicationOC | undefined;
|
|
535
|
+
args?: Uint8Array[] | undefined;
|
|
536
|
+
accountReferences?: string[] | undefined;
|
|
537
|
+
appReferences?: bigint[] | undefined;
|
|
538
|
+
assetReferences?: bigint[] | undefined;
|
|
539
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
540
|
+
approvalProgram: string | Uint8Array;
|
|
541
|
+
clearStateProgram: string | Uint8Array;
|
|
542
|
+
} & ExecuteParams) => Promise<SendAppUpdateTransactionResult>;
|
|
543
|
+
/**
|
|
544
|
+
* Delete a smart contract.
|
|
545
|
+
*
|
|
546
|
+
* Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
547
|
+
*
|
|
548
|
+
* @param params The parameters for the app deletion transaction
|
|
549
|
+
* @example Basic example
|
|
550
|
+
* ```typescript
|
|
551
|
+
* await algorand.send.appDelete({ sender: 'CREATORADDRESS' })
|
|
552
|
+
* ```
|
|
553
|
+
* @example Advanced example
|
|
554
|
+
* ```typescript
|
|
555
|
+
* await algorand.send.appDelete({
|
|
556
|
+
* sender: 'CREATORADDRESS',
|
|
557
|
+
* onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC,
|
|
558
|
+
* args: [new Uint8Array(1, 2, 3, 4)]
|
|
559
|
+
* accountReferences: ["ACCOUNT_1"]
|
|
560
|
+
* appReferences: [123n, 1234n]
|
|
561
|
+
* assetReferences: [12345n]
|
|
562
|
+
* boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
563
|
+
* lease: 'lease',
|
|
564
|
+
* note: 'note',
|
|
565
|
+
* // You wouldn't normally set this field
|
|
566
|
+
* firstValidRound: 1000n,
|
|
567
|
+
* validityWindow: 10,
|
|
568
|
+
* extraFee: (1000).microAlgo(),
|
|
569
|
+
* staticFee: (1000).microAlgo(),
|
|
570
|
+
* // Max fee doesn't make sense with extraFee AND staticFee
|
|
571
|
+
* // already specified, but here for completeness
|
|
572
|
+
* maxFee: (3000).microAlgo(),
|
|
573
|
+
* // Signer only needed if you want to provide one,
|
|
574
|
+
* // generally you'd register it with AlgorandClient
|
|
575
|
+
* // against the sender and not need to pass it in
|
|
576
|
+
* signer: transactionSigner,
|
|
577
|
+
* maxRoundsToWaitForConfirmation: 5,
|
|
578
|
+
* suppressLog: true,
|
|
579
|
+
*})
|
|
580
|
+
* ```
|
|
581
|
+
*/
|
|
582
|
+
appDelete: (params: import("./composer").CommonTransactionParams & {
|
|
583
|
+
appId: bigint;
|
|
584
|
+
onComplete?: algosdk.OnApplicationComplete | undefined;
|
|
585
|
+
args?: Uint8Array[] | undefined;
|
|
586
|
+
accountReferences?: string[] | undefined;
|
|
587
|
+
appReferences?: bigint[] | undefined;
|
|
588
|
+
assetReferences?: bigint[] | undefined;
|
|
589
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
590
|
+
} & {
|
|
591
|
+
onComplete?: algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
|
|
592
|
+
} & ExecuteParams) => Promise<SendAppTransactionResult>;
|
|
390
593
|
/**
|
|
391
594
|
* Call a smart contract.
|
|
392
595
|
*
|
|
393
|
-
* Note: you may prefer to use `
|
|
596
|
+
* Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
597
|
+
*
|
|
598
|
+
* @param params The parameters for the app call transaction
|
|
599
|
+
* @example Basic example
|
|
600
|
+
* ```typescript
|
|
601
|
+
* await algorand.send.appCall({ sender: 'CREATORADDRESS' })
|
|
602
|
+
* ```
|
|
603
|
+
* @example Advanced example
|
|
604
|
+
* ```typescript
|
|
605
|
+
* await algorand.send.appCall({
|
|
606
|
+
* sender: 'CREATORADDRESS',
|
|
607
|
+
* onComplete: algosdk.OnApplicationComplete.OptInOC,
|
|
608
|
+
* args: [new Uint8Array(1, 2, 3, 4)]
|
|
609
|
+
* accountReferences: ["ACCOUNT_1"]
|
|
610
|
+
* appReferences: [123n, 1234n]
|
|
611
|
+
* assetReferences: [12345n]
|
|
612
|
+
* boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
613
|
+
* lease: 'lease',
|
|
614
|
+
* note: 'note',
|
|
615
|
+
* // You wouldn't normally set this field
|
|
616
|
+
* firstValidRound: 1000n,
|
|
617
|
+
* validityWindow: 10,
|
|
618
|
+
* extraFee: (1000).microAlgo(),
|
|
619
|
+
* staticFee: (1000).microAlgo(),
|
|
620
|
+
* // Max fee doesn't make sense with extraFee AND staticFee
|
|
621
|
+
* // already specified, but here for completeness
|
|
622
|
+
* maxFee: (3000).microAlgo(),
|
|
623
|
+
* // Signer only needed if you want to provide one,
|
|
624
|
+
* // generally you'd register it with AlgorandClient
|
|
625
|
+
* // against the sender and not need to pass it in
|
|
626
|
+
* signer: transactionSigner,
|
|
627
|
+
* maxRoundsToWaitForConfirmation: 5,
|
|
628
|
+
* suppressLog: true,
|
|
629
|
+
*})
|
|
630
|
+
* ```
|
|
394
631
|
*/
|
|
395
632
|
appCall: (params: import("./composer").CommonTransactionParams & {
|
|
633
|
+
appId: bigint;
|
|
396
634
|
onComplete?: algosdk.OnApplicationComplete | undefined;
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
635
|
+
args?: Uint8Array[] | undefined;
|
|
636
|
+
accountReferences?: string[] | undefined;
|
|
637
|
+
appReferences?: bigint[] | undefined;
|
|
638
|
+
assetReferences?: bigint[] | undefined;
|
|
639
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
640
|
+
} & {
|
|
641
|
+
onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.ClearStateOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
|
|
642
|
+
} & ExecuteParams) => Promise<SendAppTransactionResult>;
|
|
643
|
+
/**
|
|
644
|
+
* Create a smart contract via an ABI method.
|
|
645
|
+
*
|
|
646
|
+
* Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
647
|
+
*
|
|
648
|
+
* @param params The parameters for the app creation transaction
|
|
649
|
+
* @example Basic example
|
|
650
|
+
* ```typescript
|
|
651
|
+
* const method = new ABIMethod({
|
|
652
|
+
* name: 'method',
|
|
653
|
+
* args: [{ name: 'arg1', type: 'string' }],
|
|
654
|
+
* returns: { type: 'string' },
|
|
655
|
+
* })
|
|
656
|
+
* const result = await algorand.send.appCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })
|
|
657
|
+
* const createdAppId = result.appId
|
|
658
|
+
* ```
|
|
659
|
+
* @example Advanced example
|
|
660
|
+
* ```typescript
|
|
661
|
+
* const method = new ABIMethod({
|
|
662
|
+
* name: 'method',
|
|
663
|
+
* args: [{ name: 'arg1', type: 'string' }],
|
|
664
|
+
* returns: { type: 'string' },
|
|
665
|
+
* })
|
|
666
|
+
* await algorand.send.appCreate({
|
|
667
|
+
* sender: 'CREATORADDRESS',
|
|
668
|
+
* method: method,
|
|
669
|
+
* args: ["arg1_value"],
|
|
670
|
+
* approvalProgram: "TEALCODE",
|
|
671
|
+
* clearStateProgram: "TEALCODE",
|
|
672
|
+
* schema: {
|
|
673
|
+
* globalInts: 1,
|
|
674
|
+
* globalByteSlices: 2,
|
|
675
|
+
* localInts: 3,
|
|
676
|
+
* localByteSlices: 4
|
|
677
|
+
* },
|
|
678
|
+
* extraProgramPages: 1,
|
|
679
|
+
* onComplete: algosdk.OnApplicationComplete.OptInOC,
|
|
680
|
+
* args: [new Uint8Array(1, 2, 3, 4)]
|
|
681
|
+
* accountReferences: ["ACCOUNT_1"]
|
|
682
|
+
* appReferences: [123n, 1234n]
|
|
683
|
+
* assetReferences: [12345n]
|
|
684
|
+
* boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
685
|
+
* lease: 'lease',
|
|
686
|
+
* note: 'note',
|
|
687
|
+
* // You wouldn't normally set this field
|
|
688
|
+
* firstValidRound: 1000n,
|
|
689
|
+
* validityWindow: 10,
|
|
690
|
+
* extraFee: (1000).microAlgo(),
|
|
691
|
+
* staticFee: (1000).microAlgo(),
|
|
692
|
+
* // Max fee doesn't make sense with extraFee AND staticFee
|
|
693
|
+
* // already specified, but here for completeness
|
|
694
|
+
* maxFee: (3000).microAlgo(),
|
|
695
|
+
* // Signer only needed if you want to provide one,
|
|
696
|
+
* // generally you'd register it with AlgorandClient
|
|
697
|
+
* // against the sender and not need to pass it in
|
|
698
|
+
* signer: transactionSigner,
|
|
699
|
+
* maxRoundsToWaitForConfirmation: 5,
|
|
700
|
+
* suppressLog: true,
|
|
701
|
+
*})
|
|
702
|
+
* ```
|
|
703
|
+
*/
|
|
704
|
+
appCreateMethodCall: (params: {
|
|
705
|
+
lease?: string | Uint8Array | undefined;
|
|
706
|
+
note?: string | Uint8Array | undefined;
|
|
707
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
708
|
+
approvalProgram: string | Uint8Array;
|
|
709
|
+
clearStateProgram: string | Uint8Array;
|
|
400
710
|
schema?: {
|
|
401
|
-
|
|
711
|
+
globalInts: number;
|
|
402
712
|
globalByteSlices: number;
|
|
403
|
-
|
|
713
|
+
localInts: number;
|
|
404
714
|
localByteSlices: number;
|
|
405
715
|
} | undefined;
|
|
406
|
-
|
|
716
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
717
|
+
sender: string;
|
|
718
|
+
extraProgramPages?: number | undefined;
|
|
719
|
+
rekeyTo?: string | undefined;
|
|
720
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
721
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
722
|
+
validityWindow?: number | undefined;
|
|
723
|
+
firstValidRound?: bigint | undefined;
|
|
724
|
+
lastValidRound?: bigint | undefined;
|
|
725
|
+
onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
|
|
407
726
|
accountReferences?: string[] | undefined;
|
|
408
727
|
appReferences?: bigint[] | undefined;
|
|
409
728
|
assetReferences?: bigint[] | undefined;
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
729
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
730
|
+
} & {
|
|
731
|
+
method: algosdk.ABIMethod;
|
|
732
|
+
args?: (algosdk.TransactionWithSigner | algosdk.Transaction | algosdk.ABIValue | Promise<algosdk.Transaction> | import("./composer").AppMethodCall<{
|
|
733
|
+
lease?: string | Uint8Array | undefined;
|
|
734
|
+
note?: string | Uint8Array | undefined;
|
|
735
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
736
|
+
args?: Uint8Array[] | undefined;
|
|
737
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
738
|
+
sender: string;
|
|
739
|
+
rekeyTo?: string | undefined;
|
|
740
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
741
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
742
|
+
validityWindow?: number | undefined;
|
|
743
|
+
firstValidRound?: bigint | undefined;
|
|
744
|
+
lastValidRound?: bigint | undefined;
|
|
745
|
+
onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
|
|
746
|
+
accountReferences?: string[] | undefined;
|
|
747
|
+
appReferences?: bigint[] | undefined;
|
|
748
|
+
assetReferences?: bigint[] | undefined;
|
|
749
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
750
|
+
approvalProgram: string | Uint8Array;
|
|
751
|
+
clearStateProgram: string | Uint8Array;
|
|
752
|
+
schema?: {
|
|
753
|
+
globalInts: number;
|
|
754
|
+
globalByteSlices: number;
|
|
755
|
+
localInts: number;
|
|
756
|
+
localByteSlices: number;
|
|
757
|
+
} | undefined;
|
|
758
|
+
extraProgramPages?: number | undefined;
|
|
759
|
+
}> | import("./composer").AppMethodCall<{
|
|
760
|
+
sender: string;
|
|
761
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
762
|
+
rekeyTo?: string | undefined;
|
|
763
|
+
note?: string | Uint8Array | undefined;
|
|
764
|
+
lease?: string | Uint8Array | undefined;
|
|
765
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
766
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
767
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
768
|
+
validityWindow?: number | undefined;
|
|
769
|
+
firstValidRound?: bigint | undefined;
|
|
770
|
+
lastValidRound?: bigint | undefined;
|
|
771
|
+
appId: bigint;
|
|
772
|
+
onComplete?: algosdk.OnApplicationComplete.UpdateApplicationOC | undefined;
|
|
773
|
+
args?: Uint8Array[] | undefined;
|
|
774
|
+
accountReferences?: string[] | undefined;
|
|
775
|
+
appReferences?: bigint[] | undefined;
|
|
776
|
+
assetReferences?: bigint[] | undefined;
|
|
777
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
778
|
+
approvalProgram: string | Uint8Array;
|
|
779
|
+
clearStateProgram: string | Uint8Array;
|
|
780
|
+
}> | import("./composer").AppMethodCall<AppCallParams>)[] | undefined;
|
|
781
|
+
} & ExecuteParams) => Promise<SendAppCreateTransactionResult>;
|
|
413
782
|
/**
|
|
414
|
-
*
|
|
783
|
+
* Update a smart contract via an ABI method.
|
|
415
784
|
*
|
|
416
|
-
* Note: you may prefer to use `
|
|
785
|
+
* Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
786
|
+
*
|
|
787
|
+
* @param params The parameters for the app update transaction
|
|
788
|
+
* @example Basic example
|
|
789
|
+
* ```typescript
|
|
790
|
+
* const method = new ABIMethod({
|
|
791
|
+
* name: 'method',
|
|
792
|
+
* args: [{ name: 'arg1', type: 'string' }],
|
|
793
|
+
* returns: { type: 'string' },
|
|
794
|
+
* })
|
|
795
|
+
* await algorand.send.appUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] })
|
|
796
|
+
* ```
|
|
797
|
+
* @example Advanced example
|
|
798
|
+
* ```typescript
|
|
799
|
+
* const method = new ABIMethod({
|
|
800
|
+
* name: 'method',
|
|
801
|
+
* args: [{ name: 'arg1', type: 'string' }],
|
|
802
|
+
* returns: { type: 'string' },
|
|
803
|
+
* })
|
|
804
|
+
* await algorand.send.appUpdateMethodCall({
|
|
805
|
+
* sender: 'CREATORADDRESS',
|
|
806
|
+
* method: method,
|
|
807
|
+
* args: ["arg1_value"],
|
|
808
|
+
* approvalProgram: "TEALCODE",
|
|
809
|
+
* clearStateProgram: "TEALCODE",
|
|
810
|
+
* onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC,
|
|
811
|
+
* args: [new Uint8Array(1, 2, 3, 4)]
|
|
812
|
+
* accountReferences: ["ACCOUNT_1"]
|
|
813
|
+
* appReferences: [123n, 1234n]
|
|
814
|
+
* assetReferences: [12345n]
|
|
815
|
+
* boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
816
|
+
* lease: 'lease',
|
|
817
|
+
* note: 'note',
|
|
818
|
+
* // You wouldn't normally set this field
|
|
819
|
+
* firstValidRound: 1000n,
|
|
820
|
+
* validityWindow: 10,
|
|
821
|
+
* extraFee: (1000).microAlgo(),
|
|
822
|
+
* staticFee: (1000).microAlgo(),
|
|
823
|
+
* // Max fee doesn't make sense with extraFee AND staticFee
|
|
824
|
+
* // already specified, but here for completeness
|
|
825
|
+
* maxFee: (3000).microAlgo(),
|
|
826
|
+
* // Signer only needed if you want to provide one,
|
|
827
|
+
* // generally you'd register it with AlgorandClient
|
|
828
|
+
* // against the sender and not need to pass it in
|
|
829
|
+
* signer: transactionSigner,
|
|
830
|
+
* maxRoundsToWaitForConfirmation: 5,
|
|
831
|
+
* suppressLog: true,
|
|
832
|
+
*})
|
|
833
|
+
* ```
|
|
417
834
|
*/
|
|
418
|
-
|
|
835
|
+
appUpdateMethodCall: (params: {
|
|
836
|
+
lease?: string | Uint8Array | undefined;
|
|
837
|
+
note?: string | Uint8Array | undefined;
|
|
838
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
839
|
+
approvalProgram: string | Uint8Array;
|
|
840
|
+
clearStateProgram: string | Uint8Array;
|
|
419
841
|
appId: bigint;
|
|
842
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
843
|
+
sender: string;
|
|
844
|
+
rekeyTo?: string | undefined;
|
|
845
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
846
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
847
|
+
validityWindow?: number | undefined;
|
|
848
|
+
firstValidRound?: bigint | undefined;
|
|
849
|
+
lastValidRound?: bigint | undefined;
|
|
850
|
+
onComplete?: algosdk.OnApplicationComplete.UpdateApplicationOC | undefined;
|
|
851
|
+
accountReferences?: string[] | undefined;
|
|
852
|
+
appReferences?: bigint[] | undefined;
|
|
853
|
+
assetReferences?: bigint[] | undefined;
|
|
854
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
855
|
+
} & {
|
|
420
856
|
method: algosdk.ABIMethod;
|
|
421
|
-
args?: (algosdk.TransactionWithSigner | algosdk.Transaction | algosdk.ABIValue | Promise<algosdk.Transaction> | import("./composer").
|
|
422
|
-
|
|
857
|
+
args?: (algosdk.TransactionWithSigner | algosdk.Transaction | algosdk.ABIValue | Promise<algosdk.Transaction> | import("./composer").AppMethodCall<{
|
|
858
|
+
lease?: string | Uint8Array | undefined;
|
|
859
|
+
note?: string | Uint8Array | undefined;
|
|
860
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
861
|
+
args?: Uint8Array[] | undefined;
|
|
862
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
863
|
+
sender: string;
|
|
864
|
+
rekeyTo?: string | undefined;
|
|
865
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
866
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
867
|
+
validityWindow?: number | undefined;
|
|
868
|
+
firstValidRound?: bigint | undefined;
|
|
869
|
+
lastValidRound?: bigint | undefined;
|
|
870
|
+
onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
|
|
871
|
+
accountReferences?: string[] | undefined;
|
|
872
|
+
appReferences?: bigint[] | undefined;
|
|
873
|
+
assetReferences?: bigint[] | undefined;
|
|
874
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
875
|
+
approvalProgram: string | Uint8Array;
|
|
876
|
+
clearStateProgram: string | Uint8Array;
|
|
877
|
+
schema?: {
|
|
878
|
+
globalInts: number;
|
|
879
|
+
globalByteSlices: number;
|
|
880
|
+
localInts: number;
|
|
881
|
+
localByteSlices: number;
|
|
882
|
+
} | undefined;
|
|
883
|
+
extraProgramPages?: number | undefined;
|
|
884
|
+
}> | import("./composer").AppMethodCall<{
|
|
885
|
+
sender: string;
|
|
886
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
887
|
+
rekeyTo?: string | undefined;
|
|
888
|
+
note?: string | Uint8Array | undefined;
|
|
889
|
+
lease?: string | Uint8Array | undefined;
|
|
890
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
891
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
892
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
893
|
+
validityWindow?: number | undefined;
|
|
894
|
+
firstValidRound?: bigint | undefined;
|
|
895
|
+
lastValidRound?: bigint | undefined;
|
|
896
|
+
appId: bigint;
|
|
897
|
+
onComplete?: algosdk.OnApplicationComplete.UpdateApplicationOC | undefined;
|
|
898
|
+
args?: Uint8Array[] | undefined;
|
|
899
|
+
accountReferences?: string[] | undefined;
|
|
900
|
+
appReferences?: bigint[] | undefined;
|
|
901
|
+
assetReferences?: bigint[] | undefined;
|
|
902
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
903
|
+
approvalProgram: string | Uint8Array;
|
|
904
|
+
clearStateProgram: string | Uint8Array;
|
|
905
|
+
}> | import("./composer").AppMethodCall<AppCallParams>)[] | undefined;
|
|
906
|
+
} & ExecuteParams) => Promise<SendAppUpdateTransactionResult>;
|
|
907
|
+
/**
|
|
908
|
+
* Delete a smart contract via an ABI method.
|
|
909
|
+
*
|
|
910
|
+
* Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
911
|
+
*
|
|
912
|
+
* @param params The parameters for the app deletion transaction
|
|
913
|
+
* @example Basic example
|
|
914
|
+
* ```typescript
|
|
915
|
+
* const method = new ABIMethod({
|
|
916
|
+
* name: 'method',
|
|
917
|
+
* args: [{ name: 'arg1', type: 'string' }],
|
|
918
|
+
* returns: { type: 'string' },
|
|
919
|
+
* })
|
|
920
|
+
* await algorand.send.appDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })
|
|
921
|
+
* ```
|
|
922
|
+
* @example Advanced example
|
|
923
|
+
* ```typescript
|
|
924
|
+
* const method = new ABIMethod({
|
|
925
|
+
* name: 'method',
|
|
926
|
+
* args: [{ name: 'arg1', type: 'string' }],
|
|
927
|
+
* returns: { type: 'string' },
|
|
928
|
+
* })
|
|
929
|
+
* await algorand.send.appDeleteMethodCall({
|
|
930
|
+
* sender: 'CREATORADDRESS',
|
|
931
|
+
* method: method,
|
|
932
|
+
* args: ["arg1_value"],
|
|
933
|
+
* onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC,
|
|
934
|
+
* args: [new Uint8Array(1, 2, 3, 4)]
|
|
935
|
+
* accountReferences: ["ACCOUNT_1"]
|
|
936
|
+
* appReferences: [123n, 1234n]
|
|
937
|
+
* assetReferences: [12345n]
|
|
938
|
+
* boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
939
|
+
* lease: 'lease',
|
|
940
|
+
* note: 'note',
|
|
941
|
+
* // You wouldn't normally set this field
|
|
942
|
+
* firstValidRound: 1000n,
|
|
943
|
+
* validityWindow: 10,
|
|
944
|
+
* extraFee: (1000).microAlgo(),
|
|
945
|
+
* staticFee: (1000).microAlgo(),
|
|
946
|
+
* // Max fee doesn't make sense with extraFee AND staticFee
|
|
947
|
+
* // already specified, but here for completeness
|
|
948
|
+
* maxFee: (3000).microAlgo(),
|
|
949
|
+
* // Signer only needed if you want to provide one,
|
|
950
|
+
* // generally you'd register it with AlgorandClient
|
|
951
|
+
* // against the sender and not need to pass it in
|
|
952
|
+
* signer: transactionSigner,
|
|
953
|
+
* maxRoundsToWaitForConfirmation: 5,
|
|
954
|
+
* suppressLog: true,
|
|
955
|
+
*})
|
|
956
|
+
* ```
|
|
957
|
+
*/
|
|
958
|
+
appDeleteMethodCall: (params: {
|
|
959
|
+
lease?: string | Uint8Array | undefined;
|
|
960
|
+
note?: string | Uint8Array | undefined;
|
|
961
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
962
|
+
appId: bigint;
|
|
963
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
964
|
+
sender: string;
|
|
965
|
+
rekeyTo?: string | undefined;
|
|
966
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
967
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
968
|
+
validityWindow?: number | undefined;
|
|
969
|
+
firstValidRound?: bigint | undefined;
|
|
970
|
+
lastValidRound?: bigint | undefined;
|
|
971
|
+
onComplete?: algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
|
|
972
|
+
accountReferences?: string[] | undefined;
|
|
973
|
+
appReferences?: bigint[] | undefined;
|
|
974
|
+
assetReferences?: bigint[] | undefined;
|
|
975
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
976
|
+
} & {
|
|
977
|
+
method: algosdk.ABIMethod;
|
|
978
|
+
args?: (algosdk.TransactionWithSigner | algosdk.Transaction | algosdk.ABIValue | Promise<algosdk.Transaction> | import("./composer").AppMethodCall<{
|
|
979
|
+
lease?: string | Uint8Array | undefined;
|
|
980
|
+
note?: string | Uint8Array | undefined;
|
|
981
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
982
|
+
args?: Uint8Array[] | undefined;
|
|
983
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
984
|
+
sender: string;
|
|
985
|
+
rekeyTo?: string | undefined;
|
|
986
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
987
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
988
|
+
validityWindow?: number | undefined;
|
|
989
|
+
firstValidRound?: bigint | undefined;
|
|
990
|
+
lastValidRound?: bigint | undefined;
|
|
991
|
+
onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
|
|
992
|
+
accountReferences?: string[] | undefined;
|
|
993
|
+
appReferences?: bigint[] | undefined;
|
|
994
|
+
assetReferences?: bigint[] | undefined;
|
|
995
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
996
|
+
approvalProgram: string | Uint8Array;
|
|
997
|
+
clearStateProgram: string | Uint8Array;
|
|
998
|
+
schema?: {
|
|
999
|
+
globalInts: number;
|
|
1000
|
+
globalByteSlices: number;
|
|
1001
|
+
localInts: number;
|
|
1002
|
+
localByteSlices: number;
|
|
1003
|
+
} | undefined;
|
|
1004
|
+
extraProgramPages?: number | undefined;
|
|
1005
|
+
}> | import("./composer").AppMethodCall<{
|
|
1006
|
+
sender: string;
|
|
1007
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
1008
|
+
rekeyTo?: string | undefined;
|
|
1009
|
+
note?: string | Uint8Array | undefined;
|
|
1010
|
+
lease?: string | Uint8Array | undefined;
|
|
1011
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
1012
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
1013
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
1014
|
+
validityWindow?: number | undefined;
|
|
1015
|
+
firstValidRound?: bigint | undefined;
|
|
1016
|
+
lastValidRound?: bigint | undefined;
|
|
1017
|
+
appId: bigint;
|
|
1018
|
+
onComplete?: algosdk.OnApplicationComplete.UpdateApplicationOC | undefined;
|
|
1019
|
+
args?: Uint8Array[] | undefined;
|
|
1020
|
+
accountReferences?: string[] | undefined;
|
|
1021
|
+
appReferences?: bigint[] | undefined;
|
|
1022
|
+
assetReferences?: bigint[] | undefined;
|
|
1023
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
1024
|
+
approvalProgram: string | Uint8Array;
|
|
1025
|
+
clearStateProgram: string | Uint8Array;
|
|
1026
|
+
}> | import("./composer").AppMethodCall<AppCallParams>)[] | undefined;
|
|
1027
|
+
} & ExecuteParams) => Promise<SendAppTransactionResult>;
|
|
1028
|
+
/**
|
|
1029
|
+
* Call a smart contract via an ABI method.
|
|
1030
|
+
*
|
|
1031
|
+
* Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality.
|
|
1032
|
+
*
|
|
1033
|
+
* @param params The parameters for the app call transaction
|
|
1034
|
+
* @example Basic example
|
|
1035
|
+
* ```typescript
|
|
1036
|
+
* const method = new ABIMethod({
|
|
1037
|
+
* name: 'method',
|
|
1038
|
+
* args: [{ name: 'arg1', type: 'string' }],
|
|
1039
|
+
* returns: { type: 'string' },
|
|
1040
|
+
* })
|
|
1041
|
+
* await algorand.send.appCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] })
|
|
1042
|
+
* ```
|
|
1043
|
+
* @example Advanced example
|
|
1044
|
+
* ```typescript
|
|
1045
|
+
* const method = new ABIMethod({
|
|
1046
|
+
* name: 'method',
|
|
1047
|
+
* args: [{ name: 'arg1', type: 'string' }],
|
|
1048
|
+
* returns: { type: 'string' },
|
|
1049
|
+
* })
|
|
1050
|
+
* await algorand.send.appCallMethodCall({
|
|
1051
|
+
* sender: 'CREATORADDRESS',
|
|
1052
|
+
* method: method,
|
|
1053
|
+
* args: ["arg1_value"],
|
|
1054
|
+
* onComplete: algosdk.OnApplicationComplete.OptInOC,
|
|
1055
|
+
* args: [new Uint8Array(1, 2, 3, 4)]
|
|
1056
|
+
* accountReferences: ["ACCOUNT_1"]
|
|
1057
|
+
* appReferences: [123n, 1234n]
|
|
1058
|
+
* assetReferences: [12345n]
|
|
1059
|
+
* boxReferences: ["box1", {appId: 1234n, name: "box2"}]
|
|
1060
|
+
* lease: 'lease',
|
|
1061
|
+
* note: 'note',
|
|
1062
|
+
* // You wouldn't normally set this field
|
|
1063
|
+
* firstValidRound: 1000n,
|
|
1064
|
+
* validityWindow: 10,
|
|
1065
|
+
* extraFee: (1000).microAlgo(),
|
|
1066
|
+
* staticFee: (1000).microAlgo(),
|
|
1067
|
+
* // Max fee doesn't make sense with extraFee AND staticFee
|
|
1068
|
+
* // already specified, but here for completeness
|
|
1069
|
+
* maxFee: (3000).microAlgo(),
|
|
1070
|
+
* // Signer only needed if you want to provide one,
|
|
1071
|
+
* // generally you'd register it with AlgorandClient
|
|
1072
|
+
* // against the sender and not need to pass it in
|
|
1073
|
+
* signer: transactionSigner,
|
|
1074
|
+
* maxRoundsToWaitForConfirmation: 5,
|
|
1075
|
+
* suppressLog: true,
|
|
1076
|
+
*})
|
|
1077
|
+
* ```
|
|
1078
|
+
*/
|
|
1079
|
+
appCallMethodCall: (params: {
|
|
1080
|
+
lease?: string | Uint8Array | undefined;
|
|
1081
|
+
note?: string | Uint8Array | undefined;
|
|
1082
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
1083
|
+
appId: bigint;
|
|
1084
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
1085
|
+
sender: string;
|
|
1086
|
+
rekeyTo?: string | undefined;
|
|
1087
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
1088
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
1089
|
+
validityWindow?: number | undefined;
|
|
1090
|
+
firstValidRound?: bigint | undefined;
|
|
1091
|
+
lastValidRound?: bigint | undefined;
|
|
1092
|
+
onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.ClearStateOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
|
|
1093
|
+
accountReferences?: string[] | undefined;
|
|
1094
|
+
appReferences?: bigint[] | undefined;
|
|
1095
|
+
assetReferences?: bigint[] | undefined;
|
|
1096
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
1097
|
+
} & {
|
|
1098
|
+
method: algosdk.ABIMethod;
|
|
1099
|
+
args?: (algosdk.TransactionWithSigner | algosdk.Transaction | algosdk.ABIValue | Promise<algosdk.Transaction> | import("./composer").AppMethodCall<{
|
|
1100
|
+
lease?: string | Uint8Array | undefined;
|
|
1101
|
+
note?: string | Uint8Array | undefined;
|
|
1102
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
1103
|
+
args?: Uint8Array[] | undefined;
|
|
1104
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
1105
|
+
sender: string;
|
|
1106
|
+
rekeyTo?: string | undefined;
|
|
1107
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
1108
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
1109
|
+
validityWindow?: number | undefined;
|
|
1110
|
+
firstValidRound?: bigint | undefined;
|
|
1111
|
+
lastValidRound?: bigint | undefined;
|
|
1112
|
+
onComplete?: algosdk.OnApplicationComplete.NoOpOC | algosdk.OnApplicationComplete.OptInOC | algosdk.OnApplicationComplete.CloseOutOC | algosdk.OnApplicationComplete.UpdateApplicationOC | algosdk.OnApplicationComplete.DeleteApplicationOC | undefined;
|
|
1113
|
+
accountReferences?: string[] | undefined;
|
|
1114
|
+
appReferences?: bigint[] | undefined;
|
|
1115
|
+
assetReferences?: bigint[] | undefined;
|
|
1116
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
1117
|
+
approvalProgram: string | Uint8Array;
|
|
1118
|
+
clearStateProgram: string | Uint8Array;
|
|
1119
|
+
schema?: {
|
|
1120
|
+
globalInts: number;
|
|
1121
|
+
globalByteSlices: number;
|
|
1122
|
+
localInts: number;
|
|
1123
|
+
localByteSlices: number;
|
|
1124
|
+
} | undefined;
|
|
1125
|
+
extraProgramPages?: number | undefined;
|
|
1126
|
+
}> | import("./composer").AppMethodCall<{
|
|
1127
|
+
sender: string;
|
|
1128
|
+
signer?: algosdk.TransactionSigner | import("./account").TransactionSignerAccount | undefined;
|
|
1129
|
+
rekeyTo?: string | undefined;
|
|
1130
|
+
note?: string | Uint8Array | undefined;
|
|
1131
|
+
lease?: string | Uint8Array | undefined;
|
|
1132
|
+
staticFee?: import("./amount").AlgoAmount | undefined;
|
|
1133
|
+
extraFee?: import("./amount").AlgoAmount | undefined;
|
|
1134
|
+
maxFee?: import("./amount").AlgoAmount | undefined;
|
|
1135
|
+
validityWindow?: number | undefined;
|
|
1136
|
+
firstValidRound?: bigint | undefined;
|
|
1137
|
+
lastValidRound?: bigint | undefined;
|
|
1138
|
+
appId: bigint;
|
|
1139
|
+
onComplete?: algosdk.OnApplicationComplete.UpdateApplicationOC | undefined;
|
|
1140
|
+
args?: Uint8Array[] | undefined;
|
|
1141
|
+
accountReferences?: string[] | undefined;
|
|
1142
|
+
appReferences?: bigint[] | undefined;
|
|
1143
|
+
assetReferences?: bigint[] | undefined;
|
|
1144
|
+
boxReferences?: (import("./app-manager").BoxIdentifier | import("./app-manager").BoxReference)[] | undefined;
|
|
1145
|
+
approvalProgram: string | Uint8Array;
|
|
1146
|
+
clearStateProgram: string | Uint8Array;
|
|
1147
|
+
}> | import("./composer").AppMethodCall<AppCallParams>)[] | undefined;
|
|
1148
|
+
} & ExecuteParams) => Promise<SendAppTransactionResult>;
|
|
423
1149
|
/** Register an online key. */
|
|
424
1150
|
onlineKeyRegistration: (params: import("./composer").CommonTransactionParams & {
|
|
425
1151
|
voteKey: Uint8Array;
|