algosdk 1.24.1 → 2.0.0

package/dist/types/client/algod.d.ts

@@ -1,162 +0,0 @@
-/** @deprecated v1 algod APIs are deprecated, please use the v2 client */
-export function Algod(token?: string, baseServer?: string, port?: number, headers?: {}): void;
-export class Algod {
-    /** @deprecated v1 algod APIs are deprecated, please use the v2 client */
-    constructor(token?: string, baseServer?: string, port?: number, headers?: {});
-    /**
-     * status retrieves the StatusResponse from the running node
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    status: (headerObj?: {}) => Promise<any>;
-    /**
-     * healthCheck returns an empty object iff the node is running
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    healthCheck: (headerObj?: {}) => Promise<any>;
-    /**
-     * statusAfterBlock waits for round roundNumber to occur then returns the StatusResponse for this round.
-     * This call blocks
-     * @param roundNumber
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    statusAfterBlock: (roundNumber: any, headerObj?: {}) => Promise<any>;
-    /**
-     * pendingTransactions asks algod for a snapshot of current pending txns on the node, bounded by maxTxns.
-     * If maxTxns = 0, fetches as many transactions as possible.
-     * @param maxTxns - number
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    pendingTransactions: (maxTxns: any, headerObj?: {}) => Promise<any>;
-    /**
-     * versions retrieves the VersionResponse from the running node
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    versions: (headerObj?: {}) => Promise<any>;
-    /**
-     * LedgerSupply gets the supply details for the specified node's Ledger
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    ledgerSupply: (headerObj?: {}) => Promise<any>;
-    /**
-     * transactionsByAddress returns all transactions for a PK [addr] in the [first, last] rounds range.
-     * @param addr - string
-     * @param first - number, optional
-     * @param last - number, optional
-     * @param maxTxns - number, optional
-     * @param headers, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    transactionByAddress: (addr: any, first?: any, last?: any, maxTxns?: any, headerObj?: {}) => Promise<any>;
-    /**
-     * transactionsByAddressAndDate returns all transactions for a PK [addr] in the [fromDate, toDate] date range.
-     * The date is a string in the YYYY-MM-DD format.
-     * @param addr - string
-     * @param fromDate - string
-     * @param toDate - string
-     * @param maxTxns - number, optional
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    transactionByAddressAndDate: (addr: any, fromDate: any, toDate: any, maxTxns?: any, headerObj?: {}) => Promise<any>;
-    /**
-     * transactionById returns the a transaction information of a specific txid [txId]
-     * Note - This method is allowed only when Indexer is enabled.
-     * @param txid
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    transactionById: (txid: any, headerObj?: {}) => Promise<any>;
-    /**
-     * transactionInformation returns the transaction information of a specific txid and an address
-     * @param addr
-     * @param txid
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    transactionInformation: (addr: any, txid: any, headerObj?: {}) => Promise<any>;
-    /**
-     * pendingTransactionInformation returns the transaction information for a specific txid of a pending transaction
-     * @param txid
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    pendingTransactionInformation: (txid: any, headerObj?: {}) => Promise<any>;
-    /**
-     * accountInformation returns the passed account's information
-     * @param addr - string
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    accountInformation: (addr: any, headerObj?: {}) => Promise<any>;
-    /**
-     * assetInformation returns the information for the asset with the passed creator and index
-     * @param index - number
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    assetInformation: (index: any, headerObj?: {}) => Promise<any>;
-    /**
-     * suggestedFee gets the recommended transaction fee from the node
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    suggestedFee: (headerObj?: {}) => Promise<any>;
-    /**
-     * sendRawTransaction gets an encoded SignedTxn and broadcasts it to the network
-     * @param txn - Uin8Array
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    sendRawTransaction: (txn: any, headerObj?: {}) => Promise<any>;
-    /**
-     * sendRawTransactions gets a list of encoded SignedTxns and broadcasts it to the network
-     * @param txn - Array of Uin8Array
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    sendRawTransactions: (txns: any, headerObj?: {}) => Promise<any>;
-    /**
-     * getTransactionParams returns to common needed parameters for a new transaction
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    getTransactionParams: (headerObj?: {}) => Promise<any>;
-    /**
-     * suggestParams returns to common needed parameters for a new transaction, in a format the transaction builder expects
-     * @param headerObj, optional
-     * @returns {Object}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    suggestParams: (headerObj?: {}) => any;
-    /**
-     * block gets the block info for the given round This call blocks
-     * @param roundNumber
-     * @param headerObj, optional
-     * @returns {Promise<*>}
-     * @deprecated v1 algod APIs are deprecated, please use the v2 client
-     */
-    block: (roundNumber: any, headerObj?: {}) => Promise<any>;
-}

