algosdk 2.8.0 → 3.0.0-beta.1

package/dist/types/logicsig.d.ts

@@ -1,13 +1,8 @@
-/// <reference types="node" />
-import * as txnBuilder from './transaction';
-import { EncodedLogicSig, EncodedLogicSigAccount, EncodedMultisig } from './types/transactions/encoded';
-import { MultisigMetadata } from './types/multisig';
-interface LogicSigStorageStructure {
-    logic: Uint8Array;
-    args: Uint8Array[];
-    sig?: Uint8Array;
-    msig?: EncodedMultisig;
-}
+import { Address } from './encoding/address.js';
+import * as encoding from './encoding/encoding.js';
+import { NamedMapSchema } from './encoding/schema/index.js';
+import { MultisigMetadata } from './multisig.js';
+import { EncodedMultisig } from './types/transactions/encoded.js';
 /** sanityCheckProgram performs heuristic program validation:
  * check if passed in bytes are Algorand address or is B64 encoded, rather than Teal bytes
  *
@@ -19,15 +14,16 @@ export declare function sanityCheckProgram(program: Uint8Array): void;
 
  LogicSig cannot sign transactions in all cases.  Instead, use LogicSigAccount as a safe, general purpose signing mechanism.  Since LogicSig does not track the provided signature's public key, LogicSig cannot sign transactions when delegated to a non-multisig account _and_ the sender is not the delegating account.
  */
