algosdk 2.8.0 → 3.0.0-beta.1

package/dist/types/transaction.d.ts

@@ -1,154 +1,113 @@
-/// <reference types="node" />
-import { OnApplicationComplete, TransactionParams, TransactionType, BoxReference } from './types/transactions/base';
-import AnyTransaction, { EncodedTransaction, EncodedMultisig, EncodedLogicSig } from './types/transactions';
-import { Address } from './types/address';
-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' | 'stateProofKey' | 'assetManager' | 'assetReserve' | 'assetFreeze' | 'assetClawback' | 'assetRevocationTarget' | 'freezeAccount' | 'appAccounts' | 'suggestedParams' | 'reKeyTo'> {
-    from: string | Address;
-    to: string | Address;
-    fee: number;
-    amount: number | bigint;
-    firstRound: number;
-    lastRound: number;
-    note?: Uint8Array;
-    genesisID: string;
-    genesisHash: string | Buffer;
-    lease?: Uint8Array;
-    closeRemainderTo?: string | Address;
-    voteKey: string | Buffer;
-    selectionKey: string | Buffer;
-    stateProofKey: string | Buffer;
-    voteFirst: number;
-    voteLast: number;
-    voteKeyDilution: number;
-    assetIndex: number;
-    assetTotal: number | bigint;
-    assetDecimals: number;
-    assetDefaultFrozen: boolean;
-    assetManager: string | Address;
-    assetReserve: string | Address;
-    assetFreeze: string | Address;
-    assetClawback: string | Address;
-    assetUnitName: string;
-    assetName: string;
-    assetURL: string;
-    assetMetadataHash?: string | Uint8Array;
-    freezeAccount: string | Address;
-    freezeState: boolean;
-    assetRevocationTarget?: string | Address;
-    appIndex: number;
-    appOnComplete: OnApplicationComplete;
-    appLocalInts: number;
-    appLocalByteSlices: number;
-    appGlobalInts: number;
-    appGlobalByteSlices: number;
-    appApprovalProgram: Uint8Array;
-    appClearProgram: Uint8Array;
-    appArgs?: Uint8Array[];
-    appAccounts?: string[] | Address[];
-    appForeignApps?: number[];
-    appForeignAssets?: number[];
-    type?: TransactionType;
-    flatFee: boolean;
-    reKeyTo?: string | Address;
-    nonParticipation?: boolean;
-    group?: Buffer;
-    extraPages?: number;
-    boxes?: BoxReference[];
-    stateProofType?: number | bigint;
-    stateProof?: Uint8Array;
-    stateProofMessage?: Uint8Array;
+import { Address } from './encoding/address.js';
+import * as encoding from './encoding/encoding.js';
+import { NamedMapSchema } from './encoding/schema/index.js';
+import { OnApplicationComplete, TransactionParams, TransactionType } from './types/transactions/base.js';
+import { StateProof, StateProofMessage } from './stateproof.js';
+export interface TransactionBoxReference {
+    readonly appIndex: bigint;
+    readonly name: Uint8Array;
+}
+export interface PaymentTransactionFields {
+    readonly receiver: Address;
+    readonly amount: bigint;
+    readonly closeRemainderTo?: Address;
+}
+export interface KeyRegistrationTransactionFields {
+    readonly voteKey?: Uint8Array;
+    readonly selectionKey?: Uint8Array;
+    readonly stateProofKey?: Uint8Array;
+    readonly voteFirst?: bigint;
+    readonly voteLast?: bigint;
+    readonly voteKeyDilution?: bigint;
+    readonly nonParticipation: boolean;
+}
+export interface AssetConfigTransactionFields {
+    readonly assetIndex: bigint;
+    readonly total: bigint;
+    readonly decimals: number;
+    readonly defaultFrozen: boolean;
+    readonly manager?: Address;
+    readonly reserve?: Address;
+    readonly freeze?: Address;
+    readonly clawback?: Address;
+    readonly unitName?: string;
+    readonly assetName?: string;
+    readonly assetURL?: string;
+    readonly assetMetadataHash?: Uint8Array;
+}
+export interface AssetTransferTransactionFields {
+    readonly assetIndex: bigint;
+    readonly amount: bigint;
+    readonly assetSender?: Address;
+    readonly receiver: Address;
+    readonly closeRemainderTo?: Address;
+}
+export interface AssetFreezeTransactionFields {
+    readonly assetIndex: bigint;
+    readonly freezeAccount: Address;
+    readonly frozen: boolean;
+}
+export interface ApplicationTransactionFields {
+    readonly appIndex: bigint;
+    readonly onComplete: OnApplicationComplete;
+    readonly numLocalInts: number;
+    readonly numLocalByteSlices: number;
+    readonly numGlobalInts: number;
+    readonly numGlobalByteSlices: number;
+    readonly extraPages: number;
+    readonly approvalProgram: Uint8Array;
+    readonly clearProgram: Uint8Array;
+    readonly appArgs: ReadonlyArray<Uint8Array>;
+    readonly accounts: ReadonlyArray<Address>;
+    readonly foreignApps: ReadonlyArray<bigint>;
+    readonly foreignAssets: ReadonlyArray<bigint>;
+    readonly boxes: ReadonlyArray<TransactionBoxReference>;
+}
+export interface StateProofTransactionFields {
+    readonly stateProofType: number;
+    readonly stateProof?: StateProof;
+    readonly message?: StateProofMessage;
 }
 /**
  * Transaction enables construction of Algorand transactions
  * */