package/dist/types/logic/logic.d.ts

@@ -1,45 +0,0 @@
-/**
- * Utilities for working with program bytes.
- */
-/** @deprecated for langspec.json is deprecated aross all SDKs */
-export declare function parseUvarint(array: Uint8Array): [numberFound: number, size: number];
-/** readProgram validates program for length and running cost,
- * and additionally provides the found int variables and byte blocks
- *
- * @deprecated Validation relies on metadata (`langspec.json`) that
- * does not accurately represent opcode behavior across program versions.
- * The behavior of `readProgram` relies on `langspec.json`.
- * Thus, this method is being deprecated.
- *
- * @param program - Program to check
- * @param args - Program arguments as array of Uint8Array arrays
- * @throws
- * @returns
- */
-export declare function readProgram(program: Uint8Array, args?: Uint8Array[]): [ints: number[], byteArrays: Uint8Array[], valid: boolean];
-/**
- * checkProgram validates program for length and running cost
- *
- * @deprecated Validation relies on metadata (`langspec.json`) that
- * does not accurately represent opcode behavior across program versions.
- * The behavior of `checkProgram` relies on `langspec.json`.
- * Thus, this method is being deprecated.
- *
- * @param program - Program to check
- * @param args - Program arguments as array of Uint8Array arrays
- * @throws
- * @returns true if success
- */
-export declare function checkProgram(program: Uint8Array, args?: Uint8Array[]): boolean;
-/** @deprecated for langspec.json is deprecated aross all SDKs */
-export declare function checkIntConstBlock(program: Uint8Array, pc: number): number;
-/** @deprecated for langspec.json is deprecated aross all SDKs */
-export declare function checkByteConstBlock(program: Uint8Array, pc: number): number;
-/** @deprecated for langspec.json is deprecated aross all SDKs */
-export declare function checkPushIntOp(program: Uint8Array, pc: number): number;
-/** @deprecated for langspec.json is deprecated aross all SDKs */
-export declare function checkPushByteOp(program: Uint8Array, pc: number): number;
-/** @deprecated for langspec.json is deprecated aross all SDKs */
-export declare const langspecEvalMaxVersion: number;
-/** @deprecated for langspec.json is deprecated aross all SDKs */
-export declare const langspecLogicSigVersion: number;

package/dist/types/logicTemplates/dynamicfee.d.ts

@@ -1,59 +0,0 @@
-export class DynamicFee {
-    /**
-     * DynamicFee contract allows you to create a transaction without
-     * specifying the fee. The fee will be determined at the moment of
-     * transfer.
-     *
-     * @deprecated This feature will be removed in v2.
-     *
-     * Constructor Parameters:
-     * @param {string} receiver: address to receive the assets
-     * @param {int} amount: amount of assets to transfer
-     * @param {int} firstValid: first valid round for the transaction
-     * @param {int} lastValid:  last valid round for the transaction
-     * @param {string} closeRemainder: if you would like to close the account after the transfer, specify the address that would recieve the remainder, else leave undefined
-     * @param {string} lease: leave undefined to generate a random lease, or supply a lease as base64
-     * @returns {DynamicFee}
-     */
-    constructor(receiver: string, amount: int, firstValid: int, lastValid: int, closeRemainder: string, lease: string);
-    programBytes: any;
-    address: string;
-    /**
-     * returns the program bytes
-     * @returns {Uint8Array}
-     */
-    getProgram(): Uint8Array;
-    /**
-     * returns the string address of the contract
-     * @returns {string}
-     */
-    getAddress(): string;
-}
-/**
- * getDynamicFeeTransactions creates and signs the secondary dynamic fee transaction, updates
- * transaction fields, and signs as the fee payer; it returns both
- * transactions as bytes suitable for sendRaw.
- *
- * @deprecated This feature will be removed in v2.
- *
- * Parameters:
- * @param {dict} txn - main transaction from payer's signDynamicFee output (a dict of constructor arguments, NOT a transaction.Transaction)
- * @param {LogicSig} lsig - the signed logic received from the payer's signDynamicFee output
- * @param {Uint8Array} privateKey - the private key for the account that pays the fee
- * @param {int} fee - fee per byte for both transactions
- *
- * @throws on invalid lsig
- */
-export function getDynamicFeeTransactions(txn: dict, lsig: LogicSig, privateKey: Uint8Array, fee: int): Uint8Array;
-/**
- * signDynamicFee returns the main transaction and signed logic needed to complete the transfer.
- * These should be sent to the fee payer, who can use GetDynamicFeeTransactions
- *
- * @deprecated This feature will be removed in v2.
- *
- * @param {Uint8Array} contract: the bytearray representing the contract
- * @param {Uint8Array} secretKey: the secret key for building the logic sig
- * @param {string} genesisHash: the genesisHash to use for the txn
- * @returns {Object} object containing json of txnbuilder constructor arguments under "txn" and signed logicsig under "lsig"
- */
-export function signDynamicFee(contract: Uint8Array, secretKey: Uint8Array, genesisHash: string): any;

