algosdk 1.24.0 → 2.0.0

package/dist/types/client/v2/indexer/lookupAssetTransactions.d.ts

@@ -0,0 +1,323 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+export default class LookupAssetTransactions extends JSONRequest {
+    private index;
+    /**
+     * Returns transactions relating to the given asset.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient.lookupAssetTransactions(assetId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-idtransactions)
+     * @param index - The asset ID to look up.
+     */
+    constructor(c: HTTPClient, intDecoding: IntDecoding, index: number);
+    /**
+     * @returns `/v2/assets/${index}/transactions`
+     */
+    path(): string;
+    /**
+     * Specifies a prefix which must be contained in the note field.
+     *
+     * #### Example
+     * ```typescript
+     * const notePrefixBase64Encoded = "Y3JlYXRl";
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .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 assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .txType("axfer")
+     *        .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 assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .sigType("lsig")
+     *        .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 assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .txid(txId)
+     *        .do();
+     * ```
+     *
+     * @param txid
+     * @category query
+     */
+    txid(txid: string): this;
+    /**
+     * Include results for the specified round.
+     *
+     * #### Example
+     * ```typescript
+     * const targetBlock = 18309917;
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .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 assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .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 assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .maxRound(maxRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
+    maxRound(round: number): this;
+    /**
+     * Maximum number of results to return.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .limit(maxResults)
+     *        .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 assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .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 assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .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 asset units.
+     *
+     * #### Example
+     * ```typescript
+     * const minBalance = 300000;
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(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 asset units.
+     *
+     * #### Example
+     * ```typescript
+     * const maxBalance = 500000;
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * @param lesser
+     * @category query
+     */
+    currencyLessThan(lesser: number): this;
+    /**
+     * Combined with address, defines what address to filter on, as string.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const role = "sender";
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .address(address)
+     *        .addressRole(role)
+     *        .do();
+     * ```
+     *
+     * @param role - one of `sender`, `receiver`, `freeze-target`
+     * @category query
+     */
+    addressRole(role: string): this;
+    /**
+     * Only include transactions with this address in one of the transaction fields.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .address(address)
+     *        .do();
+     * ```
+     *
+     * @param address
+     * @category query
+     */
+    address(address: string): this;
+    /**
+     * Whether or not to consider the `close-to` field as a receiver when filtering transactions, as bool. Set to `true` to ignore `close-to`.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .excludeCloseTo(true)
+     *        .do();
+     * ```
+     *
+     * @param exclude
+     * @category query
+     */
+    excludeCloseTo(exclude: boolean): this;
+    /**
+     * The next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     * const assetId = 163650;
+     *
+     * const assetTxnsPage1 = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const assetTxnsPage2 = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .limit(maxResults)
+     *        .nextToken(assetTxnsPage1["next-token"])
+     *        .do();
+     * ```
+     *
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
+    nextToken(nextToken: string): this;
+    /**
+     * Whether or not to include rekeying transactions.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetTxns = await indexerClient
+     *        .lookupAssetTransactions(assetId)
+     *        .rekeyTo(false)
+     *        .do();
+     * ```
+     *
+     * @param rekeyTo
+     * @category query
+     */
+    rekeyTo(rekeyTo: boolean): this;
+}

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
-import * as algosdk from './src/main';
-export * from './src/main';
+import * as algosdk from './main';
+export * from './main';
 export default algosdk;

package/dist/types/logicsig.d.ts