-export declare class Transaction implements TransactionStorageStructure {
-    name: string;
-    tag: Buffer;
-    from: Address;
-    to: Address;
-    fee: number;
-    amount: number | bigint;
-    firstRound: number;
-    lastRound: number;
-    note?: Uint8Array;
-    genesisID: string;
-    genesisHash: Buffer;
-    lease?: Uint8Array;
-    closeRemainderTo?: Address;
-    voteKey: Buffer;
-    selectionKey: Buffer;
-    stateProofKey: Buffer;
-    voteFirst: number;
-    voteLast: number;
-    voteKeyDilution: number;
-    assetIndex: number;
-    assetTotal: number | bigint;
-    assetDecimals: number;
-    assetDefaultFrozen: boolean;
-    assetManager: Address;
-    assetReserve: Address;
-    assetFreeze: Address;
-    assetClawback: Address;
-    assetUnitName: string;
-    assetName: string;
-    assetURL: string;
-    assetMetadataHash?: Uint8Array;
-    freezeAccount: Address;
-    freezeState: boolean;
-    assetRevocationTarget?: Address;
-    appIndex: number;
-    appOnComplete: OnApplicationComplete;
-    appLocalInts: number;
-    appLocalByteSlices: number;
-    appGlobalInts: number;
-    appGlobalByteSlices: number;
-    appApprovalProgram: Uint8Array;
-    appClearProgram: Uint8Array;
-    appArgs?: Uint8Array[];
-    appAccounts?: Address[];
-    appForeignApps?: number[];
-    appForeignAssets?: number[];
-    boxes?: BoxReference[];
-    type?: TransactionType;
-    flatFee: boolean;
-    reKeyTo?: Address;
-    nonParticipation?: boolean;
-    group?: Buffer;
-    extraPages?: number;
-    stateProofType?: number | bigint;
-    stateProof?: Uint8Array;
-    stateProofMessage?: Uint8Array;
-    constructor({ ...transaction }: AnyTransaction);
-    get_obj_for_encoding(): EncodedTransaction;
-    static from_obj_for_encoding(txnForEnc: EncodedTransaction): Transaction;
-    estimateSize(): number;
-    bytesToSign(): Buffer;
+export declare class Transaction implements encoding.Encodable {
+    static readonly encodingSchema: NamedMapSchema;
+    /** common */
+    readonly type: TransactionType;
+    readonly sender: Address;
+    readonly note: Uint8Array;
+    readonly lease?: Uint8Array;
+    readonly rekeyTo?: Address;
+    /** group */
+    group?: Uint8Array;
+    /** suggested params */
+    fee: bigint;
+    readonly firstValid: bigint;
+    readonly lastValid: bigint;
+    readonly genesisID?: string;
+    readonly genesisHash?: Uint8Array;
+    /** type-specific fields */
+    readonly payment?: PaymentTransactionFields;
+    readonly keyreg?: KeyRegistrationTransactionFields;
+    readonly assetConfig?: AssetConfigTransactionFields;
+    readonly assetTransfer?: AssetTransferTransactionFields;
+    readonly assetFreeze?: AssetFreezeTransactionFields;
+    readonly applicationCall?: ApplicationTransactionFields;
+    readonly stateProof?: StateProofTransactionFields;
+    constructor(params: TransactionParams);
+    getEncodingSchema(): encoding.Schema;
+    toEncodingData(): Map<string, unknown>;
+    static fromEncodingData(data: unknown): Transaction;
+    private estimateSize;
+    bytesToSign(): Uint8Array;
     toByte(): Uint8Array;
-    rawSignTxn(sk: Uint8Array): Buffer;
+    rawSignTxn(sk: Uint8Array): Uint8Array;
     signTxn(sk: Uint8Array): Uint8Array;
-    attachSignature(signerAddr: string, signature: Uint8Array): Uint8Array;
-    rawTxID(): Buffer;
+    attachSignature(signerAddr: string | Address, signature: Uint8Array): Uint8Array;
+    rawTxID(): Uint8Array;
     txID(): string;
-    addLease(lease: Uint8Array, feePerByte?: number): void;
-    addRekey(reKeyTo: string, feePerByte?: number): void;
-    _getDictForDisplay(): TransactionStorageStructure & Record<string, any>;
-    prettyPrint(): void;
-    toString(): string;
 }
-/**
- * encodeUnsignedSimulateTransaction takes a txnBuilder.Transaction object,
- * converts it into a SignedTransaction-like object, and converts it to a Buffer.
- *
- * Note: this function should only be used to simulate unsigned transactions.
- *
- * @param transactionObject - Transaction object to simulate.
- */
-export declare function encodeUnsignedSimulateTransaction(transactionObject: Transaction): Uint8Array;
 /**
  * encodeUnsignedTransaction takes a completed txnBuilder.Transaction object, such as from the makeFoo
  * family of transactions, and converts it to a Buffer
@@ -156,45 +115,7 @@ export declare function encodeUnsignedSimulateTransaction(transactionObject: Tra
  */
 export declare function encodeUnsignedTransaction(transactionObject: Transaction): Uint8Array;
 /**
- * decodeUnsignedTransaction takes a Buffer (as if from encodeUnsignedTransaction) and converts it to a txnBuilder.Transaction object
+ * decodeUnsignedTransaction takes a Uint8Array (as if from encodeUnsignedTransaction) and converts it to a txnBuilder.Transaction object
  * @param transactionBuffer - the Uint8Array containing a transaction
  */
 export declare function decodeUnsignedTransaction(transactionBuffer: ArrayLike<number>): Transaction;
-/**
- * Object representing a transaction with a signature
- */
-export interface SignedTransaction {
-    /**
-     * Transaction signature
-     */
-    sig?: Buffer;
-    /**
-     * The transaction that was signed
-     */
-    txn: Transaction;
-    /**
-     * Multisig structure
-     */
-    msig?: EncodedMultisig;
-    /**
-     * Logic signature
-     */
-    lsig?: EncodedLogicSig;
-    /**
-     * The signer, if signing with a different key than the Transaction type `from` property indicates
-     */
-    sgnr?: Buffer;
-}
-/**
- * decodeSignedTransaction takes a Buffer (from transaction.signTxn) and converts it to an object
- * containing the Transaction (txn), the signature (sig), and the auth-addr field if applicable (sgnr)
- * @param transactionBuffer - the Uint8Array containing a transaction
- * @returns containing a Transaction, the signature, and possibly an auth-addr field
- */
-export declare function decodeSignedTransaction(transactionBuffer: Uint8Array): SignedTransaction;
-/**
- * Either a valid transaction object or an instance of the Transaction class
- */
-export declare type TransactionLike = AnyTransaction | Transaction;
-export declare function instantiateTxnIfNeeded(transactionLike: TransactionLike): Transaction;
-export default Transaction;

package/dist/types/types/account.d.ts

@@ -1,3 +1,4 @@
+import { Address } from '../encoding/address.js';
 /**
  * An Algorand account object.
  *
@@ -7,7 +8,7 @@ export default interface Account {
     /**
      * Algorand address
      */
-    addr: string;
+    addr: Address;
     /**
      * Secret key belonging to the Algorand address
      */