algosdk 3.5.2 → 3.7.0-beta.1
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/README.md +4 -4
- package/dist/browser/algosdk.min.js +1 -1
- package/dist/browser/algosdk.min.js.map +1 -1
- package/dist/cjs/appAccess.js +8 -5
- package/dist/cjs/appAccess.js.map +1 -1
- package/dist/cjs/client/v2/algod/accountApplicationsInformation.js +38 -0
- package/dist/cjs/client/v2/algod/accountApplicationsInformation.js.map +1 -0
- package/dist/cjs/client/v2/algod/accountAssetsInformation.js +31 -0
- package/dist/cjs/client/v2/algod/accountAssetsInformation.js.map +1 -0
- package/dist/cjs/client/v2/algod/algod.js +23 -19
- package/dist/cjs/client/v2/algod/algod.js.map +1 -1
- package/dist/cjs/client/v2/algod/getApplicationBoxes.js +116 -5
- package/dist/cjs/client/v2/algod/getApplicationBoxes.js.map +1 -1
- package/dist/cjs/client/v2/algod/models/types.js +243 -452
- package/dist/cjs/client/v2/algod/models/types.js.map +1 -1
- package/dist/cjs/ed25519-signer.js +76 -0
- package/dist/cjs/ed25519-signer.js.map +1 -0
- package/dist/cjs/encoding/address.js +61 -1
- package/dist/cjs/encoding/address.js.map +1 -1
- package/dist/cjs/falcon-signer.js +17 -0
- package/dist/cjs/falcon-signer.js.map +1 -0
- package/dist/cjs/logicsig.js +201 -16
- package/dist/cjs/logicsig.js.map +1 -1
- package/dist/cjs/main.js +32 -63
- package/dist/cjs/main.js.map +1 -1
- package/dist/cjs/mnemonic/mnemonic.js +26 -1
- package/dist/cjs/mnemonic/mnemonic.js.map +1 -1
- package/dist/cjs/multisigSigning.js +78 -1
- package/dist/cjs/multisigSigning.js.map +1 -1
- package/dist/cjs/pq-signer.js +54 -0
- package/dist/cjs/pq-signer.js.map +1 -0
- package/dist/cjs/signedTransaction.js +15 -1
- package/dist/cjs/signedTransaction.js.map +1 -1
- package/dist/cjs/signer.js.map +1 -1
- package/dist/cjs/signing.js +94 -7
- package/dist/cjs/signing.js.map +1 -1
- package/dist/cjs/transaction.js +9 -1
- package/dist/cjs/transaction.js.map +1 -1
- package/dist/cjs/types/transactions/encoded.js +51 -1
- package/dist/cjs/types/transactions/encoded.js.map +1 -1
- package/dist/cjs/utils/ed25519-check.js +69 -0
- package/dist/cjs/utils/ed25519-check.js.map +1 -0
- package/dist/esm/appAccess.js +8 -5
- package/dist/esm/appAccess.js.map +1 -1
- package/dist/esm/client/v2/algod/accountApplicationsInformation.js +32 -0
- package/dist/esm/client/v2/algod/accountApplicationsInformation.js.map +1 -0
- package/dist/esm/client/v2/algod/accountAssetsInformation.js +25 -0
- package/dist/esm/client/v2/algod/accountAssetsInformation.js.map +1 -0
- package/dist/esm/client/v2/algod/algod.js +23 -19
- package/dist/esm/client/v2/algod/algod.js.map +1 -1
- package/dist/esm/client/v2/algod/getApplicationBoxes.js +116 -5
- package/dist/esm/client/v2/algod/getApplicationBoxes.js.map +1 -1
- package/dist/esm/client/v2/algod/models/types.js +239 -445
- package/dist/esm/client/v2/algod/models/types.js.map +1 -1
- package/dist/esm/ed25519-signer.js +72 -0
- package/dist/esm/ed25519-signer.js.map +1 -0
- package/dist/esm/encoding/address.js +58 -0
- package/dist/esm/encoding/address.js.map +1 -1
- package/dist/esm/falcon-signer.js +13 -0
- package/dist/esm/falcon-signer.js.map +1 -0
- package/dist/esm/logicsig.js +200 -15
- package/dist/esm/logicsig.js.map +1 -1
- package/dist/esm/main.js +8 -56
- package/dist/esm/main.js.map +1 -1
- package/dist/esm/mnemonic/mnemonic.js +25 -1
- package/dist/esm/mnemonic/mnemonic.js.map +1 -1
- package/dist/esm/multisigSigning.js +75 -0
- package/dist/esm/multisigSigning.js.map +1 -1
- package/dist/esm/pq-signer.js +50 -0
- package/dist/esm/pq-signer.js.map +1 -0
- package/dist/esm/signedTransaction.js +16 -2
- package/dist/esm/signedTransaction.js.map +1 -1
- package/dist/esm/signer.js.map +1 -1
- package/dist/esm/signing.js +91 -8
- package/dist/esm/signing.js.map +1 -1
- package/dist/esm/transaction.js +9 -1
- package/dist/esm/transaction.js.map +1 -1
- package/dist/esm/types/transactions/encoded.js +49 -1
- package/dist/esm/types/transactions/encoded.js.map +1 -1
- package/dist/esm/utils/ed25519-check.js +65 -0
- package/dist/esm/utils/ed25519-check.js.map +1 -0
- package/dist/types/client/v2/algod/accountApplicationsInformation.d.ts +16 -0
- package/dist/types/client/v2/algod/accountAssetsInformation.d.ts +12 -0
- package/dist/types/client/v2/algod/algod.d.ts +19 -17
- package/dist/types/client/v2/algod/getApplicationBoxes.d.ts +100 -5
- package/dist/types/client/v2/algod/models/types.d.ts +146 -232
- package/dist/types/ed25519-signer.d.ts +7 -0
- package/dist/types/encoding/address.d.ts +37 -0
- package/dist/types/falcon-signer.d.ts +11 -0
- package/dist/types/logicsig.d.ts +72 -1
- package/dist/types/main.d.ts +8 -44
- package/dist/types/mnemonic/mnemonic.d.ts +13 -0
- package/dist/types/multisigSigning.d.ts +49 -0
- package/dist/types/pq-signer.d.ts +8 -0
- package/dist/types/signedTransaction.d.ts +7 -2
- package/dist/types/signer.d.ts +38 -0
- package/dist/types/signing.d.ts +45 -0
- package/dist/types/transaction.d.ts +9 -0
- package/dist/types/types/transactions/encoded.d.ts +27 -0
- package/dist/types/utils/ed25519-check.d.ts +10 -0
- package/package.json +2 -1
- package/src/appAccess.ts +10 -5
- package/src/client/v2/algod/accountApplicationsInformation.ts +46 -0
- package/src/client/v2/algod/accountAssetsInformation.ts +33 -0
- package/src/client/v2/algod/algod.ts +25 -20
- package/src/client/v2/algod/getApplicationBoxes.ts +123 -5
- package/src/client/v2/algod/models/types.ts +523 -846
- package/src/ed25519-signer.ts +125 -0
- package/src/encoding/address.ts +80 -0
- package/src/falcon-signer.ts +30 -0
- package/src/logicsig.ts +258 -16
- package/src/main.ts +30 -60
- package/src/mnemonic/mnemonic.ts +34 -1
- package/src/multisigSigning.ts +111 -0
- package/src/pq-signer.ts +90 -0
- package/src/signedTransaction.ts +24 -0
- package/src/signer.ts +53 -0
- package/src/signing.ts +109 -8
- package/src/transaction.ts +9 -1
- package/src/types/transactions/encoded.ts +88 -0
- package/src/utils/ed25519-check.ts +67 -0
- package/dist/cjs/client/v2/algod/dryrun.js +0 -34
- package/dist/cjs/client/v2/algod/dryrun.js.map +0 -1
- package/dist/cjs/dryrun.js +0 -214
- package/dist/cjs/dryrun.js.map +0 -1
- package/dist/esm/client/v2/algod/dryrun.js +0 -28
- package/dist/esm/client/v2/algod/dryrun.js.map +0 -1
- package/dist/esm/dryrun.js +0 -208
- package/dist/esm/dryrun.js.map +0 -1
- package/dist/types/client/v2/algod/dryrun.d.ts +0 -11
- package/dist/types/dryrun.d.ts +0 -28
- package/src/client/v2/algod/dryrun.ts +0 -38
- package/src/dryrun.ts +0 -292
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"accountAssetsInformation.js","sourceRoot":"","sources":["../../../../../src/client/v2/algod/accountAssetsInformation.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,gCAAgC,EAAE,MAAM,mBAAmB,CAAC;AAGrE,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,WAA6C;IAGjG,YAAY,CAAa,EAAE,OAAyB;QAClD,KAAK,CAAC,CAAC,CAAC,CAAC;QACT,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IACpC,CAAC;IAED,IAAI;QACF,OAAO,gBAAgB,IAAI,CAAC,OAAO,SAAS,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kDAAkD;IAClD,OAAO,CAAC,QAA4B;QAClC,OAAO,UAAU,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,gCAAgC,CAAC,CAAC;IAC9E,CAAC;CACF"}
|
|
@@ -2,10 +2,11 @@ import ServiceClient from '../serviceClient.js';
|
|
|
2
2
|
import * as modelsv2 from './models/types.js';
|
|
3
3
|
import AccountInformation from './accountInformation.js';
|
|
4
4
|
import AccountAssetInformation from './accountAssetInformation.js';
|
|
5
|
+
import AccountAssetsInformation from './accountAssetsInformation.js';
|
|
6
|
+
import AccountApplicationsInformation from './accountApplicationsInformation.js';
|
|
5
7
|
import AccountApplicationInformation from './accountApplicationInformation.js';
|
|
6
8
|
import Block from './block.js';
|
|
7
9
|
import Compile from './compile.js';
|
|
8
|
-
import Dryrun from './dryrun.js';
|
|
9
10
|
import Genesis from './genesis.js';
|
|
10
11
|
import GetAssetByID from './getAssetByID.js';
|
|
11
12
|
import GetApplicationByID from './getApplicationByID.js';
|
|
@@ -155,6 +156,24 @@ export class AlgodClient extends ServiceClient {
|
|
|
155
156
|
accountAssetInformation(account, index) {
|
|
156
157
|
return new AccountAssetInformation(this.c, account, index);
|
|
157
158
|
}
|
|
159
|
+
/**
|
|
160
|
+
* Returns the given account's asset holdings, paginated.
|
|
161
|
+
*
|
|
162
|
+
* @param account - The address of the account to look up.
|
|
163
|
+
* @category GET
|
|
164
|
+
*/
|
|
165
|
+
accountAssetsInformation(account) {
|
|
166
|
+
return new AccountAssetsInformation(this.c, account);
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* Returns the given account's application holdings, paginated.
|
|
170
|
+
*
|
|
171
|
+
* @param account - The address of the account to look up.
|
|
172
|
+
* @category GET
|
|
173
|
+
*/
|
|
174
|
+
accountApplicationsInformation(account) {
|
|
175
|
+
return new AccountApplicationsInformation(this.c, account);
|
|
176
|
+
}
|
|
158
177
|
/**
|
|
159
178
|
* Returns the given account's application information for a specific application.
|
|
160
179
|
*
|
|
@@ -400,23 +419,6 @@ export class AlgodClient extends ServiceClient {
|
|
|
400
419
|
disassemble(source) {
|
|
401
420
|
return new Disassemble(this.c, source);
|
|
402
421
|
}
|
|
403
|
-
/**
|
|
404
|
-
* Provides debugging information for a transaction (or group).
|
|
405
|
-
*
|
|
406
|
-
* Executes TEAL program(s) in context and returns debugging information about the execution. This endpoint is only enabled when a node's configureation file sets `EnableDeveloperAPI` to true.
|
|
407
|
-
*
|
|
408
|
-
* #### Example
|
|
409
|
-
* ```typescript
|
|
410
|
-
* const dryRunResult = await algodClient.dryrun(dr).do();
|
|
411
|
-
* ```
|
|
412
|
-
*
|
|
413
|
-
* [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#post-v2tealdryrun)
|
|
414
|
-
* @param dr
|
|
415
|
-
* @category POST
|
|
416
|
-
*/
|
|
417
|
-
dryrun(dr) {
|
|
418
|
-
return new Dryrun(this.c, dr);
|
|
419
|
-
}
|
|
420
422
|
/**
|
|
421
423
|
* Given an asset ID, return asset information including creator, name, total supply and
|
|
422
424
|
* special addresses.
|
|
@@ -470,7 +472,7 @@ export class AlgodClient extends ServiceClient {
|
|
|
470
472
|
return new GetApplicationBoxByName(this.c, index, boxName);
|
|
471
473
|
}
|
|
472
474
|
/**
|
|
473
|
-
* Given an application ID, return all the
|
|
475
|
+
* Given an application ID, return all the boxes associated with the app.
|
|
474
476
|
*
|
|
475
477
|
* #### Example
|
|
476
478
|
* ```typescript
|
|
@@ -478,6 +480,8 @@ export class AlgodClient extends ServiceClient {
|
|
|
478
480
|
* const boxesResponse = await algodClient.getApplicationBoxes(index).max(3).do();
|
|
479
481
|
* const boxNames = boxesResponse.boxes.map(box => box.name);
|
|
480
482
|
* ```
|
|
483
|
+
* With the `.include("values")` parameter, returns values in addition to names. Pagination is supported with `limit`. If using pagination,
|
|
484
|
+
* it is recommended to use the `.round()` parameter to ensure each page is for the same round.
|
|
481
485
|
*
|
|
482
486
|
* [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-idboxes)
|
|
483
487
|
* @param index - The application ID to look up.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"algod.js","sourceRoot":"","sources":["../../../../../src/client/v2/algod/algod.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAC9C,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AACnE,OAAO,6BAA6B,MAAM,oCAAoC,CAAC;AAC/E,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,
|
|
1
|
+
{"version":3,"file":"algod.js","sourceRoot":"","sources":["../../../../../src/client/v2/algod/algod.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AAC9C,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AACnE,OAAO,wBAAwB,MAAM,+BAA+B,CAAC;AACrE,OAAO,8BAA8B,MAAM,qCAAqC,CAAC;AACjF,OAAO,6BAA6B,MAAM,oCAAoC,CAAC;AAC/E,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AACnE,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,6BAA6B,MAAM,oCAAoC,CAAC;AAC/E,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,4BAA4B,MAAM,mCAAmC,CAAC;AAC7E,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,gBAAgB,MAAM,uBAAuB,CAAC;AACrD,OAAO,eAAe,MAAM,sBAAsB,CAAC;AACnD,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,QAAQ,MAAM,eAAe,CAAC;AAMrC,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AACnE,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AACnE,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,uBAAuB,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAC1D,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,sCAAsC,MAAM,6CAA6C,CAAC;AACjG,OAAO,mBAAmB,MAAM,0BAA0B,CAAC;AAC3D,OAAO,4CAA4C,MAAM,mDAAmD,CAAC;AAG7G;;;;;;;;;GASG;AACH,MAAM,OAAO,WAAY,SAAQ,aAAa;IAC5C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YACE,iBAIkB,EAClB,UAAkB,EAClB,IAAsB,EACtB,UAAkC,EAAE;QAEpC,KAAK,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW;QACT,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa;QACX,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,SAAoC;QACrD,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,OAAyB;QAC1C,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,uBAAuB,CAAC,OAAyB,EAAE,KAAsB;QACvE,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CAAC,OAAyB;QAChD,OAAO,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,8BAA8B,CAAC,OAAyB;QACtD,OAAO,IAAI,8BAA8B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,6BAA6B,CAC3B,OAAyB,EACzB,KAAsB;QAEtB,OAAO,IAAI,6BAA6B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAA4B;QAChC,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,WAA4B;QACvC,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,WAA4B;QACxC,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,6BAA6B,CAAC,IAAY;QACxC,OAAO,IAAI,6BAA6B,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,8BAA8B;QAC5B,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,2BAA2B,CAAC,OAAyB;QACnD,OAAO,IAAI,4BAA4B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM;QACJ,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,KAAsB;QACrC,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,oBAAoB;QAClB,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM;QACJ,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,MAA2B;QACjC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,MAA2B;QACrC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,KAAsB;QACjC,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,KAAsB;QACvC,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,uBAAuB,CAAC,KAAsB,EAAE,OAAmB;QACjE,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CAAC,KAAsB;QACxC,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO;QACL,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,CAAC,KAAsB,EAAE,IAAY;QACtD,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,KAAsB;QAC7C,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,KAAsB;QAClC,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,uBAAuB,CAAC,SAAoC;QAC1D,MAAM,UAAU,GAAwB,EAAE,CAAC;QAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;gBAC7B,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC;YACnE,CAAC;QACH,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;QACxE,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC;YAC3C,SAAS,EAAE;gBACT,IAAI,QAAQ,CAAC,+BAA+B,CAAC;oBAC3C,IAAI,EAAE,UAAU;iBACjB,CAAC;aACH;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,oBAAoB,CAAC,OAAiC;QACpD,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,MAAuB;QAC7C,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;OAUG;IACH,uBAAuB;QACrB,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,KAAsB;QACjC,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc;QACZ,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY;QACV,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK;QACH,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,sCAAsC,CAAC,EAAU;QAC/C,OAAO,IAAI,sCAAsC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,KAAsB;QACxC,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,4CAA4C,CAAC,KAAsB;QACjE,OAAO,IAAI,4CAA4C,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;CACF"}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import JSONRequest from '../jsonrequest.js';
|
|
2
2
|
import { decodeJSON } from '../../../encoding/encoding.js';
|
|
3
|
+
import { bytesToBase64 } from '../../../encoding/binarydata.js';
|
|
4
|
+
import { ensureSafeInteger } from '../../../utils/utils.js';
|
|
3
5
|
import { BoxesResponse } from './models/types.js';
|
|
4
6
|
/**
|
|
5
|
-
* Given an application ID, return all the
|
|
7
|
+
* Given an application ID, return all the boxes associated with the app.
|
|
6
8
|
*
|
|
7
9
|
* #### Example
|
|
8
10
|
* ```typescript
|
|
@@ -11,6 +13,9 @@ import { BoxesResponse } from './models/types.js';
|
|
|
11
13
|
* const boxNames = boxesResponse.boxes.map(box => box.name);
|
|
12
14
|
* ```
|
|
13
15
|
*
|
|
16
|
+
* With the `.include("values")` parameter, returns values in addition to names. Pagination is supported with `limit`. If using pagination,
|
|
17
|
+
* it is recommended to use the `.round()` parameter to ensure each page is for the same round.
|
|
18
|
+
*
|
|
14
19
|
* [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2applicationsapplication-idboxes)
|
|
15
20
|
* @param index - The application ID to look up.
|
|
16
21
|
* @category GET
|
|
@@ -28,24 +33,130 @@ export default class GetApplicationBoxes extends JSONRequest {
|
|
|
28
33
|
return `/v2/applications/${this.index}/boxes`;
|
|
29
34
|
}
|
|
30
35
|
/**
|
|
31
|
-
*
|
|
36
|
+
* @deprecated - Use `limit` instead for proper pagination with a limit.
|
|
37
|
+
*
|
|
38
|
+
* Set the max amount of boxes to return. Returns HTTP 400 if max is exceeded.
|
|
32
39
|
*
|
|
33
40
|
* #### Example
|
|
34
41
|
* ```typescript
|
|
35
42
|
* const maxResults = 20;
|
|
36
43
|
* const boxesResult = await algodClient
|
|
37
|
-
* .
|
|
38
|
-
* .
|
|
44
|
+
* .getApplicationBoxes(1234)
|
|
45
|
+
* .max(maxResults)
|
|
39
46
|
* .do();
|
|
40
47
|
* ```
|
|
41
48
|
*
|
|
42
|
-
* @param
|
|
49
|
+
* @param max - maximum number of results to return.
|
|
43
50
|
* @category query
|
|
44
51
|
*/
|
|
45
52
|
max(max) {
|
|
46
53
|
this.query.max = max;
|
|
47
54
|
return this;
|
|
48
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* Pagination token returned by the previous call.
|
|
58
|
+
*
|
|
59
|
+
* This is the value returned by a previous call to this endpoint in the
|
|
60
|
+
* `next-token` response field. Provide this token to get the next page of
|
|
61
|
+
* results. The token is the box name to use as the pagination cursor,
|
|
62
|
+
* encoded in the goal app call arg form.
|
|
63
|
+
*
|
|
64
|
+
* #### Example
|
|
65
|
+
* ```typescript
|
|
66
|
+
* const boxesResponse = await algodClient
|
|
67
|
+
* .getApplicationBoxes(1234)
|
|
68
|
+
* .limit(20)
|
|
69
|
+
* .next("b64:AAECAw==")
|
|
70
|
+
* .do();
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* @param nextToken - The next token to use for pagination.
|
|
74
|
+
* @category query
|
|
75
|
+
*/
|
|
76
|
+
next(nextToken) {
|
|
77
|
+
this.query.next = nextToken;
|
|
78
|
+
return this;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Filter box names by a prefix.
|
|
82
|
+
*
|
|
83
|
+
* #### Example
|
|
84
|
+
* ```typescript
|
|
85
|
+
* const boxesResponse = await algodClient
|
|
86
|
+
* .getApplicationBoxes(1234)
|
|
87
|
+
* .prefix(myAddr.publicKey)
|
|
88
|
+
* .do();
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
91
|
+
* @param prefix - The prefix to filter box names by
|
|
92
|
+
* @category query
|
|
93
|
+
*/
|
|
94
|
+
prefix(prefix) {
|
|
95
|
+
this.query.prefix = `b64:${bytesToBase64(prefix)}`;
|
|
96
|
+
return this;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Include additional items in the response.
|
|
100
|
+
*
|
|
101
|
+
* Use `values` to include box values.
|
|
102
|
+
*
|
|
103
|
+
* #### Example
|
|
104
|
+
* ```typescript
|
|
105
|
+
* const boxesResponse = await algodClient
|
|
106
|
+
* .getApplicationBoxes(1234)
|
|
107
|
+
* .prefix(myAddr.publicKey)
|
|
108
|
+
* .include("values")
|
|
109
|
+
* .do();
|
|
110
|
+
* ```
|
|
111
|
+
*
|
|
112
|
+
* @param include - The additional items to include in the response.
|
|
113
|
+
* @category query
|
|
114
|
+
*/
|
|
115
|
+
include(...include) {
|
|
116
|
+
this.query.include = include.join(',');
|
|
117
|
+
return this;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Limits results per page when using pagination.
|
|
121
|
+
*
|
|
122
|
+
* #### Example
|
|
123
|
+
* ```typescript
|
|
124
|
+
* const maxResults = 20;
|
|
125
|
+
* const boxesResult = await algodClient
|
|
126
|
+
* .getApplicationBoxes(1234)
|
|
127
|
+
* .limit(maxResults)
|
|
128
|
+
* .do();
|
|
129
|
+
* const { nextToken } = boxesResult
|
|
130
|
+
* ```
|
|
131
|
+
*
|
|
132
|
+
* @param limit - maximum number of results to return per page.
|
|
133
|
+
* @category query
|
|
134
|
+
*/
|
|
135
|
+
limit(limit) {
|
|
136
|
+
this.query.limit = limit;
|
|
137
|
+
return this;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Return results for the specified round.
|
|
141
|
+
*
|
|
142
|
+
* If not provided, results will be from the latest round. This parameter
|
|
143
|
+
* can be used to pin all pages of a paginated query to a consistent round.
|
|
144
|
+
*
|
|
145
|
+
* #### Example
|
|
146
|
+
* ```typescript
|
|
147
|
+
* const boxesResponse = await algodClient
|
|
148
|
+
* .getApplicationBoxes(1234)
|
|
149
|
+
* .round(12345678)
|
|
150
|
+
* .do();
|
|
151
|
+
* ```
|
|
152
|
+
*
|
|
153
|
+
* @param roundNumber - The round to query.
|
|
154
|
+
* @category query
|
|
155
|
+
*/
|
|
156
|
+
round(roundNumber) {
|
|
157
|
+
this.query.round = ensureSafeInteger(roundNumber);
|
|
158
|
+
return this;
|
|
159
|
+
}
|
|
49
160
|
// eslint-disable-next-line class-methods-use-this
|
|
50
161
|
prepare(response) {
|
|
51
162
|
return decodeJSON(response.getJSONText(), BoxesResponse);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getApplicationBoxes.js","sourceRoot":"","sources":["../../../../../src/client/v2/algod/getApplicationBoxes.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"getApplicationBoxes.js","sourceRoot":"","sources":["../../../../../src/client/v2/algod/getApplicationBoxes.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAIlD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,WAA0B;IAGzE,YAAY,CAAa,EAAE,KAAsB;QAC/C,KAAK,CAAC,CAAC,CAAC,CAAC;QACT,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3B,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,OAAO,oBAAoB,IAAI,CAAC,KAAK,QAAQ,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CAAC,GAAW;QACb,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,SAA6B;QAChC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAkB;QACvB,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,OAAO,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QACnD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,GAAG,OAAqB;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,WAA4B;QAChC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kDAAkD;IAClD,OAAO,CAAC,QAA4B;QAClC,OAAO,UAAU,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,aAAa,CAAC,CAAC;IAC3D,CAAC;CACF"}
|