algosdk 2.8.0 → 3.0.0-beta.1

package/dist/types/types/multisig.d.ts

@@ -1,20 +0,0 @@
-/**
- * Required options for creating a multisignature
- *
- * Documentation available at: https://developer.algorand.org/docs/features/transactions/signatures/#multisignatures
- */
-export interface MultisigMetadata {
-    /**
-     * Multisig version
-     */
-    version: number;
-    /**
-     * Multisig threshold value. Authorization requires a subset of signatures,
-     * equal to or greater than the threshold value.
-     */
-    threshold: number;
-    /**
-     * A list of Algorand addresses representing possible signers for this multisig. Order is important.
-     */
-    addrs: string[];
-}

package/dist/types/types/transactions/application.d.ts

@@ -1,22 +0,0 @@
-import { TransactionType, TransactionParams } from './base';
-import { ConstructTransaction } from './builder';
-declare type SpecificParametersForCreate = Pick<TransactionParams, 'appIndex' | 'appOnComplete' | 'appApprovalProgram' | 'appClearProgram' | 'appLocalInts' | 'appLocalByteSlices' | 'appGlobalInts' | 'appGlobalByteSlices' | 'appArgs' | 'appAccounts' | 'appForeignApps' | 'appForeignAssets' | 'boxes' | 'extraPages'>;
-interface OverwritesForCreate {
-    type?: TransactionType.appl;
-}
-export declare type ApplicationCreateTransaction = ConstructTransaction<SpecificParametersForCreate, OverwritesForCreate>;
-declare type SpecificParametersForUpdate = Pick<TransactionParams, 'appIndex' | 'appOnComplete' | 'appApprovalProgram' | 'appClearProgram' | 'appArgs' | 'appAccounts' | 'appForeignApps' | 'appForeignAssets' | 'boxes'>;
-interface OverwritesForUpdate {
-    type?: TransactionType.appl;
-}
-export declare type ApplicationUpdateTransaction = ConstructTransaction<SpecificParametersForUpdate, OverwritesForUpdate>;
-declare type SpecificParametersForDelete = Pick<TransactionParams, 'appIndex' | 'appOnComplete' | 'appArgs' | 'appAccounts' | 'appForeignApps' | 'appForeignAssets' | 'boxes'>;
-interface OverwritesForDelete {
-    type?: TransactionType.appl;
-}
-export declare type ApplicationDeleteTransaction = ConstructTransaction<SpecificParametersForDelete, OverwritesForDelete>;
-export declare type ApplicationOptInTransaction = ApplicationDeleteTransaction;
-export declare type ApplicationCloseOutTransaction = ApplicationDeleteTransaction;
-export declare type ApplicationClearStateTransaction = ApplicationDeleteTransaction;
-export declare type ApplicationNoOpTransaction = ApplicationDeleteTransaction;
-export {};

package/dist/types/types/transactions/asset.d.ts