@@ -0,0 +1,183 @@
+/// <reference types="node" />
+import * as txnBuilder from './transaction';
+import { EncodedLogicSig, EncodedLogicSigAccount, EncodedMultisig } from './types/transactions/encoded';
+import { MultisigMetadata } from './types/multisig';
+interface LogicSigStorageStructure {
+    logic: Uint8Array;
+    args: Uint8Array[];
+    sig?: Uint8Array;
+    msig?: EncodedMultisig;
+}
+/** sanityCheckProgram performs heuristic program validation:
+ * check if passed in bytes are Algorand address or is B64 encoded, rather than Teal bytes
+ *
+ * @param program - Program bytes to check
+ */
+export declare function sanityCheckProgram(program: Uint8Array): void;
+/**
+ LogicSig implementation
+
+ LogicSig cannot sign transactions in all cases.  Instead, use LogicSigAccount as a safe, general purpose signing mechanism.  Since LogicSig does not track the provided signature's public key, LogicSig cannot sign transactions when delegated to a non-multisig account _and_ the sender is not the delegating account.
+ */
+export declare class LogicSig implements LogicSigStorageStructure {
+    tag: Buffer;
+    logic: Uint8Array;
+    args: Uint8Array[];
+    sig?: Uint8Array;
+    msig?: EncodedMultisig;
+    constructor(program: Uint8Array, programArgs?: Array<Uint8Array | Buffer> | null);
+    get_obj_for_encoding(): EncodedLogicSig;
+    static from_obj_for_encoding(encoded: EncodedLogicSig): LogicSig;
+    /**
+     * Performs signature verification
+     * @param publicKey - Verification key (derived from sender address or escrow address)
+     */
+    verify(publicKey: Uint8Array): boolean;
+    /**
+     * Compute hash of the logic sig program (that is the same as escrow account address) as string address
+     * @returns String representation of the address
+     */
+    address(): string;
+    /**
+     * Creates signature (if no msig provided) or multi signature otherwise
+     * @param secretKey - Secret key to sign with
+     * @param msig - Multisig account as \{version, threshold, addrs\}
+     */
+    sign(secretKey: Uint8Array, msig?: MultisigMetadata): void;
+    /**
+     * Appends a signature to multi signature
+     * @param secretKey - Secret key to sign with
+     */
+    appendToMultisig(secretKey: Uint8Array): void;
+    signProgram(secretKey: Uint8Array): Uint8Array;
+    singleSignMultisig(secretKey: Uint8Array, msig: EncodedMultisig): [sig: Uint8Array, index: number];
+    toByte(): Uint8Array;
+    static fromByte(encoded: ArrayLike<any>): LogicSig;
+}
+/**
+ * Represents an account that can sign with a LogicSig program.
+ */
+export declare class LogicSigAccount {
+    lsig: LogicSig;
+    sigkey?: Uint8Array;
+    /**
+     * Create a new LogicSigAccount. By default this will create an escrow
+     * LogicSig account. Call `sign` or `signMultisig` on the newly created
+     * LogicSigAccount to make it a delegated account.
+     *
+     * @param program - The compiled TEAL program which contains the logic for
+     *   this LogicSig.
+     * @param args - An optional array of arguments for the program.
+     */
+    constructor(program: Uint8Array, args?: Array<Uint8Array | Buffer> | null);
+    get_obj_for_encoding(): EncodedLogicSigAccount;
+    static from_obj_for_encoding(encoded: EncodedLogicSigAccount): LogicSigAccount;
+    /**
+     * Encode this object into msgpack.
+     */
+    toByte(): Uint8Array;
+    /**
+     * Decode a msgpack object into a LogicSigAccount.
+     * @param encoded - The encoded LogicSigAccount.
+     */
+    static fromByte(encoded: ArrayLike<any>): LogicSigAccount;
+    /**
+     * Check if this LogicSigAccount has been delegated to another account with a
+     * signature.
+     *
+     * Note this function only checks for the presence of a delegation signature.
+     * To verify the delegation signature, use `verify`.
+     */
+    isDelegated(): boolean;
+    /**
+     * Verifies this LogicSig's program and signatures.
+     * @returns true if and only if the LogicSig program and signatures are valid.
+     */
+    verify(): boolean;
+    /**
+     * Get the address of this LogicSigAccount.
+     *
+     * If the LogicSig is delegated to another account, this will return the
+     * address of that account.
+     *
+     * If the LogicSig is not delegated to another account, this will return an
+     *  escrow address that is the hash of the LogicSig's program code.
+     */
+    address(): string;
+    /**
+     * Turns this LogicSigAccount into a delegated LogicSig. This type of LogicSig
+     * has the authority to sign transactions on behalf of another account, called
+     * the delegating account. Use this function if the delegating account is a
+     * multisig account.
+     *
+     * @param msig - The multisig delegating account
+     * @param secretKey - The secret key of one of the members of the delegating
+     *   multisig account. Use `appendToMultisig` to add additional signatures
+     *   from other members.
+     */
+    signMultisig(msig: MultisigMetadata, secretKey: Uint8Array): void;
+    /**
+     * Adds an additional signature from a member of the delegating multisig
+     * account.
+     *
+     * @param secretKey - The secret key of one of the members of the delegating
+     *   multisig account.
+     */
+    appendToMultisig(secretKey: Uint8Array): void;
+    /**
+     * Turns this LogicSigAccount into a delegated LogicSig. This type of LogicSig
+     * has the authority to sign transactions on behalf of another account, called
+     * the delegating account. If the delegating account is a multisig account,
+     * use `signMultisig` instead.
+     *
+     * @param secretKey - The secret key of the delegating account.
+     */
+    sign(secretKey: Uint8Array): void;
+}
+/**
+ * signLogicSigTransactionObject takes a transaction and a LogicSig object and
+ * returns a signed transaction.
+ *
+ * @param txn - The transaction to sign.
+ * @param lsigObject - The LogicSig object that will sign the transaction.
+ *
+ * @returns Object containing txID and blob representing signed transaction.
+ */
+export declare function signLogicSigTransactionObject(txn: txnBuilder.Transaction, lsigObject: LogicSig | LogicSigAccount): {
+    txID: string;
+    blob: Uint8Array;
+};
+/**
+ * signLogicSigTransaction takes a transaction and a LogicSig object and returns
+ * a signed transaction.
+ *
+ * @param txn - The transaction to sign.
+ * @param lsigObject - The LogicSig object that will sign the transaction.
+ *
+ * @returns Object containing txID and blob representing signed transaction.
+ * @throws error on failure
+ */
+export declare function signLogicSigTransaction(txn: txnBuilder.TransactionLike, lsigObject: LogicSig | LogicSigAccount): {
+    txID: string;
+    blob: Uint8Array;
+};
+/**
+ * logicSigFromByte accepts encoded logic sig bytes and attempts to call logicsig.fromByte on it,
+ * returning the result
+ */
+export declare function logicSigFromByte(encoded: Uint8Array): LogicSig;
+/**
+ * tealSign creates a signature compatible with ed25519verify opcode from program hash
+ * @param sk - uint8array with secret key
+ * @param data - buffer with data to sign
+ * @param programHash - string representation of teal program hash (= contract address for LogicSigs)
+ */
+export declare function tealSign(sk: Uint8Array, data: Uint8Array | Buffer, programHash: string): Uint8Array;
+/**
+ * tealSignFromProgram creates a signature compatible with ed25519verify opcode from raw program bytes
+ * @param sk - uint8array with secret key
+ * @param data - buffer with data to sign
+ * @param program - buffer with teal program
+ */
+export declare function tealSignFromProgram(sk: Uint8Array, data: Uint8Array | Buffer, program: Uint8Array): Uint8Array;
+export {};