algosdk 1.24.0 → 2.0.0

package/src/types/account.ts

@@ -0,0 +1,16 @@
+/**
+ * An Algorand account object.
+ *
+ * Contains an Algorand address and secret key.
+ */
+export default interface Account {
+  /**
+   * Algorand address
+   */
+  addr: string;
+
+  /**
+   * Secret key belonging to the Algorand address
+   */
+  sk: Uint8Array;
+}

package/src/types/address.ts

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

package/src/types/blockHeader.ts

@@ -0,0 +1,81 @@
+/**
+ * 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

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

package/src/types/intDecoding.ts

@@ -0,0 +1,29 @@
+/**
+ * Configure how integers in JSON response will be decoded.
+ */
+enum IntDecoding {
+  /**
+   * All integers will be decoded as Numbers, meaning any values greater than
+   * Number.MAX_SAFE_INTEGER will lose precision.
+   */
+  DEFAULT = 'default',
+
+  /**
+   * All integers will be decoded as Numbers, but if any values are greater than
+   * Number.MAX_SAFE_INTEGER an error will be thrown.
+   */
+  SAFE = 'safe',
+
+  /**
+   * Integers will be decoded as Numbers if they are less than or equal to
+   * Number.MAX_SAFE_INTEGER, otherwise they will be decoded as BigInts.
+   */
+  MIXED = 'mixed',
+
+  /**
+   * All integers will be decoded as BigInts.
+   */
+  BIGINT = 'bigint',
+}
+
+export default IntDecoding;

package/src/types/multisig.ts

@@ -0,0 +1,22 @@
+/**
+ * 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

@@ -0,0 +1,111 @@
+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

@@ -0,0 +1,108 @@
+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
+>;