@@ -1,28 +0,0 @@
-import { TransactionType, TransactionParams } from './base';
-import { ConstructTransaction } from './builder';
-declare type SpecificParametersForCreate = Pick<TransactionParams, 'assetTotal' | 'assetDecimals' | 'assetDefaultFrozen' | 'assetUnitName' | 'assetName' | 'assetURL' | 'assetMetadataHash' | 'assetManager' | 'assetReserve' | 'assetFreeze' | 'assetClawback'>;
-interface OverwritesForCreate {
-    type?: TransactionType.acfg;
-}
-export declare type AssetCreateTransaction = ConstructTransaction<SpecificParametersForCreate, OverwritesForCreate>;
-declare type SpecificParametersForConfig = Pick<TransactionParams, 'assetIndex' | 'assetManager' | 'assetReserve' | 'assetFreeze' | 'assetClawback'>;
-interface OverwritesForConfig {
-    type?: TransactionType.acfg;
-}
-export declare type AssetConfigurationTransaction = ConstructTransaction<SpecificParametersForConfig, OverwritesForConfig>;
-declare type SpecificParametersForDestroy = Pick<TransactionParams, 'assetIndex'>;
-interface OverwritesForDestroy {
-    type?: TransactionType.acfg;
-}
-export declare type AssetDestroyTransaction = ConstructTransaction<SpecificParametersForDestroy, OverwritesForDestroy>;
-declare type SpecificParametersForFreeze = Pick<TransactionParams, 'assetIndex' | 'freezeAccount' | 'freezeState'>;
-interface OverwritesForFreeze {
-    type?: TransactionType.afrz;
-}
-export declare type AssetFreezeTransaction = ConstructTransaction<SpecificParametersForFreeze, OverwritesForFreeze>;
-declare type SpecificParametersForTransfer = Pick<TransactionParams, 'from' | 'to' | 'closeRemainderTo' | 'assetRevocationTarget' | 'amount' | 'assetIndex'>;
-interface OverwritesForTransfer {
-    type?: TransactionType.axfer;
-}
-export declare type AssetTransferTransaction = ConstructTransaction<SpecificParametersForTransfer, OverwritesForTransfer>;
-export {};

package/dist/types/types/transactions/builder.d.ts

@@ -1,36 +0,0 @@
-import { DistributiveOverwrite } from '../utils';
-import { TransactionParams, SuggestedParams } from './base';
-/**
- * Transaction base with suggested params as object
- */
-declare type TransactionBaseWithSuggestedParams = Pick<TransactionParams, 'suggestedParams' | 'from' | 'type' | 'lease' | 'note' | 'reKeyTo'>;
-/**
- * Transaction base with suggested params included as parameters
- */
-declare type TransactionBaseWithoutSuggestedParams = Pick<TransactionParams, 'flatFee' | 'fee' | 'firstRound' | 'lastRound' | 'genesisHash' | 'from' | 'type' | 'genesisID' | 'lease' | 'note' | 'reKeyTo'>;
-/**
- * Transaction common fields.
- *
- * Base transaction type that is extended for all other transaction types.
- * Suggested params must be included, either as named object or included in the rest
- * of the parameters.
- */
-export declare type TransactionBase = TransactionBaseWithoutSuggestedParams | TransactionBaseWithSuggestedParams | (TransactionBaseWithSuggestedParams & TransactionBaseWithoutSuggestedParams);
-/**
- * Transaction builder type that accepts 2 generics:
- * - A: Additional parameters on top of the base transaction parameters
- * - O: A set of overwrites for transaction parameters
- */
-export declare type ConstructTransaction<A = {}, O extends Partial<TransactionBase & A> = {}> = DistributiveOverwrite<TransactionBase & A, O>;
-/**
- * Only accept transaction objects that include suggestedParams as an object
- */
-export declare type MustHaveSuggestedParams<T extends ConstructTransaction> = Extract<T, {
-    suggestedParams: SuggestedParams;
-}>;
-/**
- * Only accept transaction objects that include suggestedParams inline instead of being
- * enclosed in its own property
- */
-export declare type MustHaveSuggestedParamsInline<T extends ConstructTransaction> = Extract<T, SuggestedParams>;
-export default ConstructTransaction;

package/dist/types/types/transactions/keyreg.d.ts

@@ -1,8 +0,0 @@
-import { TransactionType, TransactionParams } from './base';
-import { ConstructTransaction } from './builder';
-declare type SpecificParameters = Pick<TransactionParams, 'voteKey' | 'selectionKey' | 'stateProofKey' | 'voteFirst' | 'voteLast' | 'voteKeyDilution' | 'nonParticipation'>;
-interface Overwrites {
-    type?: TransactionType.keyreg;
-}
-declare type KeyRegistrationTransaction = ConstructTransaction<SpecificParameters, Overwrites>;
-export default KeyRegistrationTransaction;

package/dist/types/types/transactions/payment.d.ts

