algosdk 1.13.1 → 1.15.0-beta.1

package/dist/types/src/makeTxn.d.ts

@@ -1,6 +1,6 @@
 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';
 /**
  * makePaymentTxnWithSuggestedParams takes payment arguments and returns a Transaction object
  * @param from - string representation of Algorand address of sender
@@ -36,15 +36,15 @@ export declare function makePaymentTxnWithSuggestedParams(from: PaymentTxn['from
  * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
  */
 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;
 /**
  * makeKeyRegistrationTxnWithSuggestedParams takes key registration arguments and returns a Transaction object for
  * that key registration operation
  *
  * @param from - string representation of Algorand address of sender
  * @param note - uint8array of arbitrary data for sender to store
- * @param voteKey - string representation of voting key. for key deregistration, leave undefined
- * @param selectionKey - string representation of selection key. for key deregistration, leave undefined
+ * @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
@@ -59,9 +59,10 @@ export declare function makePaymentTxnWithSuggestedParamsFromObject(o: Pick<Rena
  * @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
  */
-export declare function makeKeyRegistrationTxnWithSuggestedParams(from: KeyRegistrationTxn['from'], note: KeyRegistrationTxn['note'], voteKey: KeyRegistrationTxn['voteKey'], selectionKey: KeyRegistrationTxn['selectionKey'], voteFirst: KeyRegistrationTxn['voteFirst'], voteLast: KeyRegistrationTxn['voteLast'], voteKeyDilution: KeyRegistrationTxn['voteKeyDilution'], suggestedParams: MustHaveSuggestedParams<KeyRegistrationTxn>['suggestedParams'], rekeyTo?: KeyRegistrationTxn['reKeyTo'], nonParticipation?: false): txnBuilder.Transaction;
-export declare function makeKeyRegistrationTxnWithSuggestedParams(from: KeyRegistrationTxn['from'], note: KeyRegistrationTxn['note'], voteKey: undefined, selectionKey: undefined, voteFirst: undefined, voteLast: undefined, voteKeyDilution: undefined, suggestedParams: MustHaveSuggestedParams<KeyRegistrationTxn>['suggestedParams'], rekeyTo?: KeyRegistrationTxn['reKeyTo'], nonParticipation?: true): txnBuilder.Transaction;
+export declare function makeKeyRegistrationTxnWithSuggestedParams(from: KeyRegistrationTxn['from'], note: KeyRegistrationTxn['note'], voteKey: KeyRegistrationTxn['voteKey'], selectionKey: KeyRegistrationTxn['selectionKey'], voteFirst: KeyRegistrationTxn['voteFirst'], voteLast: KeyRegistrationTxn['voteLast'], voteKeyDilution: KeyRegistrationTxn['voteKeyDilution'], suggestedParams: MustHaveSuggestedParams<KeyRegistrationTxn>['suggestedParams'], rekeyTo?: KeyRegistrationTxn['reKeyTo'], nonParticipation?: false, stateProofKey?: KeyRegistrationTxn['stateProofKey']): txnBuilder.Transaction;
+export declare function makeKeyRegistrationTxnWithSuggestedParams(from: KeyRegistrationTxn['from'], note: KeyRegistrationTxn['note'], voteKey: undefined, selectionKey: undefined, voteFirst: undefined, voteLast: undefined, voteKeyDilution: undefined, suggestedParams: MustHaveSuggestedParams<KeyRegistrationTxn>['suggestedParams'], rekeyTo?: KeyRegistrationTxn['reKeyTo'], nonParticipation?: true, stateProofKey?: undefined): txnBuilder.Transaction;
 /**
  * makeKeyRegistrationTxn takes key registration arguments and returns a Transaction object for
  * that key registration operation
@@ -74,24 +75,25 @@ export declare function makeKeyRegistrationTxnWithSuggestedParams(from: KeyRegis
  * @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 - string representation of voting key. for key deregistration, leave undefined
- * @param selectionKey - string representation of selection key. for key deregistration, leave undefined
+ * @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 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: KeyRegistrationTxn['voteKey'], selectionKey: KeyRegistrationTxn['selectionKey'], voteFirst: KeyRegistrationTxn['voteFirst'], voteLast: KeyRegistrationTxn['voteLast'], voteKeyDilution: KeyRegistrationTxn['voteKeyDilution'], rekeyTo?: KeyRegistrationTxn['reKeyTo'], nonParticipation?: false): txnBuilder.Transaction;
-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): txnBuilder.Transaction;
-export declare function makeKeyRegistrationTxnWithSuggestedParamsFromObject(o: Pick<RenameProperty<MustHaveSuggestedParams<KeyRegistrationTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'voteKey' | 'selectionKey' | 'voteFirst' | 'voteLast' | 'voteKeyDilution' | 'suggestedParams' | 'rekeyTo'> & {
+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: 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 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: 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
  * for creating that asset
  *
@@ -145,7 +147,7 @@ export declare function makeAssetCreateTxnWithSuggestedParams(from: AssetCreateT
  * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
  */
 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';
     assetTotal: 'total';
     assetDecimals: 'decimals';
