algosdk 1.24.1 → 2.1.0

package/src/makeTxn.ts

@@ -7,9 +7,7 @@ import {
 
   // Utilities
   TransactionType,
-  SuggestedParams,
   MustHaveSuggestedParams,
-  MustHaveSuggestedParamsInline,
   AssetCreateTxn,
   AssetConfigTxn,
   AssetDestroyTxn,
@@ -64,53 +62,6 @@ export function makePaymentTxnWithSuggestedParams(
   return new txnBuilder.Transaction(o);
 }
 
-/**
- * makePaymentTxn takes payment arguments and returns a Transaction object
- * @param from - string representation of Algorand address of sender
- * @param to - string representation of Algorand address of recipient
- * @param fee - integer fee per byte, in microAlgos. for a flat fee, overwrite the fee property on the returned object
- * If the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum.
- * @param amount - integer amount to send, in microAlgos
- * @param closeRemainderTo - optionally close out remaining account balance to this account, represented as string rep of Algorand address
- * @param firstRound - integer first protocol round on which this txn is valid
- * @param lastRound - integer last protocol round on which this txn is valid
- * @param note - uint8array of arbitrary data for sender to store
- * @param genesisHash - string specifies hash genesis block of network in use
- * @param genesisID - string specifies genesis ID of network in use
- * @param rekeyTo - rekeyTo address, optional
- * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
- */
-export 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']
-) {
-  const suggestedParams: SuggestedParams = {
-    genesisHash,
-    genesisID,
-    firstRound,
-    lastRound,
-    fee,
-  };
-  return makePaymentTxnWithSuggestedParams(
-    from,
-    to,
-    amount,
-    closeRemainderTo,
-    note,
-    suggestedParams,
-    rekeyTo
-  );
-}
-
 // helper for above makePaymentTxnWithSuggestedParams, instead accepting an arguments object
 export function makePaymentTxnWithSuggestedParamsFromObject(
   o: Expand<
@@ -217,102 +168,6 @@ export function makeKeyRegistrationTxnWithSuggestedParams(
   return new txnBuilder.Transaction(o);
 }
 
-/**
- * makeKeyRegistrationTxn takes key registration arguments and returns a Transaction object for
- * that key registration operation
- *
- * @param from - string representation of Algorand address of sender
- * @param fee - integer fee per byte, in microAlgos. for a flat fee, overwrite the fee property on the returned object
- *  If the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum.
- * @param firstRound - integer first protocol round on which this txn is valid
- * @param lastRound - integer last protocol round on which this txn is valid
- * @param note - uint8array of arbitrary data for sender to store
- * @param genesisHash - string specifies hash genesis block of network in use
- * @param genesisID - string specifies genesis ID of network in use
- * @param voteKey - voting key. for key deregistration, leave undefined
- * @param selectionKey - selection key. for key deregistration, leave undefined
- * @param voteFirst - first round on which voteKey is valid
- * @param voteLast - last round on which voteKey is valid
- * @param voteKeyDilution - integer
- * @param rekeyTo - rekeyTo address, optional
- * @param nonParticipation - configure whether the address wants to stop participating. If true,
- *   voteKey, selectionKey, voteFirst, voteLast, and voteKeyDilution must be undefined.
- * @param stateProofKey - state proof key. for key deregistration, leave undefined
- * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
- */
-export 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: KeyRegistrationTxn['voteKey'],
-  selectionKey: KeyRegistrationTxn['selectionKey'],
-  voteFirst: KeyRegistrationTxn['voteFirst'],
-  voteLast: KeyRegistrationTxn['voteLast'],
-  voteKeyDilution: KeyRegistrationTxn['voteKeyDilution'],
-  rekeyTo?: KeyRegistrationTxn['reKeyTo'],
-  nonParticipation?: false,
-  stateProofKey?: KeyRegistrationTxn['stateProofKey']
-): txnBuilder.Transaction;
-export 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 function makeKeyRegistrationTxn(
-  from: any,
-  fee: any,
-  firstRound: any,
-  lastRound: any,
-  note: any,
-  genesisHash: any,
-  genesisID: any,
-  voteKey: any,
-  selectionKey: any,
-  voteFirst: any,
-  voteLast: any,
-  voteKeyDilution: any,
-  rekeyTo?: any,
-  nonParticipation: any = false,
-  stateProofKey: any = undefined
-) {
-  const suggestedParams: SuggestedParams = {
-    genesisHash,
-    genesisID,
-    firstRound,
-    lastRound,
-    fee,
-  };
-  return makeKeyRegistrationTxnWithSuggestedParams(
-    from,
-    note,
-    voteKey,
-    selectionKey,
-    voteFirst,
-    voteLast,
-    voteKeyDilution,
-    suggestedParams,
-    rekeyTo,
-    nonParticipation,
-    stateProofKey
-  );
-}
-
 // helper for above makeKeyRegistrationTxnWithSuggestedParams, instead accepting an arguments object
 export function makeKeyRegistrationTxnWithSuggestedParamsFromObject(
   o: Expand<
@@ -431,78 +286,6 @@ export function makeAssetCreateTxnWithSuggestedParams(
   return new txnBuilder.Transaction(o);
 }
 
-/** makeAssetCreateTxn takes asset creation arguments and returns a Transaction object
- * for creating that asset
- *
- * @param from - string representation of Algorand address of sender
- * @param fee - integer fee per byte, in microAlgos. for a flat fee, overwrite the fee property on the returned object
- *  If the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum.
- * @param firstRound - integer first protocol round on which this txn is valid
- * @param lastRound - integer last protocol round on which this txn is valid
- * @param note - uint8array of arbitrary data for sender to store
- * @param genesisHash - string specifies hash genesis block of network in use
- * @param genesisID - string specifies genesis ID of network in use
- * @param total - integer total supply of the asset
- * @param decimals - integer number of decimals for asset unit calculation
- * @param defaultFrozen - boolean whether asset accounts should default to being frozen
- * @param manager - string representation of Algorand address in charge of reserve, freeze, clawback, destruction, etc
- * @param reserve - string representation of Algorand address representing asset reserve
- * @param freeze - string representation of Algorand address with power to freeze/unfreeze asset holdings
- * @param clawback - string representation of Algorand address with power to revoke asset holdings
- * @param unitName - string units name for this asset
- * @param assetName - string name for this asset
- * @param assetURL - string URL relating to this asset
- * @param assetMetadataHash - Uint8Array or UTF-8 string representation of a hash commitment with respect to the asset. Must be exactly 32 bytes long.
- * @param rekeyTo - rekeyTo address, optional
- * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
- */
-export 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']
-) {
-  const suggestedParams: SuggestedParams = {
-    genesisHash,
-    genesisID,
-    firstRound,
-    lastRound,
-    fee,
-  };
-  return makeAssetCreateTxnWithSuggestedParams(
-    from,
-    note,
-    total,
-    decimals,
-    defaultFrozen,
-    manager,
-    reserve,
-    freeze,
-    clawback,
-    unitName,
-    assetName,
-    assetURL,
-    assetMetadataHash,
-    suggestedParams,
-    rekeyTo
-  );
-}
-
 // helper for above makeAssetCreateTxnWithSuggestedParams, instead accepting an arguments object
 export function makeAssetCreateTxnWithSuggestedParamsFromObject(
   o: Expand<
@@ -618,64 +401,6 @@ export function makeAssetConfigTxnWithSuggestedParams(
   return new txnBuilder.Transaction(o);
 }
 
-/** makeAssetConfigTxn can be issued by the asset manager to change the manager, reserve, freeze, or clawback
- * you must respecify existing addresses to keep them the same; leaving a field blank is the same as turning
- * that feature off for this asset
- *
- * @param from - string representation of Algorand address of sender
- * @param fee - integer fee per byte, in microAlgos. for a flat fee, overwrite the fee property on the returned object
- *  If the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum.
- * @param firstRound - integer first protocol round on which this txn is valid
- * @param lastRound - integer last protocol round on which this txn is valid
- * @param note - uint8array of arbitrary data for sender to store
- * @param genesisHash - string specifies hash genesis block of network in use
- * @param genesisID - string specifies genesis ID of network in use
- * @param assetIndex - int asset index uniquely specifying the asset
- * @param manager - string representation of new asset manager Algorand address
- * @param reserve - string representation of new reserve Algorand address
- * @param freeze - string representation of new freeze manager Algorand address
- * @param clawback - string representation of new revocation manager Algorand address
- * @param strictEmptyAddressChecking - boolean - throw an error if any of manager, reserve, freeze, or clawback are undefined. optional, defaults to true.
- * @param rekeyTo - rekeyTo address, optional
- * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
- */
-export 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 = true,
-  rekeyTo?: AssetConfigTxn['reKeyTo']
-) {
-  const suggestedParams: SuggestedParams = {
-    genesisHash,
-    genesisID,
-    firstRound,
-    lastRound,
-    fee,
-  };
-  return makeAssetConfigTxnWithSuggestedParams(
-    from,
-    note,
-    assetIndex,
-    manager,
-    reserve,
-    freeze,
-    clawback,
-    suggestedParams,
-    strictEmptyAddressChecking,
-    rekeyTo
-  );
-}
-
 // helper for above makeAssetConfigTxnWithSuggestedParams, instead accepting an arguments object
 export function makeAssetConfigTxnWithSuggestedParamsFromObject(
   o: Expand<
@@ -752,48 +477,6 @@ export function makeAssetDestroyTxnWithSuggestedParams(
   return new txnBuilder.Transaction(o);
 }
 
-/** makeAssetDestroyTxn will allow the asset's manager to remove this asset from the ledger, so long
- * as all outstanding assets are held by the creator.
- *
- * @param from - string representation of Algorand address of sender
- * @param fee - integer fee per byte, in microAlgos. for a flat fee, overwrite the fee property on the returned object
- *  If the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum.
- * @param firstRound - integer first protocol round on which this txn is valid
- * @param lastRound - integer last protocol round on which this txn is valid
- * @param note - uint8array of arbitrary data for sender to store
- * @param genesisHash - string specifies hash genesis block of network in use
- * @param genesisID - string specifies genesis ID of network in use
- * @param assetIndex - int asset index uniquely specifying the asset
- * @param rekeyTo - rekeyTo address, optional
- * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
- */
-export 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']
-) {
-  const suggestedParams: SuggestedParams = {
-    genesisHash,
-    genesisID,
-    firstRound,
-    lastRound,
-    fee,
-  };
-  return makeAssetDestroyTxnWithSuggestedParams(
-    from,
-    note,
-    assetIndex,
-    suggestedParams,
-    rekeyTo
-  );
-}
-
 // helper for above makeAssetDestroyTxnWithSuggestedParams, instead accepting an arguments object
 export function makeAssetDestroyTxnWithSuggestedParamsFromObject(
   o: Expand<
@@ -856,54 +539,6 @@ export function makeAssetFreezeTxnWithSuggestedParams(
   return new txnBuilder.Transaction(o);
 }
 
-/** makeAssetFreezeTxn will allow the asset's freeze manager to freeze or un-freeze an account,
- * blocking or allowing asset transfers to and from the targeted account.
- *
- * @param from - string representation of Algorand address of sender
- * @param fee - integer fee per byte, in microAlgos. for a flat fee, overwrite the fee property on the returned object
- *  If the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum.
- * @param firstRound - integer first protocol round on which this txn is valid
- * @param lastRound - integer last protocol round on which this txn is valid
- * @param note - uint8array of arbitrary data for sender to store
- * @param genesisHash - string specifies hash genesis block of network in use
- * @param genesisID - string specifies genesis ID of network in use
- * @param assetIndex - int asset index uniquely specifying the asset
- * @param freezeTarget - string representation of Algorand address being frozen or unfrozen
- * @param freezeState - true if freezeTarget should be frozen, false if freezeTarget should be allowed to transact
- * @param rekeyTo - rekeyTo address, optional
- * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
- */
-export 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']
-) {
-  const suggestedParams: SuggestedParams = {
-    genesisHash,
-    genesisID,
-    firstRound,
-    lastRound,
-    fee,
-  };
-  return makeAssetFreezeTxnWithSuggestedParams(
-    from,
-    note,
-    assetIndex,
-    freezeTarget,
-    freezeState,
-    suggestedParams,
-    rekeyTo
-  );
-}
-
 // helper for above makeAssetFreezeTxnWithSuggestedParams, instead accepting an arguments object
 export function makeAssetFreezeTxnWithSuggestedParamsFromObject(
   o: Expand<
@@ -986,62 +621,6 @@ export function makeAssetTransferTxnWithSuggestedParams(
   return new txnBuilder.Transaction(o);
 }
 
-/** makeAssetTransferTxn allows for the creation of an asset transfer transaction.
- * Special case: to begin accepting assets, set amount=0 and from=to.
- *
- * @param from - string representation of Algorand address of sender
- * @param to - string representation of Algorand address of asset recipient
- * @param closeRemainderTo - optional - string representation of Algorand address - if provided,
- * send all remaining assets after transfer to the "closeRemainderTo" address and close "from"'s asset holdings
- * @param revocationTarget - optional - string representation of Algorand address - if provided,
- * and if "from" is the asset's revocation manager, then deduct from "revocationTarget" rather than "from"
- * @param fee - integer fee per byte, in microAlgos. for a flat fee, overwrite the fee property on the returned object
- *  If the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum.
- * @param amount - integer amount of assets to send
- * @param firstRound - integer first protocol round on which this txn is valid
- * @param lastRound - integer last protocol round on which this txn is valid
- * @param note - uint8array of arbitrary data for sender to store
- * @param genesisHash - string specifies hash genesis block of network in use
- * @param genesisID - string specifies genesis ID of network in use
- * @param assetIndex - int asset index uniquely specifying the asset
- * @param rekeyTo - rekeyTo address, optional
- * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
- */
-export 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']
-) {
-  const suggestedParams: SuggestedParams = {
-    genesisHash,
-    genesisID,
-    firstRound,
-    lastRound,
-    fee,
-  };
-  return makeAssetTransferTxnWithSuggestedParams(
-    from,
-    to,
-    closeRemainderTo,
-    revocationTarget,
-    amount,
-    note,
-    assetIndex,
-    suggestedParams,
-    rekeyTo
-  );
-}
-
 // helper for above makeAssetTransferTxnWithSuggestedParams, instead accepting an arguments object
 export function makeAssetTransferTxnWithSuggestedParamsFromObject(
   o: Expand<

package/src/multisig.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import * as nacl from './nacl/naclWrappers';
 import * as address from './encoding/address';
 import * as encoding from './encoding/encoding';

package/src/transaction.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import base32 from 'hi-base32';
 import * as address from './encoding/address';
 import * as encoding from './encoding/encoding';

package/src/types/transactions/encoded.ts

@@ -1,3 +1,5 @@
+import { Buffer } from 'buffer';
+
 /**
  * Interfaces for the encoded transaction object. Every property is labelled with its associated Transaction type property
  */
@@ -363,23 +365,6 @@ export interface EncodedMultisig {
   subsig: EncodedSubsig[];
 }
 
-/**
- * An encoded multisig blob that contains the encoded multisig as well as a copy of the encoded transaction
- *
- * @deprecated Use EncodedSignedTransaction instead.
- */
-export interface EncodedMultisigBlob {
-  /**
-   * Encoded multisig
-   */
-  msig: EncodedMultisig;
-
-  /**
-   * Encoded transaction
-   */
-  txn: EncodedTransaction;
-}
-
 export interface EncodedLogicSig {
   l: Uint8Array;
   arg?: Uint8Array[];

package/src/utils/utils.ts

@@ -114,8 +114,11 @@ export function removeUndefinedProperties(
  */
 export function isNode() {
   return (
+    // @ts-ignore
     typeof process === 'object' &&
+    // @ts-ignore
     typeof process.versions === 'object' &&
+    // @ts-ignore
     typeof process.versions.node !== 'undefined'
   );
 }