@@ -1,8 +0,0 @@
-import { TransactionType, TransactionParams } from './base';
-import { ConstructTransaction } from './builder';
-declare type SpecificParameters = Pick<TransactionParams, 'to' | 'amount' | 'closeRemainderTo'>;
-interface Overwrites {
-    type?: TransactionType.pay;
-}
-declare type PaymentTransaction = ConstructTransaction<SpecificParameters, Overwrites>;
-export default PaymentTransaction;

package/dist/types/types/transactions/stateproof.d.ts

@@ -1,8 +0,0 @@
-import { TransactionType, TransactionParams } from './base';
-import { ConstructTransaction } from './builder';
-declare type SpecificParameters = Pick<TransactionParams, 'stateProofType' | 'stateProof' | 'stateProofMessage'>;
-interface Overwrites {
-    type?: TransactionType.stpf;
-}
-declare type StateProofTransaction = ConstructTransaction<SpecificParameters, Overwrites>;
-export default StateProofTransaction;

package/src/bid.ts

@@ -1,96 +0,0 @@
-import { Buffer } from 'buffer';
-import * as address from './encoding/address';
-import * as encoding from './encoding/encoding';
-import * as nacl from './nacl/naclWrappers';
-import * as utils from './utils/utils';
-import { Address } from './types/address';
-
-interface BidStorageStructure {
-  bidderKey: Address;
-  bidAmount: number;
-  bidID: number;
-  auctionKey: Address;
-  auctionID: number;
-  maxPrice: number;
-}
-
-export type BidOptions = Omit<
-  BidStorageStructure,
-  'bidderKey' | 'auctionKey'
-> & {
-  bidderKey: string;
-  auctionKey: string;
-};
-
-/**
- * Bid enables construction of Algorand Auctions Bids
- * */
-export default class Bid implements BidStorageStructure {
-  name = 'Bid';
-  tag = Buffer.from([97, 66]); // "aB"
-
-  bidderKey: Address;
-  bidAmount: number;
-  bidID: number;
-  auctionKey: Address;
-  auctionID: number;
-  maxPrice: number;
-
-  constructor({
-    bidderKey,
-    bidAmount,
-    bidID,
-    auctionKey,
-    auctionID,
-    maxPrice,
-  }: BidOptions) {
-    const decodedBidderKey = address.decodeAddress(bidderKey);
-    const decodedAuctionKey = address.decodeAddress(auctionKey);
-
-    if (!Number.isSafeInteger(bidAmount) || bidAmount < 0)
-      throw Error('Bid amount must be positive and 2^53-1');
-    if (!Number.isSafeInteger(bidID) || bidID < 0)
-      throw Error('BidID must be positive and 2^53-1');
-    if (!Number.isSafeInteger(auctionID) || auctionID < 0)
-      throw Error('auctionID must be positive');
-
-    Object.assign(this, {
-      bidderKey: decodedBidderKey,
-      bidAmount,
-      bidID,
-      auctionKey: decodedAuctionKey,
-      auctionID,
-      maxPrice,
-    });
-  }
-
-  // eslint-disable-next-line camelcase
-  get_obj_for_encoding() {
-    return {
-      bidder: Buffer.from(this.bidderKey.publicKey),
-      cur: this.bidAmount,
-      price: this.maxPrice,
-      id: this.bidID,
-      auc: Buffer.from(this.auctionKey.publicKey),
-      aid: this.auctionID,
-    };
-  }
-
-  signBid(sk: Uint8Array) {
-    const encodedMsg = encoding.encode(this.get_obj_for_encoding());
-    const toBeSigned = Buffer.from(utils.concatArrays(this.tag, encodedMsg));
-    const sig = nacl.sign(toBeSigned, sk);
-
-    // construct signed message
-    const sBid = {
-      sig: Buffer.from(sig),
-      bid: this.get_obj_for_encoding(),
-    };
-
-    const note = {
-      t: 'b',
-      b: sBid,
-    };
-    return new Uint8Array(encoding.encode(note));
-  }
-}