@@ -155,7 +157,7 @@ export declare function makeAssetCreateTxnWithSuggestedParamsFromObject(o: Pick<
     assetFreeze: 'freeze';
     assetClawback: 'clawback';
     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
  * 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
@@ -201,7 +203,7 @@ export declare function makeAssetConfigTxnWithSuggestedParams(from: AssetConfigT
  * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
  */
 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';
     assetManager: 'manager';
     assetReserve: 'reserve';
@@ -209,7 +211,7 @@ export declare function makeAssetConfigTxnWithSuggestedParamsFromObject(o: Pick<
     assetClawback: 'clawback';
 }>, 'from' | 'note' | 'assetIndex' | 'manager' | 'reserve' | 'freeze' | 'clawback' | 'suggestedParams' | 'rekeyTo'> & {
     strictEmptyAddressChecking: boolean;
-}): txnBuilder.Transaction;
+}>): txnBuilder.Transaction;
 /** makeAssetDestroyTxnWithSuggestedParams will allow the asset's manager to remove this asset from the ledger, so long
  * as all outstanding assets are held by the creator.
  *
@@ -243,7 +245,7 @@ export declare function makeAssetDestroyTxnWithSuggestedParams(from: AssetDestro
  * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
  */
 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,
  * blocking or allowing asset transfers to and from the targeted account.
  *