package/dist/types/logicTemplates/htlc.d.ts

@@ -1,51 +0,0 @@
-export class HTLC {
-    /**
-     * HTLC allows a user to receive the Algo prior to a deadline (in terms of a round) by proving a knowledge
-     * of a special value or to forfeit the ability to claim, returning it to the payer.
-     * This contract is usually used to perform cross-chained atomic swaps
-     *
-     * More formally -
-     * Algos can be transferred under only two circumstances:
-     * 1. To receiver if hash_function(arg_0) = hash_value
-     * 2. To owner if txn.FirstValid > expiry_round
-     * ...
-     *
-     * @deprecated This feature will be removed in v2.
-     *
-     *Parameters
-     *----------
-     * @param {string} owner: an address that can receive the asset after the expiry round
-     * @param {string} receiver: address to receive Algos
-     * @param {string} hashFunction: the hash function to be used (must be either sha256 or keccak256)
-     * @param {string} hashImage: the hash image in base64
-     * @param {int} expiryRound: the round on which the assets can be transferred back to owner
-     * @param {int} maxFee: the maximum fee that can be paid to the network by the account
-     * @returns {HTLC}
-     */
-    constructor(owner: string, receiver: string, hashFunction: string, hashImage: string, expiryRound: int, maxFee: int);
-    programBytes: any;
-    address: string;
-    /**
-     * returns the program bytes
-     * @returns {Uint8Array}
-     */
-    getProgram(): Uint8Array;
-    /**
-     * returns the string address of the contract
-     * @returns {string}
-     */
-    getAddress(): string;
-}
-/**
- *  signTransactionWithHTLCUnlock accepts a transaction, such as a payment, and builds the HTLC-unlocking signature around that transaction
- *
- * @deprecated This feature will be removed in v2.
- *
- * @param {Uint8Array} contract : byte representation of the HTLC
- * @param {Object} txn dictionary containing constructor arguments for a transaction
- * @param {string} preImageAsBase64 : preimage of the hash as base64 string
- *
- * @returns {Object} Object containing txID and blob representing signed transaction.
- * @throws error on validation failure
- */
-export function signTransactionWithHTLCUnlock(contract: Uint8Array, txn: any, preImageAsBase64: string): any;

package/dist/types/logicTemplates/index.d.ts

@@ -1,16 +0,0 @@
-import dynamicFeeTemplate = require("./dynamicfee");
-import htlcTemplate = require("./htlc");
-import limitOrderTemplate = require("./limitorder");
-import splitTemplate = require("./split");
-import periodicPayTemplate = require("./periodicpayment");
-export const DynamicFee: typeof dynamicFeeTemplate.DynamicFee;
-export const getDynamicFeeTransactions: typeof dynamicFeeTemplate.getDynamicFeeTransactions;
-export const signDynamicFee: typeof dynamicFeeTemplate.signDynamicFee;
-export const HTLC: typeof htlcTemplate.HTLC;
-export const signTransactionWithHTLCUnlock: typeof htlcTemplate.signTransactionWithHTLCUnlock;
-export const LimitOrder: typeof limitOrderTemplate.LimitOrder;
-export const getSwapAssetsTransaction: typeof limitOrderTemplate.getSwapAssetsTransaction;
-export const Split: typeof splitTemplate.Split;
-export const getSplitFundsTransaction: typeof splitTemplate.getSplitFundsTransaction;
-export const PeriodicPayment: typeof periodicPayTemplate.PeriodicPayment;
-export const getPeriodicPaymentWithdrawalTransaction: typeof periodicPayTemplate.getPeriodicPaymentWithdrawalTransaction;