package/src/client/v2/basemodel.ts

@@ -1,81 +0,0 @@
-import { Buffer } from 'buffer';
-
-/**
- * Base class for models
- */
-
-/* eslint-disable no-underscore-dangle,camelcase */
-function _is_primitive(val: any): val is string | boolean | number | bigint {
-  /* eslint-enable no-underscore-dangle,camelcase */
-  return (
-    val === undefined ||
-    val == null ||
-    (typeof val !== 'object' && typeof val !== 'function')
-  );
-}
-
-/* eslint-disable no-underscore-dangle,camelcase,no-redeclare,no-unused-vars */
-function _get_obj_for_encoding(
-  val: Function,
-  binary: boolean
-): Record<string, any>;
-function _get_obj_for_encoding(val: any[], binary: boolean): any[];
-function _get_obj_for_encoding(
-  val: Record<string, any>,
-  binary: boolean
-): Record<string, any>;
-function _get_obj_for_encoding(val: any, binary: boolean): any {
-  /* eslint-enable no-underscore-dangle,camelcase,no-redeclare,no-unused-vars */
-  let targetPropValue: any;
-
-  if (val instanceof Uint8Array) {
-    targetPropValue = binary ? val : Buffer.from(val).toString('base64');
-  } else if (typeof val.get_obj_for_encoding === 'function') {
-    targetPropValue = val.get_obj_for_encoding(binary);
-  } else if (Array.isArray(val)) {
-    targetPropValue = [];
-    for (const elem of val) {
-      targetPropValue.push(_get_obj_for_encoding(elem, binary));
-    }
-  } else if (typeof val === 'object') {
-    const obj = {};
-    for (const prop of Object.keys(val)) {
-      obj[prop] = _get_obj_for_encoding(val[prop], binary);
-    }
-    targetPropValue = obj;
-  } else if (_is_primitive(val)) {
-    targetPropValue = val;
-  } else {
-    throw new Error(`Unsupported value: ${String(val)}`);
-  }
-  return targetPropValue;
-}
-
-export default class BaseModel {
-  /* eslint-disable no-underscore-dangle,camelcase */
-  attribute_map: Record<string, string>;
-
-  /**
-   * Get an object ready for encoding to either JSON or msgpack.
-   * @param binary - Use true to indicate that the encoding can handle raw binary objects
-   *   (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64
-   *   strings. True should be used for objects that will be encoded with msgpack, and false should
-   *   be used for objects that will be encoded with JSON.
-   */
-  get_obj_for_encoding(binary = false) {
-    /* eslint-enable no-underscore-dangle,camelcase */
-    const obj: Record<string, any> = {};
-
-    for (const prop of Object.keys(this.attribute_map)) {
-      const name = this.attribute_map[prop];
-      const value = this[prop];
-
-      if (typeof value !== 'undefined') {
-        obj[name] =
-          value === null ? null : _get_obj_for_encoding(value, binary);
-      }
-    }
-
-    return obj;
-  }
-}

package/src/types/address.ts

@@ -1,7 +0,0 @@
-/**
- * Decoded Algorand address. Includes public key and checksum.
- */
-export interface Address {
-  publicKey: Uint8Array;
-  checksum: Uint8Array;
-}

package/src/types/blockHeader.ts