@@ -281,10 +283,10 @@ export declare function makeAssetFreezeTxnWithSuggestedParams(from: AssetFreezeT
  * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
  */
 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.
  * Special case: to begin accepting assets, set amount=0 and from=to.
  *
@@ -332,10 +334,10 @@ export declare function makeAssetTransferTxnWithSuggestedParams(from: AssetTrans
  * @Deprecated in version 2.0 this will change to use the "WithSuggestedParams" signature.
  */
 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;
 /**
  * Make a transaction that will create an application.
  * @param from - address of sender
@@ -364,7 +366,7 @@ export declare function makeAssetTransferTxnWithSuggestedParamsFromObject(o: Pic
  * @param extraPages - integer extra pages of memory to rent on creation of 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';
     appApprovalProgram: 'approvalProgram';
     appClearProgram: 'clearProgram';
@@ -376,7 +378,7 @@ export declare function makeApplicationCreateTxnFromObject(o: Pick<RenamePropert
     appForeignApps: 'foreignApps';
     appForeignAssets: 'foreignAssets';
     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;
 /**
  * Make a transaction that changes an application's approval and clear programs
  * @param from - address of sender
@@ -400,14 +402,14 @@ export declare function makeApplicationCreateTxnFromObject(o: Pick<RenamePropert
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  */
 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';
     appClearProgram: 'clearProgram';
     appAccounts: 'accounts';
     appForeignApps: 'foreignApps';
     appForeignAssets: 'foreignAssets';
     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;
 /**
  * Make a transaction that deletes an application
  * @param from - address of sender
@@ -429,12 +431,12 @@ export declare function makeApplicationUpdateTxnFromObject(o: Pick<RenamePropert
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  */
 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';
     appForeignApps: 'foreignApps';
     appForeignAssets: 'foreignAssets';
     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;
 /**
  * Make a transaction that opts in to use an application
  * @param from - address of sender
@@ -456,12 +458,12 @@ export declare function makeApplicationDeleteTxnFromObject(o: Pick<RenamePropert
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  */
 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';
     appForeignApps: 'foreignApps';
     appForeignAssets: 'foreignAssets';
     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;
 /**
  * Make a transaction that closes out a user's state in an application
  * @param from - address of sender
@@ -483,12 +485,12 @@ export declare function makeApplicationOptInTxnFromObject(o: Pick<RenameProperti
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  */
 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';
     appForeignApps: 'foreignApps';
     appForeignAssets: 'foreignAssets';
     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;
 /**
  * Make a transaction that clears a user's state in an application
  * @param from - address of sender
@@ -510,12 +512,12 @@ export declare function makeApplicationCloseOutTxnFromObject(o: Pick<RenamePrope
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  */
 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';
     appForeignApps: 'foreignApps';
     appForeignAssets: 'foreignAssets';
     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;
 /**
  * Make a transaction that just calls an application, doing nothing on completion
  * @param from - address of sender
@@ -537,17 +539,17 @@ export declare function makeApplicationClearStateTxnFromObject(o: Pick<RenamePro
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  */
 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';
     appForeignApps: 'foreignApps';
     appForeignAssets: 'foreignAssets';
     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';
 /**
  * Generic function for creating any application call transaction.
  */
-export declare function makeApplicationCallTxnFromObject(options: Pick<RenameProperties<MustHaveSuggestedParams<AppCreateTxn>, {
+export declare function makeApplicationCallTxnFromObject(options: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppCreateTxn>, {
     appOnComplete: 'onComplete';
     appAccounts: 'accounts';
     appForeignApps: 'foreignApps';
@@ -560,4 +562,4 @@ export declare function makeApplicationCallTxnFromObject(options: Pick<RenamePro
     appLocalByteSlices: 'numLocalByteSlices';
     appGlobalInts: 'numGlobalInts';
     appGlobalByteSlices: 'numGlobalByteSlices';
-}>, 'approvalProgram' | 'clearProgram' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices'>>): txnBuilder.Transaction;
+}>, 'approvalProgram' | 'clearProgram' | 'numLocalInts' | 'numLocalByteSlices' | 'numGlobalInts' | 'numGlobalByteSlices'>>>): txnBuilder.Transaction;

package/dist/types/src/transaction.d.ts

@@ -7,7 +7,7 @@ export declare const ALGORAND_MIN_TX_FEE = 1000;
  * A modified version of the transaction params. Represents the internal structure that the Transaction class uses
  * to store inputted transaction objects.
  */
-interface TransactionStorageStructure extends Omit<TransactionParams, 'from' | 'to' | 'genesisHash' | 'closeRemainderTo' | 'voteKey' | 'selectionKey' | 'assetManager' | 'assetReserve' | 'assetFreeze' | 'assetClawback' | 'assetRevocationTarget' | 'freezeAccount' | 'appAccounts' | 'suggestedParams' | 'reKeyTo'> {
+interface TransactionStorageStructure extends Omit<TransactionParams, 'from' | 'to' | 'genesisHash' | 'closeRemainderTo' | 'voteKey' | 'selectionKey' | 'stateProofKey' | 'assetManager' | 'assetReserve' | 'assetFreeze' | 'assetClawback' | 'assetRevocationTarget' | 'freezeAccount' | 'appAccounts' | 'suggestedParams' | 'reKeyTo'> {
     from: string | Address;
     to: string | Address;
     fee: number;
@@ -21,6 +21,7 @@ interface TransactionStorageStructure extends Omit<TransactionParams, 'from' | '
     closeRemainderTo?: string | Address;
     voteKey: string | Buffer;
     selectionKey: string | Buffer;
+    stateProofKey: string | Buffer;
     voteFirst: number;
     voteLast: number;
     voteKeyDilution: number;
@@ -77,6 +78,7 @@ export declare class Transaction implements TransactionStorageStructure {
     closeRemainderTo?: Address;
     voteKey: Buffer;
     selectionKey: Buffer;
+    stateProofKey: Buffer;
     voteFirst: number;
     voteLast: number;
     voteKeyDilution: number;

package/dist/types/src/types/transactions/base.d.ts

@@ -1,7 +1,7 @@
 /**
  * Enum for application transaction types.
  *
- * The full list is availabe at https://developer.algorand.org/docs/reference/transactions/
+ * The full list is available at https://developer.algorand.org/docs/reference/transactions/
  */
 export declare enum TransactionType {
     /**
@@ -29,6 +29,7 @@ export declare enum TransactionType {
      */
     appl = "appl"
 }
+export declare function isTransactionType(s: string): s is TransactionType;
 /**
  * Enums for application transactions on-transaction-complete behavior
  */
@@ -148,13 +149,17 @@ export interface TransactionParams {
      */
     closeRemainderTo?: string;
     /**
-     * String representation of voting key. For key deregistration, leave undefined
+     * Voting key bytes. For key deregistration, leave undefined
      */
-    voteKey: string;
+    voteKey: Uint8Array | string;
     /**
-     * String representation of selection key. For key deregistration, leave undefined
+     *Selection key bytes. For key deregistration, leave undefined
      */
-    selectionKey: string;
+    selectionKey: Uint8Array | string;
+    /**
+     * State proof key bytes. For key deregistration, leave undefined
+     */
+    stateProofKey: Uint8Array | string;
     /**
      * First round on which voteKey is valid
      */

package/dist/types/src/types/transactions/encoded.d.ts

@@ -148,6 +148,10 @@ export interface EncodedTransaction {
      * selectionKey
      */
     selkey?: Buffer;
+    /**
+     * stateProofKey
+     */
+    sprfkey?: Buffer;
     /**
      * voteFirst
      */

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

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

package/dist/types/src/types/utils.d.ts

@@ -1,3 +1,10 @@
+/**
+ * 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
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algosdk",
-  "version": "1.13.1",
+  "version": "1.15.0-beta.1",
   "description": "The official JavaScript SDK for Algorand",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -36,7 +36,7 @@
     "@typescript-eslint/eslint-plugin": "^4.26.1",
     "@typescript-eslint/parser": "^4.26.1",
     "assert": "^2.0.0",
-    "chromedriver": "^97.0.0",
+    "chromedriver": "^99.0.0",
     "concurrently": "^6.2.0",
     "coveralls": "^3.1.0",
     "cucumber": "^5.1.0",
@@ -59,7 +59,7 @@
     "source-map-loader": "^2.0.2",
     "ts-loader": "^8.3.0",
     "ts-node": "^10.0.0",
-    "typedoc": "^0.22.10",
+    "typedoc": "^0.22.11",
     "typedoc-plugin-missing-exports": "^0.22.6",
     "typedoc-plugin-rename-defaults": "^0.4.0",
     "typescript": "^4.2.3",