package/dist/types/logicTemplates/limitorder.d.ts

@@ -1,70 +0,0 @@
-export class LimitOrder {
-    /**
-     * MakeLimitOrder allows a user to exchange some number of assets for some number of algos.
-     * Fund the contract with some number of Algos to limit the maximum number of
-     * Algos you're willing to trade for some other asset.
-     *
-     * Works on two cases:
-     * * trading Algos for some other asset
-     * * closing out Algos back to the originator after a timeout
-     *
-     * trade case, a 2 transaction group:
-     * gtxn[0] (this txn) Algos from Me to Other
-     * gtxn[1] asset from Other to Me
-     *
-     * We want to get _at least_ some amount of the other asset per our Algos
-     * gtxn[1].AssetAmount / gtxn[0].Amount >= N / D
-     * ===
-     * gtxn[1].AssetAmount * D >= gtxn[0].Amount * N
-     *
-     * close-out case:
-     * txn alone, close out value after timeout
-     *
-     * @deprecated This class will be removed in v2.
-     *
-     * Constructor Parameters:
-     * @param {string} owner: the address to refund funds to on timeout
-     * @param {int} assetid: the ID of the transferred asset
-     * @param {int} ratn: exchange rate (N asset per D Algos, or better)
-     * @param {int} ratd: exchange rate (N asset per D Algos, or better)
-     * @param {int} expiryRound: the round at which the account expires
-     * @param {int} minTrade: the minimum amount (of Algos) to be traded away
-     * @param {int} maxFee: maximum fee used by the limit order transaction
-     * @returns {LimitOrder}
-     */
-    constructor(owner: string, assetid: int, ratn: int, ratd: int, expiryRound: int, minTrade: int, maxFee: int);
-    programBytes: any;
-    address: string;
-    owner: string;
-    assetid: int;
-    /**
-     * returns the program bytes
-     * @returns {Uint8Array}
-     */
-    getProgram(): Uint8Array;
-    /**
-     * returns the string address of the contract
-     * @returns {string}
-     */
-    getAddress(): string;
-}
-/**
- * returns a group transactions array which transfer funds according to the contract's ratio
- *
- * @deprecated This feature will be removed in v2.
- *
- * @param {Uint8Array} contract: byteform of the contract from the payer
- * @param {int} assetAmount: the amount of assets to be sent
- * @param {int} microAlgoAmount: number of microAlgos to transfer
- * @param {Uint8Array} secretKey: secret key for signing transaction
- * @param {int} fee: the fee per byte to pay in microAlgos
- * @param {int} firstRound: the first round on which these txns will be valid
- * @param {int} lastRound: the last round on which these txns will be valid
- * @param {string} genesisHash: the b64-encoded genesis hash indicating the network for this transaction
- * @returns {Uint8Array}
- * the first payment sends money (Algos) from contract to the recipient (we'll call him Buyer), closing the rest of the account to Owner
- * the second payment sends money (the asset) from Buyer to the Owner
- * these transactions will be rejected if they do not meet the restrictions set by the contract
- * @throws error if arguments fail contract validation
- */
-export function getSwapAssetsTransaction(contract: Uint8Array, assetAmount: int, microAlgoAmount: int, secretKey: Uint8Array, fee: int, firstRound: int, lastRound: int, genesisHash: string): Uint8Array;

package/dist/types/logicTemplates/periodicpayment.d.ts