@@ -1,81 +0,0 @@
-/**
- * Represents the metadata and state of a block.
- *
- * For more information, refer to: https://github.com/algorand/go-algorand/blob/master/data/bookkeeping/block.go
- */
-export default interface BlockHeader {
-  /**
-   * Transaction fees
-   */
-  fees: string;
-
-  /**
-   * The number of leftover MicroAlgos after rewards distribution
-   */
-  frac: number;
-
-  /**
-   * Genesis ID to which this block belongs
-   */
-  gen: string;
-
-  /**
-   * Genesis hash to which this block belongs.
-   */
-  gh: string;
-
-  /**
-   * The hash of the previous block
-   */
-  prev: string;
-
-  /**
-   * Current protocol
-   */
-  proto: string;
-
-  /**
-   * Rewards rate
-   */
-  rate: number;
-
-  /**
-   * Round number
-   */
-  rnd: number;
-
-  /**
-   * Rewards recalculation round
-   */
-  rwcalr: number;
-
-  /**
-   * Rewards pool
-   */
-  rwd: string;
-
-  /**
-   * Sortition seed
-   */
-  seed: string;
-
-  /**
-   * Timestamp in seconds since epoch
-   */
-  ts: number;
-
-  /**
-   * Transaction root SHA512_256
-   */
-  txn: string;
-
-  /**
-   * Transaction root SHA256
-   */
-  txn256: string;
-
-  /**
-   * StateProofTracking map of type to tracking data
-   */
-  spt: Map<number, Uint8Array>;
-}

package/src/types/index.ts

@@ -1,3 +0,0 @@
-export * from './transactions';
-export * from './multisig';
-export * from './address';

package/src/types/multisig.ts

@@ -1,22 +0,0 @@
-/**
- * Required options for creating a multisignature
- *
- * Documentation available at: https://developer.algorand.org/docs/features/transactions/signatures/#multisignatures
- */
-export interface MultisigMetadata {
-  /**
-   * Multisig version
-   */
-  version: number;
-
-  /**
-   * Multisig threshold value. Authorization requires a subset of signatures,
-   * equal to or greater than the threshold value.
-   */
-  threshold: number;
-
-  /**
-   * A list of Algorand addresses representing possible signers for this multisig. Order is important.
-   */
-  addrs: string[];
-}

package/src/types/transactions/application.ts

@@ -1,111 +0,0 @@
-import { TransactionType, TransactionParams } from './base';
-import { ConstructTransaction } from './builder';
-
-// -----------------------------------
-// > Application Create Transaction
-// -----------------------------------
-
-type SpecificParametersForCreate = Pick<
-  TransactionParams,
-  | 'appIndex'
-  | 'appOnComplete'
-  | 'appApprovalProgram'
-  | 'appClearProgram'
-  | 'appLocalInts'
-  | 'appLocalByteSlices'
-  | 'appGlobalInts'
-  | 'appGlobalByteSlices'
-  | 'appArgs'
-  | 'appAccounts'
-  | 'appForeignApps'
-  | 'appForeignAssets'
-  | 'boxes'
-  | 'extraPages'
->;
-
-interface OverwritesForCreate {
-  type?: TransactionType.appl;
-}
-
-export type ApplicationCreateTransaction = ConstructTransaction<
-  SpecificParametersForCreate,
-  OverwritesForCreate
->;
-
-// -----------------------------------
-// > Application Update Transaction
-// -----------------------------------
-
-type SpecificParametersForUpdate = Pick<
-  TransactionParams,
-  | 'appIndex'
-  | 'appOnComplete'
-  | 'appApprovalProgram'
-  | 'appClearProgram'
-  | 'appArgs'
-  | 'appAccounts'
-  | 'appForeignApps'
-  | 'appForeignAssets'
-  | 'boxes'
->;
-
-interface OverwritesForUpdate {
-  type?: TransactionType.appl;
-}
-
-export type ApplicationUpdateTransaction = ConstructTransaction<
-  SpecificParametersForUpdate,
-  OverwritesForUpdate
->;
-
-// -----------------------------------
-// > Application Delete Transaction
-// -----------------------------------
-
-type SpecificParametersForDelete = Pick<
-  TransactionParams,
-  | 'appIndex'
-  | 'appOnComplete'
-  | 'appArgs'
-  | 'appAccounts'
-  | 'appForeignApps'
-  | 'appForeignAssets'
-  | 'boxes'
->;
-
-interface OverwritesForDelete {
-  type?: TransactionType.appl;
-}
-
-export type ApplicationDeleteTransaction = ConstructTransaction<
-  SpecificParametersForDelete,
-  OverwritesForDelete
->;
-
-// -----------------------------------
-// > Application Opt-In Transaction
-// -----------------------------------
-
-// Same structure as the application delete transaction
-export type ApplicationOptInTransaction = ApplicationDeleteTransaction;
-
-// -----------------------------------
-// > Application Close Out Transaction
-// -----------------------------------
-
-// Same structure as the application delete transaction
-export type ApplicationCloseOutTransaction = ApplicationDeleteTransaction;
-
-// --------------------------------------
-// > Application Clear State Transaction
-// --------------------------------------
-
-// Same structure as the application delete transaction
-export type ApplicationClearStateTransaction = ApplicationDeleteTransaction;
-
-// --------------------------------------
-// > Application Call (NoOp) Transaction
-// --------------------------------------
-
-// Same structure as the application delete transaction
-export type ApplicationNoOpTransaction = ApplicationDeleteTransaction;