-export declare class LogicSig implements LogicSigStorageStructure {
-    tag: Buffer;
+export declare class LogicSig implements encoding.Encodable {
+    static readonly encodingSchema: NamedMapSchema;
     logic: Uint8Array;
     args: Uint8Array[];
     sig?: Uint8Array;
     msig?: EncodedMultisig;
-    constructor(program: Uint8Array, programArgs?: Array<Uint8Array | Buffer> | null);
-    get_obj_for_encoding(): EncodedLogicSig;
-    static from_obj_for_encoding(encoded: EncodedLogicSig): LogicSig;
+    constructor(program: Uint8Array, programArgs?: Array<Uint8Array> | null);
+    getEncodingSchema(): encoding.Schema;
+    toEncodingData(): Map<string, unknown>;
+    static fromEncodingData(data: unknown): LogicSig;
     /**
      * Performs signature verification
      * @param publicKey - Verification key (derived from sender address or escrow address)
@@ -37,7 +33,7 @@ export declare class LogicSig implements LogicSigStorageStructure {
      * Compute hash of the logic sig program (that is the same as escrow account address) as string address
      * @returns String representation of the address
      */
-    address(): string;
+    address(): Address;
     /**
      * Creates signature (if no msig provided) or multi signature otherwise
      * @param secretKey - Secret key to sign with
@@ -57,7 +53,8 @@ export declare class LogicSig implements LogicSigStorageStructure {
 /**
  * Represents an account that can sign with a LogicSig program.
  */
-export declare class LogicSigAccount {
+export declare class LogicSigAccount implements encoding.Encodable {
+    static readonly encodingSchema: NamedMapSchema;
     lsig: LogicSig;
     sigkey?: Uint8Array;
     /**
@@ -69,9 +66,10 @@ export declare class LogicSigAccount {
      *   this LogicSig.
      * @param args - An optional array of arguments for the program.
      */
-    constructor(program: Uint8Array, args?: Array<Uint8Array | Buffer> | null);
-    get_obj_for_encoding(): EncodedLogicSigAccount;
-    static from_obj_for_encoding(encoded: EncodedLogicSigAccount): LogicSigAccount;
+    constructor(program: Uint8Array, args?: Array<Uint8Array> | null);
+    getEncodingSchema(): encoding.Schema;
+    toEncodingData(): Map<string, unknown>;
+    static fromEncodingData(data: unknown): LogicSigAccount;
     /**
      * Encode this object into msgpack.
      */
@@ -103,7 +101,7 @@ export declare class LogicSigAccount {
      * If the LogicSig is not delegated to another account, this will return an
      *  escrow address that is the hash of the LogicSig's program code.
      */
-    address(): string;
+    address(): Address;
     /**
      * Turns this LogicSigAccount into a delegated LogicSig. This type of LogicSig
      * has the authority to sign transactions on behalf of another account, called
@@ -134,33 +132,6 @@ export declare class LogicSigAccount {
      */
     sign(secretKey: Uint8Array): void;
 }
-/**
- * signLogicSigTransactionObject takes a transaction and a LogicSig object and
- * returns a signed transaction.
- *
- * @param txn - The transaction to sign.
- * @param lsigObject - The LogicSig object that will sign the transaction.
- *
- * @returns Object containing txID and blob representing signed transaction.
- */
-export declare function signLogicSigTransactionObject(txn: txnBuilder.Transaction, lsigObject: LogicSig | LogicSigAccount): {
-    txID: string;
-    blob: Uint8Array;
-};
-/**
- * signLogicSigTransaction takes a transaction and a LogicSig object and returns
- * a signed transaction.
- *
- * @param txn - The transaction to sign.
- * @param lsigObject - The LogicSig object that will sign the transaction.
- *
- * @returns Object containing txID and blob representing signed transaction.
- * @throws error on failure
- */
-export declare function signLogicSigTransaction(txn: txnBuilder.TransactionLike, lsigObject: LogicSig | LogicSigAccount): {
-    txID: string;
-    blob: Uint8Array;
-};
 /**
  * logicSigFromByte accepts encoded logic sig bytes and attempts to call logicsig.fromByte on it,
  * returning the result
@@ -168,24 +139,23 @@ export declare function signLogicSigTransaction(txn: txnBuilder.TransactionLike,
 export declare function logicSigFromByte(encoded: Uint8Array): LogicSig;
 /**
  * tealSign creates a signature compatible with ed25519verify opcode from program hash
- * @param sk - uint8array with secret key
- * @param data - buffer with data to sign
+ * @param sk - Uint8Array with secret key
+ * @param data - Uint8Array with data to sign
  * @param programHash - string representation of teal program hash (= contract address for LogicSigs)
  */
-export declare function tealSign(sk: Uint8Array, data: Uint8Array | Buffer, programHash: string): Uint8Array;
+export declare function tealSign(sk: Uint8Array, data: Uint8Array, programHash: string | Address): Uint8Array;
 /**
  * verifyTealSign verifies a signature as would the ed25519verify opcode
- * @param data - buffer with original signed data
+ * @param data - Uint8Array with original signed data
  * @param programHash - string representation of teal program hash (= contract address for LogicSigs)
  * @param sig - uint8array with the signature to verify (produced by tealSign/tealSignFromProgram)
  * @param pk - uint8array with public key to verify against
  */
-export declare function verifyTealSign(data: Uint8Array | Buffer, programHash: string, sig: Uint8Array, pk: Uint8Array): boolean;
+export declare function verifyTealSign(data: Uint8Array, programHash: string | Address, sig: Uint8Array, pk: Uint8Array): boolean;
 /**
  * tealSignFromProgram creates a signature compatible with ed25519verify opcode from raw program bytes
  * @param sk - uint8array with secret key
- * @param data - buffer with data to sign
- * @param program - buffer with teal program
+ * @param data - Uint8Array with data to sign
+ * @param program - Uint8Array with teal program
  */
-export declare function tealSignFromProgram(sk: Uint8Array, data: Uint8Array | Buffer, program: Uint8Array): Uint8Array;
-export {};
+export declare function tealSignFromProgram(sk: Uint8Array, data: Uint8Array, program: Uint8Array): Uint8Array;

package/dist/types/main.d.ts

@@ -1,14 +1,14 @@
-import * as txnBuilder from './transaction';
-import { BidOptions } from './bid';
+import { Address } from './encoding/address.js';
+import { Transaction } from './transaction.js';
 export declare const MULTISIG_BAD_SENDER_ERROR_MSG = "The transaction sender address and multisig preimage do not match.";
 /**
  * signTransaction takes an object with either payment or key registration fields and
  * a secret key and returns a signed blob.
  *
- * Payment transaction fields: from, to, amount, fee, firstRound, lastRound, genesisHash,
+ * Payment transaction fields: from, to, amount, fee, firstValid, lastValid, genesisHash,
  * note(optional), GenesisID(optional), closeRemainderTo(optional)
  *
- * Key registration fields: fee, firstRound, lastRound, voteKey, selectionKey, voteFirst,
+ * Key registration fields: fee, firstValid, lastValid, voteKey, selectionKey, voteFirst,
  * voteLast, voteKeyDilution, genesisHash, note(optional), GenesisID(optional)
  *
  * If flatFee is not set and the final calculated fee is lower than the protocol minimum fee, the fee will be increased to match the minimum.
@@ -16,18 +16,10 @@ export declare const MULTISIG_BAD_SENDER_ERROR_MSG = "The transaction sender add
  * @param sk - Algorand Secret Key
  * @returns object contains the binary signed transaction and its txID
  */
-export declare function signTransaction(txn: txnBuilder.TransactionLike, sk: Uint8Array): {
+export declare function signTransaction(txn: Transaction, sk: Uint8Array): {
     txID: string;
     blob: Uint8Array;
 };
-/**
- * signBid takes an object with the following fields: bidder key, bid amount, max price, bid ID, auctionKey, auction ID,
- * and a secret key and returns a signed blob to be inserted into a transaction Algorand note field.
- * @param bid - Algorand Bid
- * @param sk - Algorand secret key
- * @returns Uint8Array binary signed bid
- */
-export declare function signBid(bid: BidOptions, sk: Uint8Array): Uint8Array;
 /**
  * signBytes takes arbitrary bytes and a secret key, prepends the bytes with "MX" for domain separation, signs the bytes
  * with the private key, and returns the signature.
@@ -44,46 +36,43 @@ export declare function signBytes(bytes: Uint8Array, sk: Uint8Array): Uint8Array
  * @param addr - string address
  * @returns bool
  */
-export declare function verifyBytes(bytes: Uint8Array, signature: Uint8Array, addr: string): boolean;
-/**
- * encodeObj takes a javascript object and returns its msgpack encoding
- * Note that the encoding sorts the fields alphabetically
- * @param o - js obj
- * @returns Uint8Array binary representation
- */
-export declare function encodeObj(o: Record<string | number | symbol, any>): Uint8Array;
-/**
- * decodeObj takes a Uint8Array and returns its javascript obj
- * @param o - Uint8Array to decode
- * @returns object
- */
-export declare function decodeObj(o: ArrayLike<number>): unknown;
+export declare function verifyBytes(bytes: Uint8Array, signature: Uint8Array, addr: string | Address): boolean;
 export declare const ERROR_MULTISIG_BAD_SENDER: Error;
 export declare const ERROR_INVALID_MICROALGOS: Error;
-export { default as Algodv2 } from './client/v2/algod/algod';
-export { default as Kmd } from './client/kmd';
-export { default as IntDecoding } from './types/intDecoding';
-export { default as Account } from './types/account';
-export { default as Indexer } from './client/v2/indexer/indexer';
-export { BaseHTTPClient, BaseHTTPClientResponse, BaseHTTPClientError, } from './client/baseHTTPClient';
-export { AlgodTokenHeader, IndexerTokenHeader, KMDTokenHeader, CustomTokenHeader, TokenHeader, } from './client/urlTokenBaseHTTPClient';
-export { waitForConfirmation } from './wait';
-export { isValidAddress, encodeAddress, decodeAddress, getApplicationAddress, } from './encoding/address';
-export { bytesToBigInt, bigIntToBytes } from './encoding/bigint';
-export { encodeUint64, decodeUint64 } from './encoding/uint64';
-export { default as generateAccount } from './account';
-export * as modelsv2 from './client/v2/algod/models/types';
-export * as indexerModels from './client/v2/indexer/models/types';
-export { mnemonicToMasterDerivationKey, masterDerivationKeyToMnemonic, secretKeyToMnemonic, mnemonicToSecretKey, seedFromMnemonic, mnemonicFromSeed, } from './mnemonic/mnemonic';
-export { microalgosToAlgos, algosToMicroalgos, INVALID_MICROALGOS_ERROR_MSG, } from './convert';
-export { computeGroupID, assignGroupID } from './group';
-export { LogicSig, LogicSigAccount, signLogicSigTransaction, signLogicSigTransactionObject, logicSigFromByte, tealSign, tealSignFromProgram, verifyTealSign, } from './logicsig';
-export { signMultisigTransaction, mergeMultisigTransactions, appendSignMultisigTransaction, createMultisigTransaction, appendSignRawMultisigSignature, verifyMultisig, multisigAddress, } from './multisig';
-export { SourceMap } from './logic/sourcemap';
-export * from './dryrun';
-export * from './makeTxn';
-export * from './transaction';
-export * from './signer';
-export * from './composer';
-export * from './types';
-export * from './abi';
+export { AlgodClient as Algodv2 } from './client/v2/algod/algod.js';
+export { KmdClient as Kmd } from './client/kmd.js';
+export { default as IntDecoding } from './types/intDecoding.js';
+export { default as Account } from './types/account.js';
+export { IndexerClient as Indexer } from './client/v2/indexer/indexer.js';
+export { BaseHTTPClient, BaseHTTPClientResponse, BaseHTTPClientError, } from './client/baseHTTPClient.js';
+export { AlgodTokenHeader, IndexerTokenHeader, KMDTokenHeader, CustomTokenHeader, TokenHeader, } from './client/urlTokenBaseHTTPClient.js';
+export { waitForConfirmation } from './wait.js';
+export { MsgpackEncodingData, JSONEncodingData, Encodable, EncodableClass, encodeObj, decodeObj, msgpackRawEncode, msgpackRawDecode, msgpackRawDecodeAsMap, encodeMsgpack, decodeMsgpack, encodeJSON, decodeJSON, } from './encoding/encoding.js';
+export { Address, isValidAddress, encodeAddress, decodeAddress, getApplicationAddress, ALGORAND_ZERO_ADDRESS_STRING, } from './encoding/address.js';
+export { bytesToBigInt, bigIntToBytes } from './encoding/bigint.js';
+export { base64ToBytes, bytesToBase64, bytesToString, coerceToBytes, bytesToHex, hexToBytes, } from './encoding/binarydata.js';
+export { encodeUint64, decodeUint64 } from './encoding/uint64.js';
+export { parseJSON, ParseJSONOptions, stringifyJSON } from './utils/utils.js';
+export { default as generateAccount } from './account.js';
+export * from './types/block.js';
+export * from './types/statedelta.js';
+export * from './stateproof.js';
+export { UntypedValue } from './client/v2/untypedmodel.js';
+export * as modelsv2 from './client/v2/algod/models/types.js';
+export * as indexerModels from './client/v2/indexer/models/types.js';
+export { mnemonicToMasterDerivationKey, masterDerivationKeyToMnemonic, secretKeyToMnemonic, mnemonicToSecretKey, seedFromMnemonic, mnemonicFromSeed, } from './mnemonic/mnemonic.js';
+export { microalgosToAlgos, algosToMicroalgos, INVALID_MICROALGOS_ERROR_MSG, } from './convert.js';
+export { computeGroupID, assignGroupID } from './group.js';
+export { SignedTransaction, decodeSignedTransaction, encodeUnsignedSimulateTransaction, } from './signedTransaction.js';
+export { signLogicSigTransaction, signLogicSigTransactionObject, } from './signing.js';
+export { LogicSig, LogicSigAccount, logicSigFromByte, tealSign, tealSignFromProgram, verifyTealSign, } from './logicsig.js';
+export { MultisigMetadata, verifyMultisig, multisigAddress, } from './multisig.js';
+export { signMultisigTransaction, mergeMultisigTransactions, appendSignMultisigTransaction, createMultisigTransaction, appendSignRawMultisigSignature, } from './multisigSigning.js';
+export { ProgramSourceMap, SourceLocation, PcLineLocation, } from './logic/sourcemap.js';
+export * from './dryrun.js';
+export * from './makeTxn.js';
+export * from './transaction.js';
+export * from './signer.js';
+export * from './composer.js';
+export * from './types/transactions/index.js';
+export * from './abi/index.js';