@ember-finance/sdk 0.0.1

package/dist/src/vaults/on-chain-calls/tx-builder.d.ts

@@ -0,0 +1,252 @@
+import { DeploymentParser } from "../utils";
+import { IDeployment, ITxBuilderOptionalParams } from "../interfaces";
+import { NumStr, TransactionBlock } from "@firefly-exchange/library-sui";
+export declare class TxBuilder {
+    parser: DeploymentParser;
+    constructor(_deployment: IDeployment);
+    /**
+     * Pauses or unpauses the non-admin operations
+     * @param pause True if the non-admin operations should be paused, false otherwise
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    pauseNonAdminOperations(pause: boolean, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Increases the version of the protocol supported. Only admin can invoke this
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    increaseProtocolVersion(options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the platform fee recipient
+     * @param recipient Address of the platform fee recipient
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updatePlatformFeeRecipient(recipient: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the min rate
+     * @param minRate Minimum rate for the protocol
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateMinRate(minRate: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the max rate
+     * @param maxRate Maximum rate for the protocol
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateMaxRate(maxRate: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the max rate interval
+     * @param maxRateInterval Maximum rate interval for the protocol
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateMaxRateInterval(maxRateInterval: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the default rate
+     * @param defaultRate Default rate for the protocol
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateDefaultRate(defaultRate: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the max fee percentage
+     * @param maxFeePercentage Max fee percentage for the protocol
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateMaxFeePercentage(maxFeePercentage: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Creates a new vault
+     * @param depositCoinType Type of the deposit coin
+     * @param receiptCoinType Type of the receipt coin
+     * @param name Name of the vault
+     * @param admin Admin of the vault
+     * @param operator Operator of the vault
+     * @param maxRateChangePerUpdate Max rate change per update
+     * @param feePercentage Fee percentage
+     * @param minWithdrawalShares Min withdrawal shares
+     * @param rateUpdateInterval Rate update interval
+     * @param maxTVL Max TVL
+     * @param subAccounts Sub accounts
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    createVault(depositCoinType: string, receiptCoinType: string, name: string, admin: string, operator: string, maxRateChangePerUpdate: NumStr, feePercentage: NumStr, minWithdrawalShares: NumStr, rateUpdateInterval: NumStr, maxTVL: NumStr, subAccounts: string[], options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates vault admin
+     * @param vaultId Id of the vault
+     * @param admin Admin of the vault
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateVaultAdmin(vaultId: string, admin: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the paused status of the vault
+     * @param vaultId Id of the vault
+     * @param paused Paused status of the vault
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateVaultPausedStatus(vaultId: string, paused: boolean, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the operator of the vault
+     * @param vaultId Id of the vault
+     * @param operator Operator of the vault
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateVaultOperator(vaultId: string, operator: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the min withdrawal shares of the vault
+     * @param vaultId Id of the vault
+     * @param minWithdrawalShares Min withdrawal shares
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateVaultMinWithdrawalShares(vaultId: string, minWithdrawalShares: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Sets a sub account
+     * @param vaultId Id of the vault
+     * @param subAccount Sub account of the vault
+     * @param isActive Is active
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    setSubAccount(vaultId: string, subAccount: string, isActive: boolean, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates vault max TVL
+     * @param vaultId Id of the vault
+     * @param maxTVL Max TVL of the vault
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateVaultMaxTVL(vaultId: string, maxTVL: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the rate update interval of the vault
+     * @param vaultId Id of the vault
+     * @param rateUpdateInterval Rate update interval in ms
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateVaultRateUpdateInterval(vaultId: string, rateUpdateInterval: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the fee percentage of the vault
+     * @param vaultId Id of the vault
+     * @param feePercentage Fee percentage
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateVaultFeePercentage(vaultId: string, feePercentage: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Set min withdrawal shares
+     * @param vaultId Id of the vault
+     * @param minWithdrawalShares Min withdrawal shares
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    setMinWithdrawalShares(vaultId: string, minWithdrawalShares: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Sets a blacklisted account
+     * @param vaultId Id of the vault
+     * @param account Address of the account
+     * @param isBlacklisted Is blacklisted
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    setBlacklistedAccount(vaultId: string, account: string, isBlacklisted: boolean, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Updates the rate of the vault
+     * @param vaultId Id of the vault
+     * @param rate Rate of the vault
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    updateVaultRate(vaultId: string, rate: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Deposit to vault without minting shares
+     * @param vaultId Id of the vault
+     * @param subAccount Sub account of the vault
+     * @param coinId Id of the coin
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    depositToVaultWithoutMintingShares(vaultId: string, subAccount: string, coinId: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Withdraw from vault without redeeming shares
+     * @param vaultId Id of the vault
+     * @param subAccount Sub account of the vault
+     * @param amount Amount to withdraw
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    withdrawFromVaultWithoutRedeemingShares(vaultId: string, subAccount: string, amount: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Process withdrawal requests
+     * @param vaultId Id of the vault
+     * @param requestCount Max number of requests to process
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    processWithdrawalRequests(vaultId: string, requestCount: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Process withdrawal requests up to timestamp
+     * @param vaultId Id of the vault
+     * @param timestamp Timestamp
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    processWithdrawalRequestsUpToTimestamp(vaultId: string, timestamp: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Charge platform fee
+     * @param vaultId Id of the vault
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    chargePlatformFee(vaultId: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Collect platform fee
+     * @param vaultId Id of the vault
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    collectPlatformFee(vaultId: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Deposit asset
+     * @param vaultId Id of the vault
+     * @param coinId Id of the coin
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    depositAsset(vaultId: string, coinId: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Mint shares
+     * @param vaultId Id of the vault
+     * @param coinId Id of the coin
+     * @param shares Amount of shares
+     * @param receiver Address of the receiver
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    mintShares(vaultId: string, coinId: string, shares: NumStr, receiver: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Redeems shares
+     * @param vaultId Id of the vault
+     * @param sharesCoinId Id of the shares coin
+     * @param receiver Address of the receiver
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    redeemShares(vaultId: string, sharesCoinId: string, receiver: string, options?: ITxBuilderOptionalParams): TransactionBlock;
+    /**
+     * Cancel pending withdrawal request
+     * @param vaultId Id of the vault
+     * @param sequenceNumber Sequence number of the withdrawal request
+     * @param options Optional tx building params
+     * @returns TransactionBlock
+     */
+    cancelPendingWithdrawalRequest(vaultId: string, sequenceNumber: NumStr, options?: ITxBuilderOptionalParams): TransactionBlock;
+}