Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
algosdk - npm Package Compare versions
Comparing version 1.14.0-beta.1 to 1.14.0
@@ -66,26 +66,2 @@ "use strict"; | ||
| /** | ||
| * Check is a response is JSON or not | ||
| * Inspired from superagent code | ||
| */ | ||
| function isResponseJSON(res) { | ||
| let contentType = tolowerCaseKeys(res.headers)['content-type']; | ||
| if (contentType) { | ||
| /* eslint-disable prefer-destructuring */ | ||
| contentType = contentType.split(';')[0]; | ||
| /* eslint-enable prefer-destructuring */ | ||
| } | ||
| // regex should match /json or +json | ||
| // but not /json-seq | ||
| // from https://github.com/visionmedia/superagent/blob/048cf185d954028b1dccde0717d2488b2284c297/src/client.js#L276 | ||
| return /[/+]json($|[^-\w])/i.test(contentType); | ||
| } | ||
| /** | ||
| * Check is a response is text | ||
| * Inspired from superagent code | ||
| */ | ||
| function isResponseText(res) { | ||
| const contentType = tolowerCaseKeys(res.headers)['content-type'] || 'text/plain'; | ||
| return /^\w*text\//i.test(contentType); | ||
| } | ||
| /** | ||
| * HTTPClient is a wrapper around a BaseHTTPClient | ||
@@ -108,5 +84,5 @@ * It takes care of setting the proper "Accept" header and of | ||
| * | ||
| * @param text JSON data | ||
| * @param status Status of the response (used in case parseJSON fails) | ||
| * @param jsonOptions Options object to use to decode JSON responses. See | ||
| * @param text - JSON data | ||
| * @param status - Status of the response (used in case parseJSON fails) | ||
| * @param jsonOptions - Options object to use to decode JSON responses. See | ||
| * utils.parseJSON for the options available. | ||
@@ -158,12 +134,11 @@ */ | ||
| */ | ||
| static prepareResponse(res, jsonOptions = {}) { | ||
| static prepareResponse(res, format, jsonOptions = {}) { | ||
| let { body } = res; | ||
| let text; | ||
| if (isResponseJSON(res)) { | ||
| text = (body && new TextDecoder().decode(body)) || ''; | ||
| if (format !== 'application/msgpack') { | ||
| text = (body && Buffer.from(body).toString()) || ''; | ||
| } | ||
| if (format === 'application/json') { | ||
| body = HTTPClient.parseJSON(text, res.status, jsonOptions); | ||
| } | ||
| else if (isResponseText(res)) { | ||
| text = (body && new TextDecoder().decode(body)) || ''; | ||
| } | ||
| return { | ||
@@ -185,3 +160,3 @@ ...res, | ||
| // eslint-disable-next-line no-param-reassign | ||
| err.response = HTTPClient.prepareResponse(err.response); | ||
| err.response = HTTPClient.prepareResponse(err.response, 'application/json'); | ||
| // eslint-disable-next-line no-param-reassign | ||
@@ -194,6 +169,6 @@ err.status = err.response.status; | ||
| * Send a GET request. | ||
| * @param {string} relativePath The path of the request. | ||
| * @param {object} query An object containing the query paramters of the request. | ||
| * @param {object} requestHeaders An object containing additional request headers to use. | ||
| * @param {object} jsonOptions Options object to use to decode JSON responses. See | ||
| * @param relativePath - The path of the request. | ||
| * @param query - An object containing the query parameters of the request. | ||
| * @param requestHeaders - An object containing additional request headers to use. | ||
| * @param jsonOptions - Options object to use to decode JSON responses. See | ||
| * utils.parseJSON for the options available. | ||
@@ -207,3 +182,3 @@ * @returns Response object. | ||
| const res = await this.bc.get(relativePath, removeFalsyOrEmpty(query), fullHeaders); | ||
| return HTTPClient.prepareResponse(res, jsonOptions); | ||
| return HTTPClient.prepareResponse(res, format, jsonOptions); | ||
| } | ||
@@ -226,3 +201,3 @@ catch (err) { | ||
| const res = await this.bc.post(relativePath, HTTPClient.serializeData(data, fullHeaders), undefined, fullHeaders); | ||
| return HTTPClient.prepareResponse(res); | ||
| return HTTPClient.prepareResponse(res, 'application/json'); | ||
| } | ||
@@ -244,3 +219,3 @@ catch (err) { | ||
| const res = await this.bc.delete(relativePath, HTTPClient.serializeData(data, fullHeaders), undefined, fullHeaders); | ||
| return HTTPClient.prepareResponse(res); | ||
| return HTTPClient.prepareResponse(res, 'application/json'); | ||
| } | ||
@@ -247,0 +222,0 @@ } |
@@ -21,2 +21,14 @@ "use strict"; | ||
| class LookupAccountTransactions extends jsonrequest_1.default { | ||
| /** | ||
| * Returns transactions relating to the given account. | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient.lookupAccountTransactions(address).do(); | ||
| * ``` | ||
| * | ||
| * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idtransactions) | ||
| * @param account - The address of the account. | ||
| */ | ||
| constructor(c, intDecoding, account) { | ||
@@ -27,2 +39,5 @@ super(c, intDecoding); | ||
| } | ||
| /** | ||
| * @returns /v2/accounts/`${account}`/transactions | ||
| */ | ||
| path() { | ||
@@ -32,4 +47,16 @@ return `/v2/accounts/${this.account}/transactions`; | ||
| /** | ||
| * notePrefix to filter with | ||
| * Specifies a prefix which must be contained in the note field | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const notePrefixBase64Encoded = "Y3JlYXRl"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .notePrefix(notePrefixBase64Encoded) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param prefix - base64 string or uint8array | ||
| * @category query | ||
| */ | ||
@@ -40,3 +67,17 @@ notePrefix(prefix) { | ||
| } | ||
| // txtype to filter with, as string | ||
| /** | ||
| * Type of transaction to filter with | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .txType("appl") | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param type - one of “pay”, “keyreg”, “acfg”, “axfer”, “afrz”, "appl" | ||
| * @category query | ||
| */ | ||
| txType(type) { | ||
@@ -46,3 +87,20 @@ this.query['tx-type'] = type; | ||
| } | ||
| // sigtype to filter with, as string | ||
| /** | ||
| * Type of signature to filter with | ||
| * - sig: Standard | ||
| * - msig: MultiSig | ||
| * - lsig: LogicSig | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .sigType("msig") | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param type - one of “sig”, “msig”, “lsig” | ||
| * @category query | ||
| */ | ||
| sigType(type) { | ||
@@ -52,3 +110,18 @@ this.query['sig-type'] = type; | ||
| } | ||
| // txid to filter with, as string | ||
| /** | ||
| * Lookup the specific transaction by ID | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .txid(txId) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param txid | ||
| * @category query | ||
| */ | ||
| txid(txid) { | ||
@@ -58,3 +131,18 @@ this.query.txid = txid; | ||
| } | ||
| // round to filter with, as int | ||
| /** | ||
| * Include results for the specified round | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const targetBlock = 18309917; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .round(targetBlock) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param round | ||
| * @category query | ||
| */ | ||
| round(round) { | ||
@@ -64,3 +152,18 @@ this.query.round = round; | ||
| } | ||
| // min round to filter with, as int | ||
| /** | ||
| * Include results at or after the specified min-round | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const minRound = 18309917; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .minRound(minRound) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param round | ||
| * @category query | ||
| */ | ||
| minRound(round) { | ||
@@ -70,3 +173,18 @@ this.query['min-round'] = round; | ||
| } | ||
| // max round to filter with, as int | ||
| /** | ||
| * Include results at or before the specified max-round | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const maxRound = 18309917; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .maxRound(maxRound) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param round | ||
| * @category query | ||
| */ | ||
| maxRound(round) { | ||
@@ -76,3 +194,18 @@ this.query['max-round'] = round; | ||
| } | ||
| // asset ID to filter with, as int | ||
| /** | ||
| * Asset ID to filter with | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const assetID = 163650; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .assetID(assetID) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param id | ||
| * @category query | ||
| */ | ||
| assetID(id) { | ||
@@ -82,3 +215,18 @@ this.query['asset-id'] = id; | ||
| } | ||
| // limit for filter, as int | ||
| /** | ||
| * Maximum number of results to return | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const limit = 25; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .limit(limit) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param limit | ||
| * @category query | ||
| */ | ||
| limit(limit) { | ||
@@ -88,3 +236,18 @@ this.query.limit = limit; | ||
| } | ||
| // before-time to filter with, as rfc3339 string | ||
| /** | ||
| * Include results before the given time | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const beforeTime = "2022-02-02T20:20:22.02Z"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .beforeTime(beforeTime) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param before - rfc3339 string | ||
| * @category query | ||
| */ | ||
| beforeTime(before) { | ||
@@ -94,3 +257,18 @@ this.query['before-time'] = before; | ||
| } | ||
| // after-time to filter with, as rfc3339 string | ||
| /** | ||
| * Include results after the given time | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const afterTime = "2022-10-21T00:00:11.55Z"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .afterTime(afterTime) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param after - rfc3339 string | ||
| * @category query | ||
| */ | ||
| afterTime(after) { | ||
@@ -100,3 +278,32 @@ this.query['after-time'] = after; | ||
| } | ||
| // filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units | ||
| /** | ||
| * Filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units. | ||
| * | ||
| * #### Example 1 | ||
| * ```typescript | ||
| * const minBalance = 300000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .currencyGreaterThan(minBalance - 1) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * #### Example 2 | ||
| * ```typescript | ||
| * const assetID = 163650; | ||
| * const minBalance = 300000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .assetID(assetID) | ||
| * .currencyGreaterThan(minBalance - 1) | ||
| * .do(); | ||
| * ``` | ||
| * @remarks | ||
| * If you are looking for transactions with the currency amount greater than 0, simply construct the query without `currencyGreaterThan` because it doesn't accept `-1`, and passing the `0` `currency-greater-than` value would exclude transactions with a 0 amount. | ||
| * | ||
| * @param greater | ||
| * @category query | ||
| */ | ||
| currencyGreaterThan(greater) { | ||
@@ -106,3 +313,30 @@ this.query['currency-greater-than'] = greater; | ||
| } | ||
| // filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units | ||
| /** | ||
| * Filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units | ||
| * | ||
| * #### Example 1 | ||
| * ```typescript | ||
| * const maxBalance = 500000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .currencyLessThan(maxBalance + 1) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * #### Example 2 | ||
| * ```typescript | ||
| * const assetID = 163650; | ||
| * const maxBalance = 500000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .assetID(assetID) | ||
| * .currencyLessThan(maxBalance + 1) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param lesser | ||
| * @category query | ||
| */ | ||
| currencyLessThan(lesser) { | ||
@@ -112,3 +346,20 @@ this.query['currency-less-than'] = lesser; | ||
| } | ||
| // used for pagination | ||
| /** | ||
| * The next page of results. Use the next token provided by the previous results. | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const limit = 25; | ||
| * const nextToken = "the next token returned in the previous query response"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .limit(limit) | ||
| * .nextToken(nextToken) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param nextToken | ||
| * @category query | ||
| */ | ||
| nextToken(nextToken) { | ||
@@ -118,3 +369,17 @@ this.query.next = nextToken; | ||
| } | ||
| // whether or not to include rekeying transactions | ||
| /** | ||
| * Include results which include the rekey-to field | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .rekeyTo(false) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param rekeyTo | ||
| * @category query | ||
| */ | ||
| rekeyTo(rekeyTo) { | ||
@@ -121,0 +386,0 @@ this.query['rekey-to'] = rekeyTo; |
@@ -8,2 +8,14 @@ "use strict"; | ||
| class LookupAssetByID extends jsonrequest_1.default { | ||
| /** | ||
| * Returns asset information of the queried asset. | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const assetId = 163650; | ||
| * const assetInfo = await indexerClient.lookupAssetByID(assetId).do(); | ||
| * ``` | ||
| * | ||
| * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-id) | ||
| * @param index - The asset ID to look up. | ||
| */ | ||
| constructor(c, intDecoding, index) { | ||
@@ -14,6 +26,30 @@ super(c, intDecoding); | ||
| } | ||
| /** | ||
| * @returns `/v2/assets/${index}` | ||
| */ | ||
| path() { | ||
| return `/v2/assets/${this.index}`; | ||
| } | ||
| // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates | ||
| /** | ||
| * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates | ||
| * | ||
| * #### Example 1 | ||
| * ```typescript | ||
| * const assetInfo = await indexerClient | ||
| * .lookupAssetByID(assetId) | ||
| * .includeAll(false) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * #### Example 2 | ||
| * ```typescript | ||
| * const assetInfo = await indexerClient | ||
| * .lookupAssetByID(assetId) | ||
| * .includeAll() | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param value - default true when called without passing a value | ||
| * @category query | ||
| */ | ||
| includeAll(value = true) { | ||
@@ -20,0 +56,0 @@ this.query['include-all'] = value; |
@@ -32,2 +32,3 @@ "use strict"; | ||
| * @param body - Response body received | ||
| * @category JSONRequest | ||
| */ | ||
@@ -42,2 +43,3 @@ // eslint-disable-next-line class-methods-use-this | ||
| * @returns A promise which resolves to the response data. | ||
| * @category JSONRequest | ||
| */ | ||
@@ -66,2 +68,3 @@ async do(headers = {}) { | ||
| * response for this request. Must be one of "default", "safe", "mixed", or "bigint". | ||
| * @category JSONRequest | ||
| */ | ||
@@ -68,0 +71,0 @@ setIntDecoding(method) { |
@@ -45,26 +45,2 @@ import * as utils from '../utils/utils'; | ||
| /** | ||
| * Check is a response is JSON or not | ||
| * Inspired from superagent code | ||
| */ | ||
| function isResponseJSON(res) { | ||
| let contentType = tolowerCaseKeys(res.headers)['content-type']; | ||
| if (contentType) { | ||
| /* eslint-disable prefer-destructuring */ | ||
| contentType = contentType.split(';')[0]; | ||
| /* eslint-enable prefer-destructuring */ | ||
| } | ||
| // regex should match /json or +json | ||
| // but not /json-seq | ||
| // from https://github.com/visionmedia/superagent/blob/048cf185d954028b1dccde0717d2488b2284c297/src/client.js#L276 | ||
| return /[/+]json($|[^-\w])/i.test(contentType); | ||
| } | ||
| /** | ||
| * Check is a response is text | ||
| * Inspired from superagent code | ||
| */ | ||
| function isResponseText(res) { | ||
| const contentType = tolowerCaseKeys(res.headers)['content-type'] || 'text/plain'; | ||
| return /^\w*text\//i.test(contentType); | ||
| } | ||
| /** | ||
| * HTTPClient is a wrapper around a BaseHTTPClient | ||
@@ -87,5 +63,5 @@ * It takes care of setting the proper "Accept" header and of | ||
| * | ||
| * @param text JSON data | ||
| * @param status Status of the response (used in case parseJSON fails) | ||
| * @param jsonOptions Options object to use to decode JSON responses. See | ||
| * @param text - JSON data | ||
| * @param status - Status of the response (used in case parseJSON fails) | ||
| * @param jsonOptions - Options object to use to decode JSON responses. See | ||
| * utils.parseJSON for the options available. | ||
@@ -137,12 +113,11 @@ */ | ||
| */ | ||
| static prepareResponse(res, jsonOptions = {}) { | ||
| static prepareResponse(res, format, jsonOptions = {}) { | ||
| let { body } = res; | ||
| let text; | ||
| if (isResponseJSON(res)) { | ||
| text = (body && new TextDecoder().decode(body)) || ''; | ||
| if (format !== 'application/msgpack') { | ||
| text = (body && Buffer.from(body).toString()) || ''; | ||
| } | ||
| if (format === 'application/json') { | ||
| body = HTTPClient.parseJSON(text, res.status, jsonOptions); | ||
| } | ||
| else if (isResponseText(res)) { | ||
| text = (body && new TextDecoder().decode(body)) || ''; | ||
| } | ||
| return { | ||
@@ -164,3 +139,3 @@ ...res, | ||
| // eslint-disable-next-line no-param-reassign | ||
| err.response = HTTPClient.prepareResponse(err.response); | ||
| err.response = HTTPClient.prepareResponse(err.response, 'application/json'); | ||
| // eslint-disable-next-line no-param-reassign | ||
@@ -173,6 +148,6 @@ err.status = err.response.status; | ||
| * Send a GET request. | ||
| * @param {string} relativePath The path of the request. | ||
| * @param {object} query An object containing the query paramters of the request. | ||
| * @param {object} requestHeaders An object containing additional request headers to use. | ||
| * @param {object} jsonOptions Options object to use to decode JSON responses. See | ||
| * @param relativePath - The path of the request. | ||
| * @param query - An object containing the query parameters of the request. | ||
| * @param requestHeaders - An object containing additional request headers to use. | ||
| * @param jsonOptions - Options object to use to decode JSON responses. See | ||
| * utils.parseJSON for the options available. | ||
@@ -186,3 +161,3 @@ * @returns Response object. | ||
| const res = await this.bc.get(relativePath, removeFalsyOrEmpty(query), fullHeaders); | ||
| return HTTPClient.prepareResponse(res, jsonOptions); | ||
| return HTTPClient.prepareResponse(res, format, jsonOptions); | ||
| } | ||
@@ -205,3 +180,3 @@ catch (err) { | ||
| const res = await this.bc.post(relativePath, HTTPClient.serializeData(data, fullHeaders), undefined, fullHeaders); | ||
| return HTTPClient.prepareResponse(res); | ||
| return HTTPClient.prepareResponse(res, 'application/json'); | ||
| } | ||
@@ -223,5 +198,5 @@ catch (err) { | ||
| const res = await this.bc.delete(relativePath, HTTPClient.serializeData(data, fullHeaders), undefined, fullHeaders); | ||
| return HTTPClient.prepareResponse(res); | ||
| return HTTPClient.prepareResponse(res, 'application/json'); | ||
| } | ||
| } | ||
| //# sourceMappingURL=client.js.map |
@@ -14,2 +14,14 @@ import JSONRequest from '../jsonrequest'; | ||
| export default class LookupAccountTransactions extends JSONRequest { | ||
| /** | ||
| * Returns transactions relating to the given account. | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient.lookupAccountTransactions(address).do(); | ||
| * ``` | ||
| * | ||
| * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idtransactions) | ||
| * @param account - The address of the account. | ||
| */ | ||
| constructor(c, intDecoding, account) { | ||
@@ -20,2 +32,5 @@ super(c, intDecoding); | ||
| } | ||
| /** | ||
| * @returns /v2/accounts/`${account}`/transactions | ||
| */ | ||
| path() { | ||
@@ -25,4 +40,16 @@ return `/v2/accounts/${this.account}/transactions`; | ||
| /** | ||
| * notePrefix to filter with | ||
| * Specifies a prefix which must be contained in the note field | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const notePrefixBase64Encoded = "Y3JlYXRl"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .notePrefix(notePrefixBase64Encoded) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param prefix - base64 string or uint8array | ||
| * @category query | ||
| */ | ||
@@ -33,3 +60,17 @@ notePrefix(prefix) { | ||
| } | ||
| // txtype to filter with, as string | ||
| /** | ||
| * Type of transaction to filter with | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .txType("appl") | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param type - one of “pay”, “keyreg”, “acfg”, “axfer”, “afrz”, "appl" | ||
| * @category query | ||
| */ | ||
| txType(type) { | ||
@@ -39,3 +80,20 @@ this.query['tx-type'] = type; | ||
| } | ||
| // sigtype to filter with, as string | ||
| /** | ||
| * Type of signature to filter with | ||
| * - sig: Standard | ||
| * - msig: MultiSig | ||
| * - lsig: LogicSig | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .sigType("msig") | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param type - one of “sig”, “msig”, “lsig” | ||
| * @category query | ||
| */ | ||
| sigType(type) { | ||
@@ -45,3 +103,18 @@ this.query['sig-type'] = type; | ||
| } | ||
| // txid to filter with, as string | ||
| /** | ||
| * Lookup the specific transaction by ID | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .txid(txId) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param txid | ||
| * @category query | ||
| */ | ||
| txid(txid) { | ||
@@ -51,3 +124,18 @@ this.query.txid = txid; | ||
| } | ||
| // round to filter with, as int | ||
| /** | ||
| * Include results for the specified round | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const targetBlock = 18309917; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .round(targetBlock) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param round | ||
| * @category query | ||
| */ | ||
| round(round) { | ||
@@ -57,3 +145,18 @@ this.query.round = round; | ||
| } | ||
| // min round to filter with, as int | ||
| /** | ||
| * Include results at or after the specified min-round | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const minRound = 18309917; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .minRound(minRound) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param round | ||
| * @category query | ||
| */ | ||
| minRound(round) { | ||
@@ -63,3 +166,18 @@ this.query['min-round'] = round; | ||
| } | ||
| // max round to filter with, as int | ||
| /** | ||
| * Include results at or before the specified max-round | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const maxRound = 18309917; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .maxRound(maxRound) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param round | ||
| * @category query | ||
| */ | ||
| maxRound(round) { | ||
@@ -69,3 +187,18 @@ this.query['max-round'] = round; | ||
| } | ||
| // asset ID to filter with, as int | ||
| /** | ||
| * Asset ID to filter with | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const assetID = 163650; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .assetID(assetID) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param id | ||
| * @category query | ||
| */ | ||
| assetID(id) { | ||
@@ -75,3 +208,18 @@ this.query['asset-id'] = id; | ||
| } | ||
| // limit for filter, as int | ||
| /** | ||
| * Maximum number of results to return | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const limit = 25; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .limit(limit) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param limit | ||
| * @category query | ||
| */ | ||
| limit(limit) { | ||
@@ -81,3 +229,18 @@ this.query.limit = limit; | ||
| } | ||
| // before-time to filter with, as rfc3339 string | ||
| /** | ||
| * Include results before the given time | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const beforeTime = "2022-02-02T20:20:22.02Z"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .beforeTime(beforeTime) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param before - rfc3339 string | ||
| * @category query | ||
| */ | ||
| beforeTime(before) { | ||
@@ -87,3 +250,18 @@ this.query['before-time'] = before; | ||
| } | ||
| // after-time to filter with, as rfc3339 string | ||
| /** | ||
| * Include results after the given time | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const afterTime = "2022-10-21T00:00:11.55Z"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .afterTime(afterTime) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param after - rfc3339 string | ||
| * @category query | ||
| */ | ||
| afterTime(after) { | ||
@@ -93,3 +271,32 @@ this.query['after-time'] = after; | ||
| } | ||
| // filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units | ||
| /** | ||
| * Filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units. | ||
| * | ||
| * #### Example 1 | ||
| * ```typescript | ||
| * const minBalance = 300000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .currencyGreaterThan(minBalance - 1) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * #### Example 2 | ||
| * ```typescript | ||
| * const assetID = 163650; | ||
| * const minBalance = 300000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .assetID(assetID) | ||
| * .currencyGreaterThan(minBalance - 1) | ||
| * .do(); | ||
| * ``` | ||
| * @remarks | ||
| * If you are looking for transactions with the currency amount greater than 0, simply construct the query without `currencyGreaterThan` because it doesn't accept `-1`, and passing the `0` `currency-greater-than` value would exclude transactions with a 0 amount. | ||
| * | ||
| * @param greater | ||
| * @category query | ||
| */ | ||
| currencyGreaterThan(greater) { | ||
@@ -99,3 +306,30 @@ this.query['currency-greater-than'] = greater; | ||
| } | ||
| // filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units | ||
| /** | ||
| * Filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units | ||
| * | ||
| * #### Example 1 | ||
| * ```typescript | ||
| * const maxBalance = 500000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .currencyLessThan(maxBalance + 1) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * #### Example 2 | ||
| * ```typescript | ||
| * const assetID = 163650; | ||
| * const maxBalance = 500000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .assetID(assetID) | ||
| * .currencyLessThan(maxBalance + 1) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param lesser | ||
| * @category query | ||
| */ | ||
| currencyLessThan(lesser) { | ||
@@ -105,3 +339,20 @@ this.query['currency-less-than'] = lesser; | ||
| } | ||
| // used for pagination | ||
| /** | ||
| * The next page of results. Use the next token provided by the previous results. | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const limit = 25; | ||
| * const nextToken = "the next token returned in the previous query response"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .limit(limit) | ||
| * .nextToken(nextToken) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param nextToken | ||
| * @category query | ||
| */ | ||
| nextToken(nextToken) { | ||
@@ -111,3 +362,17 @@ this.query.next = nextToken; | ||
| } | ||
| // whether or not to include rekeying transactions | ||
| /** | ||
| * Include results which include the rekey-to field | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .rekeyTo(false) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param rekeyTo | ||
| * @category query | ||
| */ | ||
| rekeyTo(rekeyTo) { | ||
@@ -114,0 +379,0 @@ this.query['rekey-to'] = rekeyTo; |
| import JSONRequest from '../jsonrequest'; | ||
| export default class LookupAssetByID extends JSONRequest { | ||
| /** | ||
| * Returns asset information of the queried asset. | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const assetId = 163650; | ||
| * const assetInfo = await indexerClient.lookupAssetByID(assetId).do(); | ||
| * ``` | ||
| * | ||
| * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-id) | ||
| * @param index - The asset ID to look up. | ||
| */ | ||
| constructor(c, intDecoding, index) { | ||
@@ -8,6 +20,30 @@ super(c, intDecoding); | ||
| } | ||
| /** | ||
| * @returns `/v2/assets/${index}` | ||
| */ | ||
| path() { | ||
| return `/v2/assets/${this.index}`; | ||
| } | ||
| // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates | ||
| /** | ||
| * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates | ||
| * | ||
| * #### Example 1 | ||
| * ```typescript | ||
| * const assetInfo = await indexerClient | ||
| * .lookupAssetByID(assetId) | ||
| * .includeAll(false) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * #### Example 2 | ||
| * ```typescript | ||
| * const assetInfo = await indexerClient | ||
| * .lookupAssetByID(assetId) | ||
| * .includeAll() | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param value - default true when called without passing a value | ||
| * @category query | ||
| */ | ||
| includeAll(value = true) { | ||
@@ -14,0 +50,0 @@ this.query['include-all'] = value; |
@@ -27,2 +27,3 @@ import IntDecoding from '../../types/intDecoding'; | ||
| * @param body - Response body received | ||
| * @category JSONRequest | ||
| */ | ||
@@ -37,2 +38,3 @@ // eslint-disable-next-line class-methods-use-this | ||
| * @returns A promise which resolves to the response data. | ||
| * @category JSONRequest | ||
| */ | ||
@@ -61,2 +63,3 @@ async do(headers = {}) { | ||
| * response for this request. Must be one of "default", "safe", "mixed", or "bigint". | ||
| * @category JSONRequest | ||
| */ | ||
@@ -63,0 +66,0 @@ setIntDecoding(method) { |
@@ -31,5 +31,5 @@ import * as utils from '../utils/utils'; | ||
| * | ||
| * @param text JSON data | ||
| * @param status Status of the response (used in case parseJSON fails) | ||
| * @param jsonOptions Options object to use to decode JSON responses. See | ||
| * @param text - JSON data | ||
| * @param status - Status of the response (used in case parseJSON fails) | ||
| * @param jsonOptions - Options object to use to decode JSON responses. See | ||
| * utils.parseJSON for the options available. | ||
@@ -62,6 +62,6 @@ */ | ||
| * Send a GET request. | ||
| * @param {string} relativePath The path of the request. | ||
| * @param {object} query An object containing the query paramters of the request. | ||
| * @param {object} requestHeaders An object containing additional request headers to use. | ||
| * @param {object} jsonOptions Options object to use to decode JSON responses. See | ||
| * @param relativePath - The path of the request. | ||
| * @param query - An object containing the query parameters of the request. | ||
| * @param requestHeaders - An object containing additional request headers to use. | ||
| * @param jsonOptions - Options object to use to decode JSON responses. See | ||
| * utils.parseJSON for the options available. | ||
@@ -68,0 +68,0 @@ * @returns Response object. |
@@ -12,23 +12,302 @@ import JSONRequest from '../jsonrequest'; | ||
| private account; | ||
| /** | ||
| * Returns transactions relating to the given account. | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient.lookupAccountTransactions(address).do(); | ||
| * ``` | ||
| * | ||
| * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idtransactions) | ||
| * @param account - The address of the account. | ||
| */ | ||
| constructor(c: HTTPClient, intDecoding: IntDecoding, account: string); | ||
| /** | ||
| * @returns /v2/accounts/`${account}`/transactions | ||
| */ | ||
| path(): string; | ||
| /** | ||
| * notePrefix to filter with | ||
| * Specifies a prefix which must be contained in the note field | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const notePrefixBase64Encoded = "Y3JlYXRl"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .notePrefix(notePrefixBase64Encoded) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param prefix - base64 string or uint8array | ||
| * @category query | ||
| */ | ||
| notePrefix(prefix: Uint8Array | string): this; | ||
| /** | ||
| * Type of transaction to filter with | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .txType("appl") | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param type - one of “pay”, “keyreg”, “acfg”, “axfer”, “afrz”, "appl" | ||
| * @category query | ||
| */ | ||
| txType(type: string): this; | ||
| /** | ||
| * Type of signature to filter with | ||
| * - sig: Standard | ||
| * - msig: MultiSig | ||
| * - lsig: LogicSig | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .sigType("msig") | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param type - one of “sig”, “msig”, “lsig” | ||
| * @category query | ||
| */ | ||
| sigType(type: string): this; | ||
| /** | ||
| * Lookup the specific transaction by ID | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .txid(txId) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param txid | ||
| * @category query | ||
| */ | ||
| txid(txid: string): this; | ||
| /** | ||
| * Include results for the specified round | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const targetBlock = 18309917; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .round(targetBlock) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param round | ||
| * @category query | ||
| */ | ||
| round(round: number): this; | ||
| /** | ||
| * Include results at or after the specified min-round | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const minRound = 18309917; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .minRound(minRound) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param round | ||
| * @category query | ||
| */ | ||
| minRound(round: number): this; | ||
| /** | ||
| * Include results at or before the specified max-round | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const maxRound = 18309917; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .maxRound(maxRound) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param round | ||
| * @category query | ||
| */ | ||
| maxRound(round: number): this; | ||
| /** | ||
| * Asset ID to filter with | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const assetID = 163650; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .assetID(assetID) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param id | ||
| * @category query | ||
| */ | ||
| assetID(id: number): this; | ||
| /** | ||
| * Maximum number of results to return | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const limit = 25; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .limit(limit) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param limit | ||
| * @category query | ||
| */ | ||
| limit(limit: number): this; | ||
| /** | ||
| * Include results before the given time | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const beforeTime = "2022-02-02T20:20:22.02Z"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .beforeTime(beforeTime) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param before - rfc3339 string | ||
| * @category query | ||
| */ | ||
| beforeTime(before: string): this; | ||
| /** | ||
| * Include results after the given time | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const afterTime = "2022-10-21T00:00:11.55Z"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .afterTime(afterTime) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param after - rfc3339 string | ||
| * @category query | ||
| */ | ||
| afterTime(after: string): this; | ||
| /** | ||
| * Filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units. | ||
| * | ||
| * #### Example 1 | ||
| * ```typescript | ||
| * const minBalance = 300000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .currencyGreaterThan(minBalance - 1) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * #### Example 2 | ||
| * ```typescript | ||
| * const assetID = 163650; | ||
| * const minBalance = 300000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .assetID(assetID) | ||
| * .currencyGreaterThan(minBalance - 1) | ||
| * .do(); | ||
| * ``` | ||
| * @remarks | ||
| * If you are looking for transactions with the currency amount greater than 0, simply construct the query without `currencyGreaterThan` because it doesn't accept `-1`, and passing the `0` `currency-greater-than` value would exclude transactions with a 0 amount. | ||
| * | ||
| * @param greater | ||
| * @category query | ||
| */ | ||
| currencyGreaterThan(greater: number): this; | ||
| /** | ||
| * Filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units | ||
| * | ||
| * #### Example 1 | ||
| * ```typescript | ||
| * const maxBalance = 500000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .currencyLessThan(maxBalance + 1) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * #### Example 2 | ||
| * ```typescript | ||
| * const assetID = 163650; | ||
| * const maxBalance = 500000; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .assetID(assetID) | ||
| * .currencyLessThan(maxBalance + 1) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param lesser | ||
| * @category query | ||
| */ | ||
| currencyLessThan(lesser: number): this; | ||
| /** | ||
| * The next page of results. Use the next token provided by the previous results. | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const limit = 25; | ||
| * const nextToken = "the next token returned in the previous query response"; | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .limit(limit) | ||
| * .nextToken(nextToken) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param nextToken | ||
| * @category query | ||
| */ | ||
| nextToken(nextToken: string): this; | ||
| /** | ||
| * Include results which include the rekey-to field | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; | ||
| * const accountTxns = await indexerClient | ||
| * .lookupAccountTransactions(address) | ||
| * .rekeyTo(false) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param rekeyTo | ||
| * @category query | ||
| */ | ||
| rekeyTo(rekeyTo: boolean): this; | ||
| } |
@@ -6,5 +6,42 @@ import JSONRequest from '../jsonrequest'; | ||
| private index; | ||
| /** | ||
| * Returns asset information of the queried asset. | ||
| * | ||
| * #### Example | ||
| * ```typescript | ||
| * const assetId = 163650; | ||
| * const assetInfo = await indexerClient.lookupAssetByID(assetId).do(); | ||
| * ``` | ||
| * | ||
| * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-id) | ||
| * @param index - The asset ID to look up. | ||
| */ | ||
| constructor(c: HTTPClient, intDecoding: IntDecoding, index: number); | ||
| /** | ||
| * @returns `/v2/assets/${index}` | ||
| */ | ||
| path(): string; | ||
| /** | ||
| * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates | ||
| * | ||
| * #### Example 1 | ||
| * ```typescript | ||
| * const assetInfo = await indexerClient | ||
| * .lookupAssetByID(assetId) | ||
| * .includeAll(false) | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * #### Example 2 | ||
| * ```typescript | ||
| * const assetInfo = await indexerClient | ||
| * .lookupAssetByID(assetId) | ||
| * .includeAll() | ||
| * .do(); | ||
| * ``` | ||
| * | ||
| * @param value - default true when called without passing a value | ||
| * @category query | ||
| */ | ||
| includeAll(value?: boolean): this; | ||
| } |
@@ -23,2 +23,3 @@ import HTTPClient from '../client'; | ||
| * @returns The path of this request. | ||
| * @category JSONRequest | ||
| */ | ||
@@ -32,2 +33,3 @@ abstract path(): string; | ||
| * @param body - Response body received | ||
| * @category JSONRequest | ||
| */ | ||
@@ -39,2 +41,3 @@ prepare(body: Body): Data; | ||
| * @returns A promise which resolves to the response data. | ||
| * @category JSONRequest | ||
| */ | ||
@@ -56,4 +59,5 @@ do(headers?: Record<string, any>): Promise<Data>; | ||
| * response for this request. Must be one of "default", "safe", "mixed", or "bigint". | ||
| * @category JSONRequest | ||
| */ | ||
| setIntDecoding(method: IntDecoding): this; | ||
| } |
| import * as txnBuilder from './transaction'; | ||
| import { PaymentTxn, KeyRegistrationTxn, MustHaveSuggestedParams, MustHaveSuggestedParamsInline, AssetCreateTxn, AssetConfigTxn, AssetDestroyTxn, AssetFreezeTxn, AssetTransferTxn, AppCreateTxn, AppUpdateTxn, AppDeleteTxn, AppOptInTxn, AppCloseOutTxn, AppClearStateTxn, AppNoOpTxn } from './types/transactions'; | ||
| import { RenameProperties, RenameProperty } from './types/utils'; | ||
| import { RenameProperties, RenameProperty, Expand } from './types/utils'; | ||
| /** | ||
@@ -39,3 +39,3 @@ * makePaymentTxnWithSuggestedParams takes payment arguments and returns a Transaction object | ||
| export declare function makePaymentTxn(from: PaymentTxn['from'], to: PaymentTxn['to'], fee: MustHaveSuggestedParamsInline<PaymentTxn>['fee'], amount: PaymentTxn['amount'], closeRemainderTo: PaymentTxn['closeRemainderTo'], firstRound: MustHaveSuggestedParamsInline<PaymentTxn>['firstRound'], lastRound: MustHaveSuggestedParamsInline<PaymentTxn>['lastRound'], note: PaymentTxn['note'], genesisHash: MustHaveSuggestedParamsInline<PaymentTxn>['genesisHash'], genesisID: MustHaveSuggestedParamsInline<PaymentTxn>['genesisID'], rekeyTo?: PaymentTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makePaymentTxnWithSuggestedParamsFromObject(o: Pick<RenameProperty<MustHaveSuggestedParams<PaymentTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'to' | 'amount' | 'closeRemainderTo' | 'note' | 'suggestedParams' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| export declare function makePaymentTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperty<MustHaveSuggestedParams<PaymentTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'to' | 'amount' | 'closeRemainderTo' | 'note' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| /** | ||
@@ -92,8 +92,8 @@ * makeKeyRegistrationTxnWithSuggestedParams takes key registration arguments and returns a Transaction object for | ||
| export declare function makeKeyRegistrationTxn(from: KeyRegistrationTxn['from'], fee: MustHaveSuggestedParamsInline<KeyRegistrationTxn>['fee'], firstRound: MustHaveSuggestedParamsInline<KeyRegistrationTxn>['firstRound'], lastRound: MustHaveSuggestedParamsInline<KeyRegistrationTxn>['lastRound'], note: KeyRegistrationTxn['note'], genesisHash: MustHaveSuggestedParamsInline<KeyRegistrationTxn>['genesisHash'], genesisID: MustHaveSuggestedParamsInline<KeyRegistrationTxn>['genesisID'], voteKey: undefined, selectionKey: undefined, voteFirst: undefined, voteLast: undefined, voteKeyDilution: undefined, rekeyTo?: KeyRegistrationTxn['reKeyTo'], nonParticipation?: true, stateProofKey?: undefined): txnBuilder.Transaction; | ||
| export declare function makeKeyRegistrationTxnWithSuggestedParamsFromObject(o: Pick<RenameProperty<MustHaveSuggestedParams<KeyRegistrationTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'voteKey' | 'selectionKey' | 'stateProofKey' | 'voteFirst' | 'voteLast' | 'voteKeyDilution' | 'suggestedParams' | 'rekeyTo'> & { | ||
| export declare function makeKeyRegistrationTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperty<MustHaveSuggestedParams<KeyRegistrationTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'voteKey' | 'selectionKey' | 'stateProofKey' | 'voteFirst' | 'voteLast' | 'voteKeyDilution' | 'suggestedParams' | 'rekeyTo'> & { | ||
| nonParticipation?: false; | ||
| }): txnBuilder.Transaction; | ||
| export declare function makeKeyRegistrationTxnWithSuggestedParamsFromObject(o: Pick<RenameProperty<MustHaveSuggestedParams<KeyRegistrationTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'suggestedParams' | 'rekeyTo'> & { | ||
| }>): txnBuilder.Transaction; | ||
| export declare function makeKeyRegistrationTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperty<MustHaveSuggestedParams<KeyRegistrationTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'suggestedParams' | 'rekeyTo'> & { | ||
| nonParticipation: true; | ||
| }): txnBuilder.Transaction; | ||
| }>): txnBuilder.Transaction; | ||
| /** makeAssetCreateTxnWithSuggestedParams takes asset creation arguments and returns a Transaction object | ||
@@ -152,3 +152,3 @@ * for creating that asset | ||
| export declare function makeAssetCreateTxn(from: AssetCreateTxn['from'], fee: MustHaveSuggestedParamsInline<AssetCreateTxn>['fee'], firstRound: MustHaveSuggestedParamsInline<AssetCreateTxn>['firstRound'], lastRound: MustHaveSuggestedParamsInline<AssetCreateTxn>['lastRound'], note: AssetCreateTxn['note'], genesisHash: MustHaveSuggestedParamsInline<AssetCreateTxn>['genesisHash'], genesisID: MustHaveSuggestedParamsInline<AssetCreateTxn>['genesisID'], total: AssetCreateTxn['assetTotal'], decimals: AssetCreateTxn['assetDecimals'], defaultFrozen: AssetCreateTxn['assetDefaultFrozen'], manager: AssetCreateTxn['assetManager'], reserve: AssetCreateTxn['assetManager'], freeze: AssetCreateTxn['assetFreeze'], clawback: AssetCreateTxn['assetClawback'], unitName: AssetCreateTxn['assetUnitName'], assetName: AssetCreateTxn['assetName'], assetURL: AssetCreateTxn['assetURL'], assetMetadataHash?: AssetCreateTxn['assetMetadataHash'], rekeyTo?: AssetCreateTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeAssetCreateTxnWithSuggestedParamsFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AssetCreateTxn>, { | ||
| export declare function makeAssetCreateTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetCreateTxn>, { | ||
| reKeyTo: 'rekeyTo'; | ||
@@ -163,3 +163,3 @@ assetTotal: 'total'; | ||
| assetUnitName: 'unitName'; | ||
| }>, 'from' | 'note' | 'total' | 'decimals' | 'defaultFrozen' | 'manager' | 'reserve' | 'freeze' | 'clawback' | 'unitName' | 'assetName' | 'assetURL' | 'assetMetadataHash' | 'suggestedParams' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| }>, 'from' | 'note' | 'total' | 'decimals' | 'defaultFrozen' | 'manager' | 'reserve' | 'freeze' | 'clawback' | 'unitName' | 'assetName' | 'assetURL' | 'assetMetadataHash' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| /** makeAssetConfigTxnWithSuggestedParams can be issued by the asset manager to change the manager, reserve, freeze, or clawback | ||
@@ -210,3 +210,3 @@ * you must respecify existing addresses to keep them the same; leaving a field blank is the same as turning | ||
| export declare function makeAssetConfigTxn(from: AssetConfigTxn['from'], fee: MustHaveSuggestedParamsInline<AssetConfigTxn>['fee'], firstRound: MustHaveSuggestedParamsInline<AssetConfigTxn>['firstRound'], lastRound: MustHaveSuggestedParamsInline<AssetConfigTxn>['lastRound'], note: AssetConfigTxn['note'], genesisHash: MustHaveSuggestedParamsInline<AssetConfigTxn>['genesisHash'], genesisID: MustHaveSuggestedParamsInline<AssetConfigTxn>['genesisID'], assetIndex: AssetConfigTxn['assetIndex'], manager: AssetConfigTxn['assetManager'], reserve: AssetConfigTxn['assetReserve'], freeze: AssetConfigTxn['assetFreeze'], clawback: AssetConfigTxn['assetClawback'], strictEmptyAddressChecking?: boolean, rekeyTo?: AssetConfigTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeAssetConfigTxnWithSuggestedParamsFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AssetConfigTxn>, { | ||
| export declare function makeAssetConfigTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetConfigTxn>, { | ||
| reKeyTo: 'rekeyTo'; | ||
@@ -219,3 +219,3 @@ assetManager: 'manager'; | ||
| strictEmptyAddressChecking: boolean; | ||
| }): txnBuilder.Transaction; | ||
| }>): txnBuilder.Transaction; | ||
| /** makeAssetDestroyTxnWithSuggestedParams will allow the asset's manager to remove this asset from the ledger, so long | ||
@@ -254,3 +254,3 @@ * as all outstanding assets are held by the creator. | ||
| export declare function makeAssetDestroyTxn(from: AssetDestroyTxn['from'], fee: MustHaveSuggestedParamsInline<AssetDestroyTxn>['fee'], firstRound: MustHaveSuggestedParamsInline<AssetDestroyTxn>['firstRound'], lastRound: MustHaveSuggestedParamsInline<AssetDestroyTxn>['lastRound'], note: AssetDestroyTxn['note'], genesisHash: MustHaveSuggestedParamsInline<AssetDestroyTxn>['genesisHash'], genesisID: MustHaveSuggestedParamsInline<AssetDestroyTxn>['genesisID'], assetIndex: AssetDestroyTxn['assetIndex'], rekeyTo?: AssetDestroyTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeAssetDestroyTxnWithSuggestedParamsFromObject(o: Pick<RenameProperty<MustHaveSuggestedParams<AssetDestroyTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'assetIndex' | 'suggestedParams' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| export declare function makeAssetDestroyTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperty<MustHaveSuggestedParams<AssetDestroyTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'assetIndex' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| /** makeAssetFreezeTxnWithSuggestedParams will allow the asset's freeze manager to freeze or un-freeze an account, | ||
@@ -293,6 +293,6 @@ * blocking or allowing asset transfers to and from the targeted account. | ||
| export declare function makeAssetFreezeTxn(from: AssetFreezeTxn['from'], fee: MustHaveSuggestedParamsInline<AssetFreezeTxn>['fee'], firstRound: MustHaveSuggestedParamsInline<AssetFreezeTxn>['firstRound'], lastRound: MustHaveSuggestedParamsInline<AssetFreezeTxn>['lastRound'], note: MustHaveSuggestedParamsInline<AssetFreezeTxn>['note'], genesisHash: MustHaveSuggestedParamsInline<AssetFreezeTxn>['genesisHash'], genesisID: MustHaveSuggestedParamsInline<AssetFreezeTxn>['genesisID'], assetIndex: AssetFreezeTxn['assetIndex'], freezeTarget: AssetFreezeTxn['freezeAccount'], freezeState: AssetFreezeTxn['freezeState'], rekeyTo?: AssetFreezeTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeAssetFreezeTxnWithSuggestedParamsFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AssetFreezeTxn>, { | ||
| export declare function makeAssetFreezeTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetFreezeTxn>, { | ||
| freezeAccount: 'freezeTarget'; | ||
| reKeyTo: 'rekeyTo'; | ||
| }>, 'from' | 'note' | 'assetIndex' | 'freezeTarget' | 'freezeState' | 'suggestedParams' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| }>, 'from' | 'note' | 'assetIndex' | 'freezeTarget' | 'freezeState' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| /** makeAssetTransferTxnWithSuggestedParams allows for the creation of an asset transfer transaction. | ||
@@ -345,6 +345,6 @@ * Special case: to begin accepting assets, set amount=0 and from=to. | ||
| export declare function makeAssetTransferTxn(from: AssetTransferTxn['from'], to: AssetTransferTxn['to'], closeRemainderTo: AssetTransferTxn['closeRemainderTo'], revocationTarget: AssetTransferTxn['assetRevocationTarget'], fee: MustHaveSuggestedParamsInline<AssetTransferTxn>['fee'], amount: AssetTransferTxn['amount'], firstRound: MustHaveSuggestedParamsInline<AssetTransferTxn>['firstRound'], lastRound: MustHaveSuggestedParamsInline<AssetTransferTxn>['lastRound'], note: AssetTransferTxn['note'], genesisHash: MustHaveSuggestedParamsInline<AssetTransferTxn>['genesisHash'], genesisID: MustHaveSuggestedParamsInline<AssetTransferTxn>['genesisID'], assetIndex: AssetTransferTxn['assetIndex'], rekeyTo?: AssetTransferTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeAssetTransferTxnWithSuggestedParamsFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AssetTransferTxn>, { | ||
| export declare function makeAssetTransferTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetTransferTxn>, { | ||
| assetRevocationTarget: 'revocationTarget'; | ||
| reKeyTo: 'rekeyTo'; | ||
| }>, 'from' | 'to' | 'closeRemainderTo' | 'revocationTarget' | 'amount' | 'note' | 'assetIndex' | 'suggestedParams' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| }>, 'from' | 'to' | 'closeRemainderTo' | 'revocationTarget' | 'amount' | 'note' | 'assetIndex' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| /** | ||
@@ -378,3 +378,3 @@ * Make a transaction that will create an application. | ||
| export declare function makeApplicationCreateTxn(from: AppCreateTxn['from'], suggestedParams: MustHaveSuggestedParams<AppCreateTxn>['suggestedParams'], onComplete: AppCreateTxn['appOnComplete'], approvalProgram: AppCreateTxn['appApprovalProgram'], clearProgram: AppCreateTxn['appClearProgram'], numLocalInts: AppCreateTxn['appLocalInts'], numLocalByteSlices: AppCreateTxn['appLocalByteSlices'], numGlobalInts: AppCreateTxn['appGlobalInts'], numGlobalByteSlices: AppCreateTxn['appGlobalByteSlices'], appArgs?: AppCreateTxn['appArgs'], accounts?: AppCreateTxn['appAccounts'], foreignApps?: AppCreateTxn['appForeignApps'], foreignAssets?: AppCreateTxn['appForeignAssets'], note?: AppCreateTxn['note'], lease?: AppCreateTxn['lease'], rekeyTo?: AppCreateTxn['reKeyTo'], extraPages?: AppCreateTxn['extraPages']): txnBuilder.Transaction; | ||
| export declare function makeApplicationCreateTxnFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AppCreateTxn>, { | ||
| export declare function makeApplicationCreateTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppCreateTxn>, { | ||
| appOnComplete: 'onComplete'; | ||
@@ -391,3 +391,3 @@ appApprovalProgram: 'approvalProgram'; | ||
| reKeyTo: 'rekeyTo'; | ||
| }>, 'from' | 'suggestedParams' | 'onComplete' | 'approvalProgram' | 'clearProgram' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo' | 'extraPages'>): txnBuilder.Transaction; | ||
| }>, 'from' | 'suggestedParams' | 'onComplete' | 'approvalProgram' | 'clearProgram' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo' | 'extraPages'>>): txnBuilder.Transaction; | ||
| /** | ||
@@ -416,3 +416,3 @@ * Make a transaction that changes an application's approval and clear programs | ||
| export declare function makeApplicationUpdateTxn(from: AppUpdateTxn['from'], suggestedParams: MustHaveSuggestedParams<AppUpdateTxn>['suggestedParams'], appIndex: AppUpdateTxn['appIndex'], approvalProgram: AppUpdateTxn['appApprovalProgram'], clearProgram: AppUpdateTxn['appClearProgram'], appArgs?: AppUpdateTxn['appArgs'], accounts?: AppUpdateTxn['appAccounts'], foreignApps?: AppUpdateTxn['appForeignApps'], foreignAssets?: AppUpdateTxn['appForeignAssets'], note?: AppUpdateTxn['note'], lease?: AppUpdateTxn['lease'], rekeyTo?: AppUpdateTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeApplicationUpdateTxnFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AppUpdateTxn>, { | ||
| export declare function makeApplicationUpdateTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppUpdateTxn>, { | ||
| appApprovalProgram: 'approvalProgram'; | ||
@@ -424,3 +424,3 @@ appClearProgram: 'clearProgram'; | ||
| reKeyTo: 'rekeyTo'; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'approvalProgram' | 'clearProgram' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'approvalProgram' | 'clearProgram' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| /** | ||
@@ -447,3 +447,3 @@ * Make a transaction that deletes an application | ||
| export declare function makeApplicationDeleteTxn(from: AppDeleteTxn['from'], suggestedParams: MustHaveSuggestedParams<AppDeleteTxn>['suggestedParams'], appIndex: AppDeleteTxn['appIndex'], appArgs?: AppDeleteTxn['appArgs'], accounts?: AppDeleteTxn['appAccounts'], foreignApps?: AppDeleteTxn['appForeignApps'], foreignAssets?: AppDeleteTxn['appForeignAssets'], note?: AppDeleteTxn['note'], lease?: AppDeleteTxn['lease'], rekeyTo?: AppDeleteTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeApplicationDeleteTxnFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AppDeleteTxn>, { | ||
| export declare function makeApplicationDeleteTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppDeleteTxn>, { | ||
| appAccounts: 'accounts'; | ||
@@ -453,3 +453,3 @@ appForeignApps: 'foreignApps'; | ||
| reKeyTo: 'rekeyTo'; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| /** | ||
@@ -476,3 +476,3 @@ * Make a transaction that opts in to use an application | ||
| export declare function makeApplicationOptInTxn(from: AppOptInTxn['from'], suggestedParams: MustHaveSuggestedParams<AppOptInTxn>['suggestedParams'], appIndex: AppOptInTxn['appIndex'], appArgs?: AppOptInTxn['appArgs'], accounts?: AppOptInTxn['appAccounts'], foreignApps?: AppOptInTxn['appForeignApps'], foreignAssets?: AppOptInTxn['appForeignAssets'], note?: AppOptInTxn['note'], lease?: AppOptInTxn['lease'], rekeyTo?: AppOptInTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeApplicationOptInTxnFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, { | ||
| export declare function makeApplicationOptInTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, { | ||
| appAccounts: 'accounts'; | ||
@@ -482,3 +482,3 @@ appForeignApps: 'foreignApps'; | ||
| reKeyTo: 'rekeyTo'; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| /** | ||
@@ -505,3 +505,3 @@ * Make a transaction that closes out a user's state in an application | ||
| export declare function makeApplicationCloseOutTxn(from: AppCloseOutTxn['from'], suggestedParams: MustHaveSuggestedParams<AppCloseOutTxn>['suggestedParams'], appIndex: AppCloseOutTxn['appIndex'], appArgs?: AppCloseOutTxn['appArgs'], accounts?: AppCloseOutTxn['appAccounts'], foreignApps?: AppCloseOutTxn['appForeignApps'], foreignAssets?: AppCloseOutTxn['appForeignAssets'], note?: AppCloseOutTxn['note'], lease?: AppCloseOutTxn['lease'], rekeyTo?: AppCloseOutTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeApplicationCloseOutTxnFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, { | ||
| export declare function makeApplicationCloseOutTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, { | ||
| appAccounts: 'accounts'; | ||
@@ -511,3 +511,3 @@ appForeignApps: 'foreignApps'; | ||
| reKeyTo: 'rekeyTo'; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| /** | ||
@@ -534,3 +534,3 @@ * Make a transaction that clears a user's state in an application | ||
| export declare function makeApplicationClearStateTxn(from: AppClearStateTxn['from'], suggestedParams: MustHaveSuggestedParams<AppClearStateTxn>['suggestedParams'], appIndex: AppClearStateTxn['appIndex'], appArgs?: AppClearStateTxn['appArgs'], accounts?: AppClearStateTxn['appAccounts'], foreignApps?: AppClearStateTxn['appForeignApps'], foreignAssets?: AppClearStateTxn['appForeignAssets'], note?: AppClearStateTxn['note'], lease?: AppClearStateTxn['lease'], rekeyTo?: AppClearStateTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeApplicationClearStateTxnFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, { | ||
| export declare function makeApplicationClearStateTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, { | ||
| appAccounts: 'accounts'; | ||
@@ -540,3 +540,3 @@ appForeignApps: 'foreignApps'; | ||
| reKeyTo: 'rekeyTo'; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| /** | ||
@@ -563,3 +563,3 @@ * Make a transaction that just calls an application, doing nothing on completion | ||
| export declare function makeApplicationNoOpTxn(from: AppNoOpTxn['from'], suggestedParams: MustHaveSuggestedParams<AppNoOpTxn>['suggestedParams'], appIndex: AppNoOpTxn['appIndex'], appArgs?: AppNoOpTxn['appArgs'], accounts?: AppNoOpTxn['appAccounts'], foreignApps?: AppNoOpTxn['appForeignApps'], foreignAssets?: AppNoOpTxn['appForeignAssets'], note?: AppNoOpTxn['note'], lease?: AppNoOpTxn['lease'], rekeyTo?: AppNoOpTxn['reKeyTo']): txnBuilder.Transaction; | ||
| export declare function makeApplicationNoOpTxnFromObject(o: Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, { | ||
| export declare function makeApplicationNoOpTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, { | ||
| appAccounts: 'accounts'; | ||
@@ -569,3 +569,3 @@ appForeignApps: 'foreignApps'; | ||
| reKeyTo: 'rekeyTo'; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>): txnBuilder.Transaction; | ||
| }>, 'from' | 'suggestedParams' | 'appIndex' | 'appArgs' | 'accounts' | 'foreignApps' | 'foreignAssets' | 'note' | 'lease' | 'rekeyTo'>>): txnBuilder.Transaction; | ||
| export { OnApplicationComplete } from './types/transactions/base'; | ||
@@ -575,3 +575,3 @@ /** | ||
| */ | ||
| export declare function makeApplicationCallTxnFromObject(options: Pick<RenameProperties<MustHaveSuggestedParams<AppCreateTxn>, { | ||
| export declare function makeApplicationCallTxnFromObject(options: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppCreateTxn>, { | ||
| appOnComplete: 'onComplete'; | ||
@@ -589,2 +589,2 @@ appAccounts: 'accounts'; | ||
| appGlobalByteSlices: 'numGlobalByteSlices'; | ||
| }>, 'approvalProgram' | 'clearProgram' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices'>>): txnBuilder.Transaction; | ||
| }>, 'approvalProgram' | 'clearProgram' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices'>>>): txnBuilder.Transaction; |
| /** | ||
| * Expands types for IntelliSense so they are more human readable | ||
| * See https://stackoverflow.com/a/69288824 | ||
| */ | ||
| export declare type Expand<T> = T extends (...args: infer A) => infer R ? (...args: Expand<A>) => Expand<R> : T extends infer O ? { | ||
| [K in keyof O]: O[K]; | ||
| } : never; | ||
| /** | ||
| * Same as TypeScript's Pick, but will distribute the Pick over unions | ||
@@ -3,0 +10,0 @@ */ |
| { | ||
| "name": "algosdk", | ||
| "version": "1.14.0-beta.1", | ||
| "version": "1.14.0", | ||
| "description": "The official JavaScript SDK for Algorand", | ||
@@ -39,3 +39,3 @@ "main": "dist/cjs/index.js", | ||
| "assert": "^2.0.0", | ||
| "chromedriver": "^97.0.0", | ||
| "chromedriver": "^99.0.0", | ||
| "concurrently": "^6.2.0", | ||
@@ -63,3 +63,3 @@ "coveralls": "^3.1.0", | ||
| "ts-node": "^10.0.0", | ||
| "typedoc": "^0.22.10", | ||
| "typedoc": "^0.22.11", | ||
| "typedoc-plugin-missing-exports": "^0.22.6", | ||
@@ -66,0 +66,0 @@ "typedoc-plugin-rename-defaults": "^0.4.0", |
@@ -25,4 +25,4 @@ # js-algorand-sdk | ||
| <script | ||
| src="https://unpkg.com/algosdk@1.14.0-beta.1/dist/browser/algosdk.min.js" | ||
| integrity="sha384-GDxzwLVcHrypyA8CcFGLiOne9xqCWuLz9Bfay2fNICEkCuYBUvkC5g0bnY5aeoZC" | ||
| src="https://unpkg.com/algosdk@1.14.0/dist/browser/algosdk.min.js" | ||
| integrity="sha384-ByDr5J6amcNY9qTbvonF4W+4BiDtYexo0oxc91Jedc9D/OPncbWAQzj2otxLa5cF" | ||
| crossorigin="anonymous" | ||
@@ -36,4 +36,4 @@ ></script> | ||
| <script | ||
| src="https://cdn.jsdelivr.net/npm/algosdk@1.14.0-beta.1/dist/browser/algosdk.min.js" | ||
| integrity="sha384-GDxzwLVcHrypyA8CcFGLiOne9xqCWuLz9Bfay2fNICEkCuYBUvkC5g0bnY5aeoZC" | ||
| src="https://cdn.jsdelivr.net/npm/algosdk@1.14.0/dist/browser/algosdk.min.js" | ||
| integrity="sha384-ByDr5J6amcNY9qTbvonF4W+4BiDtYexo0oxc91Jedc9D/OPncbWAQzj2otxLa5cF" | ||
| crossorigin="anonymous" | ||
@@ -40,0 +40,0 @@ ></script> |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.09%
3867401
- Lines of code
- increased by2.43%
37588
- Number of low quality alerts
- decreased by-33.33%
2
No dependency changes