@@ -1,58 +0,0 @@
-export class PeriodicPayment {
-    /**
-     * MakePeriodicPayment allows some account to execute periodic withdrawal of funds.
-     * This is a contract account.
-     *
-     * This allows receiver to withdraw amount every
-     * period rounds for withdrawWindow after every multiple
-     * of period.
-     *
-     * After expiryRound, all remaining funds in the escrow
-     * are available to receiver.
-     *
-     * @deprecated This class will be removed in v2.
-     *
-     * Constructor Parameters:
-     * @param {string} receiver: address which is authorized to receive withdrawals
-     * @param {int} amount: the amount to send each period
-     * @param {int} withdrawalWindow: the duration of a withdrawal period
-     * @param {int} period: the time between a pair of withdrawal periods
-     * @param {int} expiryRound: the round at which the account expires
-     * @param {int} maxFee: maximum fee used by the withdrawal transaction
-     * @param {string} lease: b64 representation of lease to use, or leave undefined to generate one
-     * @returns {PeriodicPayment}
-     */
-    constructor(receiver: string, amount: int, withdrawalWindow: int, period: int, expiryRound: int, maxFee: int, lease: string);
-    receiver: string;
-    amount: int;
-    withdrawalWindow: int;
-    period: int;
-    expiryRound: int;
-    maxFee: int;
-    lease: string;
-    programBytes: Uint8Array;
-    address: string;
-    /**
-     * returns the program bytes
-     * @returns {Uint8Array}
-     */
-    getProgram(): Uint8Array;
-    /**
-     * returns the string address of the contract
-     * @returns {string}
-     */
-    getAddress(): string;
-}
-/**
- * getPeriodicPaymentWithdrawalTransaction returns a signed transaction extracting funds form the contract
- *
- * @deprecated This feature will be removed in v2.
- *
- * @param {Uint8Array} contract: the bytearray defining the contract, received from the payer
- * @param {int} fee: the fee per byte for the transaction
- * @param {int} firstValid: the first round on which the txn will be valid
- * @param {string} genesisHash: the hash representing the network for the txn
- * @returns {Object} Object containing txID and blob representing signed transaction
- * @throws error on failure
- */
-export function getPeriodicPaymentWithdrawalTransaction(contract: Uint8Array, fee: int, firstValid: int, genesisHash: string): any;

package/dist/types/logicTemplates/split.d.ts

@@ -1,57 +0,0 @@
-export class Split {
-    /**
-     * Split splits money sent to some account to two recipients at some ratio.
-     * This is a contract account.
-     *
-     * This allows either a two-transaction group, for executing a
-     * split, or single transaction, for closing the account.
-     *
-     * Withdrawals from this account are allowed as a group transaction which
-     * sends receiverOne and receiverTwo amounts with exactly the specified ratio:
-     * (rat1*amountForReceiverOne) = (rat2*amountForReceiverTwo)
-     * At least minPay must be sent to receiverOne.
-     * (CloseRemainderTo must be zero.)
-     *
-     * After expiryRound passes, all funds can be refunded to owner.
-     *
-     * @deprecated This feature will be removed in v2.
-     *
-     * Constructor Parameters:
-     * @param {string} owner: the address to refund funds to on timeout
-     * @param {string} receiverOne: the first recipient in the split account
-     * @param {string} receiverTwo: the second recipient in the split account
-     * @param {int} rat1: fraction of money to be paid to the 1st recipient
-     * @param {int} rat2: fraction of money to be paid to the 2nd recipient
-     * @param {int} expiryRound: the round at which the account expires
-     * @param {int} minPay: minimum amount to be paid out of the account
-     * @param {int} maxFee: half of the maximum fee used by each split forwarding group transaction
-     * @returns {Split}
-     */
-    constructor(owner: string, receiverOne: string, receiverTwo: string, rat1: int, rat2: int, expiryRound: int, minPay: int, maxFee: int);
-    programBytes: any;
-    address: string;
-    /**
-     * returns the program bytes
-     * @returns {Uint8Array}
-     */
-    getProgram(): Uint8Array;
-    /**
-     * returns the string address of the contract
-     * @returns {string}
-     */
-    getAddress(): string;
-}
-/**
- * returns a group transactions array which transfer funds according to the contract's ratio
- *
- * @deprecated This feature will be removed in v2.
- *
- * @param {Uint8Array} contract: bytes representing the contract in question
- * @param {int} amount: the amount to be transferred
- * @param {int} firstRound: the first round on which the transaction group will be valid
- * @param {int} lastRound: the last round on which the transaction group will be valid
- * @param {int} fee: the fee to pay in microAlgos
- * @param {string} genesisHash: the b64-encoded genesis hash indicating the network for this transaction
- * @returns {Uint8Array}
- */
-export function getSplitFundsTransaction(contract: Uint8Array, amount: int, firstRound: int, lastRound: int, fee: int, genesisHash: string): Uint8Array;

package/dist/types/logicTemplates/templates.d.ts

@@ -1,6 +0,0 @@
-export function inject(orig: any, offsets: any, values: any, valueTypes: any): any;
-export namespace valTypes {
-    const INT: number;
-    const ADDRESS: number;
-    const BASE64: number;
-}