Merge pull request #105 from tinymanorg/feat/order-client

feat(order): Create an ordering class for limit and recurring orders

Author: gulcinuras

dist/governance/util/utils.d.ts

@@ -1,4 +1,3 @@
-export declare function intToBytes(num: number, length?: number): Uint8Array;
 export declare function areBuffersEqual(buf1: Uint8Array, buf2: Uint8Array): boolean;
 export declare function bytesToInt(buffer: Uint8Array): number;
 export declare function sum(values: number[]): number;

dist/index.d.ts

@@ -3,7 +3,7 @@ export type { InitiatorSigner, SignerTransaction, SupportedNetwork } from "./uti
 export { BASE_MINIMUM_BALANCE, MINIMUM_ADD_LIQUIDITY_AMOUNT, MINIMUM_BALANCE_REQUIRED_PER_APP, MINIMUM_BALANCE_REQUIRED_PER_ASSET, MINIMUM_BALANCE_REQUIRED_PER_BYTE_SCHEMA, MINIMUM_BALANCE_REQUIRED_PER_INT_SCHEMA_VALUE } from "./util/constant";
 export * from "./swap/v2/router";
 export * from "./swap/common/utils";
-export { applySlippageToAmount, ASSET_OPT_IN_PROCESS_TXN_COUNT, convertFromBaseUnits, convertToBaseUnits, getTxnGroupID, sendAndWaitRawTransaction, sumUpTxnFees, joinByteArrays } from "./util/util";
+export { applySlippageToAmount, ASSET_OPT_IN_PROCESS_TXN_COUNT, convertFromBaseUnits, convertToBaseUnits, getTxnGroupID, sendAndWaitRawTransaction, sumUpTxnFees, joinByteArrays, intToBytes } from "./util/util";
 export { generateOptIntoAssetTxns } from "./util/asset/assetUtils";
 export type { AssetWithIdAndAmount, TinymanAnalyticsApiAsset } from "./util/asset/assetModels";
 export { ALGO_ASSET, ALGO_ASSET_ID, POOL_TOKEN_UNIT_NAME } from "./util/asset/assetConstants";
@@ -48,7 +48,8 @@ export { TinymanTAlgoClient } from "./liquid-stake/tAlgoClient";
 export { ProposalVote } from "./governance/proposal-voting/constants";
 export { generateProposalMetadata } from "./governance/proposal-voting/transactions";
 export type { GenerateProposalMetadataPayload } from "./governance/proposal-voting/types";
-export { intToBytes } from "./governance/util/utils";
 export { AccountState } from "./governance/vault/storage";
 export { getStartTimestampOfWeek } from "./governance/vault/utils";
 export { calculateTinyPower, combineAndRegroupTxns, generateCidFromProposalMetadata } from "./governance/utils";
+export { OrderingClient } from "./order/index";
+export type { PutTriggerOrderParams, PutRecurringOrderParams, OrderType } from "./order/types";

dist/index.js

@@ -1,7 +1,7 @@
 import algosdk from "algosdk";
-import TinymanBaseClient from "../util/client/base/baseClient";
 import { SupportedNetwork } from "../util/commonTypes";