package/src/types/transactions/asset.ts

@@ -1,108 +0,0 @@
-import { TransactionType, TransactionParams } from './base';
-import { ConstructTransaction } from './builder';
-
-// ------------------------------
-// > Asset Create Transaction
-// ------------------------------
-
-type SpecificParametersForCreate = Pick<
-  TransactionParams,
-  | 'assetTotal'
-  | 'assetDecimals'
-  | 'assetDefaultFrozen'
-  | 'assetUnitName'
-  | 'assetName'
-  | 'assetURL'
-  | 'assetMetadataHash'
-  | 'assetManager'
-  | 'assetReserve'
-  | 'assetFreeze'
-  | 'assetClawback'
->;
-
-interface OverwritesForCreate {
-  type?: TransactionType.acfg;
-}
-
-export type AssetCreateTransaction = ConstructTransaction<
-  SpecificParametersForCreate,
-  OverwritesForCreate
->;
-
-// ------------------------------
-// > Asset Config Transaction
-// ------------------------------
-
-type SpecificParametersForConfig = Pick<
-  TransactionParams,
-  | 'assetIndex'
-  | 'assetManager'
-  | 'assetReserve'
-  | 'assetFreeze'
-  | 'assetClawback'
->;
-
-interface OverwritesForConfig {
-  type?: TransactionType.acfg;
-}
-
-export type AssetConfigurationTransaction = ConstructTransaction<
-  SpecificParametersForConfig,
-  OverwritesForConfig
->;
-
-// ------------------------------
-// > Asset Destroy Transaction
-// ------------------------------
-
-type SpecificParametersForDestroy = Pick<TransactionParams, 'assetIndex'>;
-
-interface OverwritesForDestroy {
-  type?: TransactionType.acfg;
-}
-
-export type AssetDestroyTransaction = ConstructTransaction<
-  SpecificParametersForDestroy,
-  OverwritesForDestroy
->;
-
-// ------------------------------
-// > Asset Freeze Transaction
-// ------------------------------
-
-type SpecificParametersForFreeze = Pick<
-  TransactionParams,
-  'assetIndex' | 'freezeAccount' | 'freezeState'
->;
-
-interface OverwritesForFreeze {
-  type?: TransactionType.afrz;
-}
-
-export type AssetFreezeTransaction = ConstructTransaction<
-  SpecificParametersForFreeze,
-  OverwritesForFreeze
->;
-
-// ------------------------------
-// > Asset Transfer Transaction
-// ------------------------------
-
-type SpecificParametersForTransfer = Pick<
-  TransactionParams,
-  | 'from'
-  | 'to'
-  | 'closeRemainderTo'
-  | 'assetRevocationTarget'
-  | 'amount'
-  | 'assetIndex'
->;
-
-interface OverwritesForTransfer {
-  type?: TransactionType.axfer;
-}
-
-export type AssetTransferTransaction = ConstructTransaction<
-  SpecificParametersForTransfer,
-  OverwritesForTransfer
->;