-declare class TinymanSTAlgoClient extends TinymanBaseClient {
+import TinymanBaseClient from "../util/client/base/baseClient";
+declare class TinymanSTAlgoClient extends TinymanBaseClient<number, algosdk.Address> {
     vaultAppId: number;
     constructor(algod: algosdk.Algodv2, network: SupportedNetwork);
     increaseStake(amount: bigint, userAddress: string): Promise<algosdk.Transaction[]>;

dist/liquid-stake/stAlgoClient.d.ts

@@ -1,7 +1,7 @@
 import algosdk from "algosdk";
-import TinymanBaseClient from "../util/client/base/baseClient";
 import { SupportedNetwork } from "../util/commonTypes";
-declare class TinymanTAlgoClient extends TinymanBaseClient {
+import TinymanBaseClient from "../util/client/base/baseClient";
+declare class TinymanTAlgoClient extends TinymanBaseClient<number, algosdk.Address> {
     constructor(algod: algosdk.Algodv2, network: SupportedNetwork);
     sync(userAddress: string): Promise<algosdk.Transaction[]>;
     mint(amount: bigint, userAddress: string): Promise<algosdk.Transaction[]>;

dist/liquid-stake/tAlgoClient.d.ts

@@ -0,0 +1,27 @@
+import { StructDefinition } from "../util/client/base/types";
+import { SupportedNetwork } from "../util/commonTypes";
+import { OrderStruct } from "./types";
+declare const TOTAL_ORDER_COUNT_KEY: Uint8Array;
+declare const GOVERNOR_ORDER_FEE_RATE_KEY: Uint8Array;
+declare const GOVERNOR_FEE_RATE_POWER_THRESHOLD_KEY: Uint8Array;
+declare const ORDER_FEE_RATE_KEY: Uint8Array;
+declare const APP_LATEST_VERSION_KEY: Uint8Array;
+declare const APP_VERSION_KEY: Uint8Array;
+declare const ORDER_STRUCTS: Record<OrderStruct, StructDefinition>;
+declare const ORDER_APP_GLOBAL_SCHEMA: {
+    numUint: number;
+    numByteSlice: number;
+};
+declare const ORDER_APP_LOCAL_SCHEMA: {
+    numUint: number;
+    numByteSlice: number;
+};
+declare const ORDER_APP_EXTRA_PAGES = 3;
+declare const REGISTRY_APP_ID: Record<SupportedNetwork, number>;
+declare const VAULT_APP_ID: Record<SupportedNetwork, number>;
+declare const ROUTER_APP_ID: Record<SupportedNetwork, number>;
+declare const MINIMUM_BALANCE_REQUIREMENT_PER_APP = 100000;
+declare const MINIMUM_PUT_ORDER_TRANSACTION_COUNT = 5;
+declare const APPROVAL_PROGRAM = "CoASY3JlYXRlX2FwcGxpY2F0aW9ugBJ1cGRhdGVfYXBwbGljYXRpb26AC3Bvc3RfdXBkYXRlgAxhc3NldF9vcHRfaW6AEXB1dF90cmlnZ2VyX29yZGVygBRjYW5jZWxfdHJpZ2dlcl9vcmRlcoAbc3RhcnRfZXhlY3V0ZV90cmlnZ2VyX29yZGVygBllbmRfZXhlY3V0ZV90cmlnZ2VyX29yZGVygBNwdXRfcmVjdXJyaW5nX29yZGVygBZjYW5jZWxfcmVjdXJyaW5nX29yZGVygBdleGVjdXRlX3JlY3VycmluZ19vcmRlcoAHY29sbGVjdDYaAI4MAAEAEQAhAC0AQgBmAHYAjgCmAM4A3gEFADEYgQASRDYaAReIARCBAUMxGYEEEkQ2GgEXiAG6gQFDMRmBABJEiAI5gQFDMRmBABJENhoBSRWBQBJEiALBgQFDMRmBABJENhoBFzYaAhc2GgMXNhoEFzYaBRc2GgYXiALbgQFDMRmBABJENhoBF4gEF4EBQzEZgQASRDYaARc2GgIXNhoDF4gE/IEBQzEZgQASRDYaARc2GgIXNhoDF4gFmoEBQzEZgQASRDYaARc2GgIXNhoDFzYaBBc2GgUXNhoGFzYaBxeIB+OBAUMxGYEAEkQ2GgEXiAk5gQFDMRmBABJENhoBFzYaAkkVgUASRDYaA0kVgYACEkQ2GgQXiAmwgQFDMRmBABJENhoBFzYaAkkVgQESRIgGtYEBQzUBgAx1c2VyX2FkZHJlc3MxAGeAD3JlZ2lzdHJ5X2FwcF9pZDQBZzQBcghINQKAHHJlZ2lzdHJ5X2FwcF9hY2NvdW50X2FkZHJlc3M0Amc0AYAMdmF1bHRfYXBwX2lkZUg1A4AMdmF1bHRfYXBwX2lkNANnNAGADXJvdXRlcl9hcHBfaWRlSDUEgA1yb3V0ZXJfYXBwX2lkNARngAd2ZXJzaW9ugQJngAQPPg00MQA0ARY0AxZQUFCwiTUFgAx1c2VyX2FkZHJlc3NkNQYxADQGEkQxFoEBCDgYgA9yZWdpc3RyeV9hcHBfaWRkEkQxFoEBCDkaAIANdmVyaWZ5X3VwZGF0ZRJEMRaBAQg5GgE0BRYSRDEWgQIIOBgyCBJEMRaBAgg5GgCAC3Bvc3RfdXBkYXRlEkSABEZ071kxADQFFlBQsImADHVzZXJfYWRkcmVzc2Q1BzEANAcSRIECgAd2ZXJzaW9uZA1EgA9yZWdpc3RyeV9hcHBfaWRkNQg0CIAMdmF1bHRfYXBwX2lkZUg1CYAMdmF1bHRfYXBwX2lkNAlnNAiADXJvdXRlcl9hcHBfaWRlSDUKgA1yb3V0ZXJfYXBwX2lkNApngAd2ZXJzaW9ugQJngAT8pjz+gQIWULCJNQuADHVzZXJfYWRkcmVzc2Q1DDEANAwSRIEANQ00DYEIEkAAGDQLgQg0DQuBCFgXiAsyNA2BAQg1DUL/4Ik1DjUPNRA1ETUSNROADHVzZXJfYWRkcmVzc2Q1FDEANBQSRIALb3JkZXJfY291bnRkNRWAAW80FRZQSYFQuUQ1FjQSgQANRDQQgQANRDQTNBETRDQOFEEAEIH///////////8BNRdCAAcyBzQOCDUXNBFBAAwyCjQRcAA1GEg0GEQxFoEBCTIKNBM0EogKvIgJmTUZNBMWNBaBAE8CuzQSFjQWgQhPArs0ERY0FoEQTwK7NBAWNBaBGE8Cu4EAFjQWgSBPAruBABY0FoEoTwK7NA8WNBaBME8CuzQZFjQWgThPArsyBxY0FoFATwK7NBcWNBaBSE8Cu4ALb3JkZXJfY291bnQ0FYEBCGc0Fr5INRqAEXB1dF90cmlnZ2VyX29yZGVyNBQ0FRY0GlCICwiABBN6A8M0FDQVFjQaUFBQsIAEoI8xYzQVFlCwiTUbgAx1c2VyX2FkZHJlc3NkNRwxADQcEkSAAW80GxZQSb1EgVASRDUdNB2BCIEIuhc1HjQdgTCBCLoXQQANNB40HYEggQi6Fwk1HjQdgSiBCLoXFEQ0HYEAgQi6FzQeMgo0HIgKOzQdvkg1H4AUY2FuY2VsX3RyaWdnZXJfb3JkZXI0HDQbFogKYYAEE3oDwzQcNBsWNB9QUFCwgATZpb9wNBsWULA0HbxIiTUgNSE1IjUjNSQ0JDgAMQASRDQkOBCBBhJENCQ4GYEAEkQ0JDgYMggSRDQkORoANCMSRDQkORoBNCIWEkQ0JDkaAjQhFhJENCQ5GgM0IBYSRIk1JTUmNSeAAW80JxZQSb1EgVASRDUoNCWBAg9ENCiBCIEIuhc1KTQogTCBCLoXQQAWNCk0KIEggQi6Fwk1KTQmNCkOREIABjQmNCkSRDIHNCiBSIEIuhcORDEWNCUINSo0KoAZZW5kX2V4ZWN1dGVfdHJpZ2dlcl9vcmRlcjQnNCY0JYj/KDQogQCBCLoXNCYyCjEAiAkNgARteEGbgAx1c2VyX2FkZHJlc3NkNCcWMQBQUFCwiTUrNSw1LYAMdXNlcl9hZGRyZXNzZDUugAFvNC0WUEm9RIFQEkQ1LzEWNCsJNTA0MIAbc3RhcnRfZXhlY3V0ZV90cmlnZ2VyX29yZGVyNC00LDQriP6iNC+BMIEIuhcUQQANNC+BGIEIuhc1MUIAFzQvgQiBCLoXNC+BGIEIuhc0LIgGYTUxMRaBAQkyCjQvgRCBCLoXNDGIB/w1MjQvgSCBCLoXNCwIFjQvgSBPArs0MjQvgTiBCLoXiAZeNTM0M0Q0L4EogQi6FzQyNDMJCBY0L4EoTwK7NC++SDU0gBR1cGRhdGVfdHJpZ2dlcl9vcmRlcjQuNC0WNDRQiAg6gAQTegPDNC40LRY0NFBQULCABK4KflKADHVzZXJfYWRkcmVzc2Q0LRYxADQsFjQyFlBQUFBQsDQvgRCBCLoXNDMyCoAccmVnaXN0cnlfYXBwX2FjY291bnRfYWRkcmVzc2SIB4s0L4EIgQi6FzQvgSCBCLoXEkEAGzQvgRCBCLoXNC+BKIEIuhcyCjQuiAdgNC+8SIk1NTU2gAx1c2VyX2FkZHJlc3NkNTcxADQ3EkQ0NYABbxJBAEiAAW80NhZQSb1EgVASRDU6NDqBEIEIuhc1ODQ6gSiBCLoXNTmBABY0OoEoTwK7NDq+SDU7gAQTegPDNDc0NhY0O1BQULBCAFQ0NYABchJBAEiAAXI0NhZQSb1EgVgSRDU8NDyBEIEIuhc1ODQ8gRiBCLoXNTmBABY0PIEYTwK7NDy+SDU9gARvi/yfNDc0NhY0PVBQULBCAAOBAUM0OUQ0ODQ5Mgo0N4gGjYAEKgYeKzQ2FjQ5FlBQsIk1PjU/NUA1QTVCNUM1RIAMdXNlcl9hZGRyZXNzZDVFMQA0RRJEgAtvcmRlcl9jb3VudGQ1RoABcjRGFlBJgVi5RDVHNEOBAA1ENEQ0QhNEND+BAA1END6BPA9END6BPBgURDRAFEEADYH///////////8BNUA0QTRADkQ0QkEADDIKNEJwADVISDRIRDEWgQEJMgo0RDRDND8LiAU+iAQbNUk0RBY0R4EATwK7NEMWNEeBCE8CuzRCFjRHgRBPAruBABY0R4EYTwK7NEEWNEeBIE8CuzRAFjRHgShPArs0PxY0R4EwTwK7ND4WNEeBOE8CuzRJFjRHgUBPAruBABY0R4FITwK7MgcWNEeBUE8Cu4ALb3JkZXJfY291bnQ0RoEBCGc0R75INUqAE3B1dF9yZWN1cnJpbmdfb3JkZXI0RTRGFjRKUIgFfoAEb4v8nzRFNEYWNEpQUFCwgASH6GpLNEYWULCJNUuADHVzZXJfYWRkcmVzc2Q1TDEANEwSRIABcjRLFlBJvUSBWBJENU00TYEYgQi6FxRENE2BCIEIuhc0TYEwgQi6Fws1TjRNgQCBCLoXNE4yCjRMiATANE2+SDVPgBZjYW5jZWxfcmVjdXJyaW5nX29yZGVyNEw0SxaIBOSABG+L/J80TDRLFjRPUFBQsIAEPnsMZjRLFlCwNE28SIk1UDVRNVI1U4ABcjRTFlBJvUSBWBJENVSADHVzZXJfYWRkcmVzc2Q1VTEWgQASRDINgQASRDEAiAIDMgc0VIFIgQi6FzRUgTiBCLoXCA9ENFKBCIEAC4EIWBc0VIEAgQi6FxJENFKBCDRQC4EIWBc0VIEQgQi6FxJENFSBCIEIuhc0VIEggQi6FzRSNFE0UIgBDjVWNFY0VIEggQi6Fw80VjRUgSiBCLoXDhBENFY0VIFAgQi6F4gB7DVXNFdENFSBMIEIuheBAQkWNFSBME8CuzIHFjRUgUhPArs0VIEYgQi6FzRWNFcJCBY0VIEYTwK7NFS+SDVYgBZ1cGRhdGVfcmVjdXJyaW5nX29yZGVyNFU0UxY0WFCIA6mABG+L/J80VTRTFjRYUFBQsIAEoPcklTRVNFMWMQA0VIEIgQi6FxY0VhZQUFBQULA0VIEQgQi6FzRXMgqAHHJlZ2lzdHJ5X2FwcF9hY2NvdW50X2FkZHJlc3NkiAMBNFSBMIEIuhcUQQAbNFSBEIEIuhc0VIEYgQi6FzIKNFWIAt40VLxIiTVZNVo1WzVcNV2ADXJvdXRlcl9hcHBfaWRkcghINV40W4EINFkLgQhYFzVfMgo0X4gDMzVgiANUNFuBCIEAC4EIWBc0XTIKNF6IAo2IA0aBBrIQgQCyAYANcm91dGVyX2FwcF9pZGSyGIAEc3dhcLIaNF0Wsho0XBayGjRbsho0WrIaNFkWshqIAx+IAyQyCjRfiALRNGAJNWE0YYk1YjRigA9yZWdpc3RyeV9hcHBfaWRkgAtpc19lbmRvcnNlZGM1YzVkNGNENGQ1ZTRlRIk1ZjVnNWg0ZxaB////////////ARajNGgWojVpNGYWNGmjgf///////////wEWohc1ajRqiTVrNWw0bDRrC4GQTgo1bTRtiYAMdXNlcl9hZGRyZXNzZIgApjVxgA9yZWdpc3RyeV9hcHBfaWRkgCFnb3Zlcm5vcl9mZWVfcmF0ZV9wb3dlcl90aHJlc2hvbGRlSDVuNG41cjRxNHINQQAygA9yZWdpc3RyeV9hcHBfaWRkgBdnb3Zlcm5vcl9vcmRlcl9mZWVfcmF0ZWVINW9CACaAD3JlZ2lzdHJ5X2FwcF9pZGSADm9yZGVyX2ZlZV9yYXRlZUg1bzRvNXA0cIk1c4gBwYEGshCADHZhdWx0X2FwcF9pZGSyGIARZ2V0X3RpbnlfcG93ZXJfb2ayGjRzshqBALIBiAGhtD6BBFs1dDR0iTV1NHVBABwyCjR1cAA1dkg0doEAEkEACzR1gQAyCjIKiACjiTV3NXg1eTV6NHgUQQAbNHo4EIEBEkQ0ejgHNHkSRDR6OAg0dxJEQgAgNHo4EIEEEkQ0ejgUNHkSRDR6OBE0eBJENHo4EjR3EkSJNXs1fDV9NX40fBRBACE0fjgQgQESRDR+OAc0fRJENH44CDR7D0Q0fjgINX9CACY0fjgQgQQSRDR+OBQ0fRJENH44ETR8EkQ0fjgSNHsPRDR+OBI1fzR/iTWANYE1gjWDNIMUQQAdiACrgQGyEDSBsgA0gLIHNIKyCIEAsgGIAKlCAB6IAI6BBLIQNIGyADSAshQ0grISNIOyEYEAsgGIAIiJNYQ1hTWGiABpgQayEIEAsgGAD3JlZ2lzdHJ5X2FwcF9pZGSyGIAKZW1pdF9ldmVudLIaNIayGjSFsho0hLIaiABFiTWHNYiBADWJNIcUQQAMNIhgNIh4CTWJQgAJNIg0h3AASDWJNImJNIoURIEBNYqJNIqNAwABAAMACQCxibGBAjWKibaJNIpBAAGJs4mzgQA1iok=";
+declare const CLEAR_PROGRAM = "CoEBQw==";
+export { ORDER_APP_EXTRA_PAGES, ORDER_APP_GLOBAL_SCHEMA, ORDER_APP_LOCAL_SCHEMA, REGISTRY_APP_ID, ORDER_STRUCTS, TOTAL_ORDER_COUNT_KEY, VAULT_APP_ID, MINIMUM_BALANCE_REQUIREMENT_PER_APP, GOVERNOR_ORDER_FEE_RATE_KEY, GOVERNOR_FEE_RATE_POWER_THRESHOLD_KEY, ORDER_FEE_RATE_KEY, MINIMUM_PUT_ORDER_TRANSACTION_COUNT, APPROVAL_PROGRAM, CLEAR_PROGRAM, ROUTER_APP_ID, APP_LATEST_VERSION_KEY, APP_VERSION_KEY };

dist/order/constants.d.ts

@@ -0,0 +1,104 @@
+import algosdk, { Algodv2, Transaction } from "algosdk";
+import { OrderType, PutTriggerOrderParams, PutRecurringOrderParams } from "./types";
+import { SupportedNetwork } from "../util/commonTypes";
+import TinymanBaseClient from "../util/client/base/baseClient";
+declare class OrderingClient extends TinymanBaseClient<number | null, algosdk.Address | null> {
+    registryAppId: number;
+    registryApplicationAddress: string;
+    vaultAppId: number;
+    vaultApplicationAddress: string;
+    routerAppId: number;
+    routerApplicationAddress: string;
+    userAddress: string;
+    private constructor();
+    private static getRegistryEntryBoxName;
+    private static getOrderApplicationId;
+    /**
+     *  Initializes the OrderingClient by fetching the personal app id from global state.
+     *  Until the user creates an application, the app id will be set as null
+     */
+    static initializeOrderingClient(algod: Algodv2, network: SupportedNetwork, userAddress: string): Promise<OrderingClient>;
+    /**
+     * Compares the contracts between the user's order app and the latest available contract.
+     *
+     * @returns A boolean indicating if the order app needs to be updated.
+     */
+    shouldUpdateOrderingApp(): Promise<boolean>;
+    /**
+     * Prepares transactions to update the ordering app using the latest contracts.
+     * @returns A promise that resolves the transaction array.
+     */
+    prepareUpdateOrderingAppTransactions(): Promise<Transaction[]>;
+    calculateCreateOrderAppMinBalanceIncreaseAmount(): bigint;
+    /**
+     * Prepares transactions to create the order app for a user.
+     * @param userAddress - The address of the user.
+     * @returns A promise that resolves the transaction array.
+     */
+    prepareCreateOrderAppTransactions(userAddress: string): Promise<algosdk.Transaction[]>;
+    checkOrderAppAvailability(orderAppId?: number): Promise<void>;
+    getPutTriggerOrderTransactionFee({ assetInId, assetOutId, type }: {
+        assetInId: number;
+        assetOutId: number;
+        type: OrderType;
+    }): Promise<bigint>;
+    /**
+     * Prepares an array of transactions to place a limit order.
+     *
+     * @param {PutTriggerOrderParams} params - The parameters for the put order operation.
+     * @param params.assetInId - The ID of the input asset.
+     * @param params.assetOutId - The ID of the output asset.
+     * @param params.assetInAmount - The amount of the input asset in base units.
+     * @param params.assetOutAmount - The amount of the output asset in base units.
+     * @param params.isPartialAllowed - Whether partial fills are allowed.
+     * @param params.duration - The duration of the order in seconds.
+     * @param [params.orderAppId] - (Optional) The application ID for the order.
+     * @returns A promise that resolves the transaction array.
+     */
+    preparePutTriggerOrderTransactions({ assetInId, assetOutId, assetInAmount, assetOutAmount, isPartialAllowed, duration }: PutTriggerOrderParams): Promise<algosdk.Transaction[]>;
+    /**
+     * Prepares an array of transactions to place a recurring order.
+     *
+     * @param {PutRecurringOrderParams} params - The parameters for the recurring order.
+     * @param params.amount - The amount per order to be used for the recurring order.
+     * @param params.assetId - The ID of the asset being used for the order.
+     * @param params.targetAssetId - The ID of the target asset for the order.
+     * @param params.targetRecurrence - The number of times the order should recur.
+     * @param params.interval - The interval between each recurrence in seconds.
+     * @param params.maxTargetPrice - (Optional) The maximum price per unit of the target asset to be accepted.
+     * @param params.minTargetPrice - (Optional) The minimum price per unit of the target asset to be accepted.
+     * @returns A promise that resolves the transaction array.
+     */
+    preparePutRecurringOrderTransactions({ amount, assetId, targetAssetId, targetRecurrence, interval, maxTargetPrice, minTargetPrice }: PutRecurringOrderParams): Promise<algosdk.Transaction[]>;
+    /**
+     * Prepares an array of transactions to cancel an order.
+     *
+     * @param orderId - The ID of the order to cancel.
+     * @param type - The type of the order to cancel.
+     * @returns A promise that resolves the transaction array.
+     */
+    prepareCancelOrderTransactions(orderId: number, type: OrderType): Promise<algosdk.Transaction[]>;
+    /**
+     * Prepares an array of transactions to claim the collected target amount for an order.
+     * @param orderId - The ID of the order for which to claim the collected target amount.
+     * @param type - The type of the order (OrderType.Trigger or OrderType.Recurring).
+     * @returns A promise that resolves the transaction array.
+     */
+    prepareClaimCollectedTargetAmount(orderId: number, type: OrderType): Promise<algosdk.Transaction[]>;
+    /**
+     * Gets the platform fee rate based on the provided tiny power from the global state.
+     *
+     * @param tinyPower - The tiny power to check against the threshold.
+     * @returns The platform fee rate.
+     */
+    getPlatformFeeRate(tinyPower: number | null): Promise<bigint>;
+    private getOrderCount;
+    private getOrderBoxName;
+    private getRegistryEntryBoxName;
+    private prepareOrderAppAssetOptInTransaction;
+    private prepareOrderAppAssetOptinTransactionsIfNeeded;
+    private getAssetsToOptInToOrderingClient;
+    private getLatestOrderAppVersion;
+    private getAppVersionBoxName;
+}
+export { OrderingClient };

dist/order/index.d.ts

@@ -0,0 +1,27 @@
+export interface PutTriggerOrderParams {
+    assetInId: number;
+    assetOutId: number;
+    assetInAmount: bigint;
+    assetOutAmount: bigint;
+    isPartialAllowed: boolean;
+    duration: number;
+    orderAppId?: number;
+}
+export interface PutRecurringOrderParams {
+    assetId: number;
+    amount: bigint;
+    targetAssetId: number;
+    targetRecurrence: number;
+    interval: number;
+    minTargetPrice: number;
+    maxTargetPrice: number;
+}
+export declare enum OrderType {
+    Trigger = "trigger_order",
+    Recurring = "recurring_order"
+}
+export declare enum OrderStruct {
+    Trigger = "TriggerOrder",
+    Recurring = "RecurringOrder",
+    Entry = "Entry"
+}

dist/order/types.d.ts

@@ -0,0 +1,4 @@
+import { joinByteArrays } from "../util/util";
+declare function createPaddedByteArray(elements: number[], length?: number, paddingValue?: number, byteSize?: number): Uint8Array;
+declare function computeSHA512(fileArrayBuffer: Uint8Array): Promise<string>;
+export { computeSHA512, createPaddedByteArray, joinByteArrays };

dist/order/utils.d.ts

@@ -0,0 +1,32 @@
+import { Algodv2 } from "algosdk";
+import { StructDefinition } from "./types";
+import TinymanBaseClient from "./baseClient";
+import { SupportedNetwork } from "../../commonTypes";
+/**
+ * Abstract client for Tinyman applications that may not have an app ID initially
+ * This class overrides the base non-nullable properties to allow null values
+ */
+declare abstract class TinymanNullableAppClient extends TinymanBaseClient {
+    constructor(algod: Algodv2, appId: number | null, network: SupportedNetwork, structs?: Record<string, StructDefinition>);
+    /**
+     * Helper method to check if the app ID is available
+     */
+    protected isAppIdAvailable(): boolean;
+    /**
+     * Helper method that throws an error if the app ID is not available
+     */
+    protected requireAppId(): void;
+    /**
+     * Override getGlobal to add null check
+     */
+    protected getGlobal(key: Uint8Array, defaultValue?: any, appId?: number): Promise<any>;
+    /**
+     * Override boxExists to add null check
+     */
+    protected boxExists(boxName: Uint8Array, appId?: number): Promise<boolean>;
+    /**
+     * Override getBox to add null check
+     */
+    protected getBox(boxName: Uint8Array, structName: string, appId?: number): Promise<import("./utils").Struct | null>;
+}
+export default TinymanNullableAppClient;