Skip to content

refactor: restructure supply parameters and validation #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
murka wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor: restructure supply parameters and validation #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/constants/general/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ export const VALIDATION = {
ERRORS: {
INVALID_AMOUNT: 'Amount must be positive',
INVALID_SUBACCOUNT_ID: 'Subaccount ID must be between 0 and 255',
INVALID_EXTEND_SUPPLY_PARAMETERS: 'subaccountId, customPayloadRecipient, returnRepayRemainingsFlag, customPayloadSaturationFlag must be provided',
MISSING_JETTON_AMOUNT: 'Either amount, liquidationAmount, or supplyAmount must be provided',
MISSING_RESPONSE_ADDRESS: 'responseAddress, userAddress, or liquidatorAddress must be provided',
INVALID_ASSET_CONFIG: 'Invalid asset configuration provided',
Expand Down
99 changes: 67 additions & 32 deletions src/contracts/AbstractMaster.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@ export interface EvaaParameters {
}

/**
* Parameters for supply operations
* @interface SupplyParameters
* Base parameters for supply operations
* @type SupplyBaseParameters
*/
export interface SupplyParameters {
export type SupplyBaseParameters = {
/** Asset configuration for the supply operation */
readonly asset: PoolAssetConfig;
/** Unique identifier for this operation */
Expand All @@ -82,16 +82,30 @@ export interface SupplyParameters {
readonly forwardAmount?: bigint;
/** Operation payload cell */
readonly payload: Cell;
/** Optional subaccount identifier (0-255) */
readonly subaccountId?: number;
/** Whether to return repay remainings */
readonly returnRepayRemainingsFlag?: boolean;
/** Optional custom payload recipient address */
readonly customPayloadRecipient?: Address;
/** Whether to saturate custom payload */
readonly customPayloadSaturationFlag?: boolean;
}

/**
* Extended parameters for supply operations
* @type SupplyExtendParameters
*/
export type SupplyExtendParameters = SupplyBaseParameters & {
/** Optional subaccount identifier (0-255) */
readonly subaccountId: number;
/** Whether to return repay remainings */
readonly returnRepayRemainingsFlag: boolean;
/** Optional custom payload recipient address */
readonly customPayloadRecipient: Address;
/** Whether to saturate custom payload */
readonly customPayloadSaturationFlag: boolean;
};


/**
* Parameters for supply operations
* @type SupplyParameters
*/
export type SupplyParameters = SupplyBaseParameters | SupplyExtendParameters;

/**
* Parameters for withdraw operations
* @interface WithdrawParameters
Expand Down Expand Up @@ -343,16 +357,29 @@ export abstract class AbstractEvaaMaster<T extends MasterData<MasterConfig<Oracl

// ========== MESSAGE BUILDERS ==========
/**
* Validates supply operation parameters
* Validates supply extend operation parameters
* @private
* @static
* @param parameters - Supply parameters to validate
* @param parameters - Extend supply parameters to validate
* @throws {Error} When amount is invalid or subaccount ID is out of range
*/
private static validateSupplyParameters(parameters: SupplyParameters): void {
if (parameters.subaccountId !== undefined && !isValidSubaccountId(parameters.subaccountId)) {
throw new Error(`Supply validation failed: ${VALIDATION.ERRORS.INVALID_SUBACCOUNT_ID}`);
private isValidSupplyExtendParameters(parameters: SupplyExtendParameters) {
Copy link
Copy Markdown
Contributor Author

@murka murka Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn’t come up with anything better, waiting for your review.

if (
"subaccountId" in parameters &&
"returnRepayRemainingsFlag" in parameters &&
"customPayloadRecipient" in parameters &&
"customPayloadSaturationFlag" in parameters
) {
if (parameters.subaccountId !== undefined && !isValidSubaccountId(parameters.subaccountId)) {
throw new Error(
`Extend supply validation failed: ${VALIDATION.ERRORS.INVALID_SUBACCOUNT_ID}`,
);
}
return true
}

throw new Error(
`Extend supply validation failed: ${VALIDATION.ERRORS.INVALID_EXTEND_SUPPLY_PARAMETERS}`
)
}

/**
Expand All @@ -361,24 +388,32 @@ export abstract class AbstractEvaaMaster<T extends MasterData<MasterConfig<Oracl
* @returns {Cell} Complete supply message cell
* @throws {Error} When validation fails
*/
createSupplyMessage(parameters: SupplyParameters): Cell {
AbstractEvaaMaster.validateSupplyParameters(parameters);
createSupplyMessage(parameters: SupplyBaseParameters): Cell
Copy link
Copy Markdown
Contributor Author

@murka murka Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uses Function Overloads

createSupplyMessage(parameters: SupplyExtendParameters): Cell {

const subaccountId = parameters.subaccountId ?? 0;
const isTon = isTonAsset(parameters.asset);

const operationPayload = beginCell()
.storeUint(OPCODES.SUPPLY_MASTER, 32)
.storeBuilder(isTon ? beginCell().storeUint(parameters.queryID, 64) : beginCell())
.storeInt(parameters.includeUserCode ? -1 : 0, 2)
.storeBuilder(isTon ? beginCell().storeUint(parameters.amount, 64) : beginCell())
.storeAddress(parameters.userAddress)
.storeRef(parameters.payload)
.storeInt(subaccountId, 16)
.storeInt(parameters.returnRepayRemainingsFlag ? -1 : 0, 2)
.storeAddress(parameters.customPayloadRecipient)
.storeInt(parameters.customPayloadSaturationFlag ? -1 : 0, 2)
.endCell();
let operationPayloadBuilder = beginCell()
.storeUint(OPCODES.SUPPLY_MASTER, 32)
.storeBuilder(isTon ? beginCell().storeUint(parameters.queryID, 64) : beginCell())
.storeInt(parameters.includeUserCode ? -1 : 0, 2)
.storeBuilder(isTon ? beginCell().storeUint(parameters.amount, 64) : beginCell())
.storeAddress(parameters.userAddress)
.storeRef(parameters.payload)


if (this.isValidSupplyExtendParameters(parameters)) {
operationPayloadBuilder = operationPayloadBuilder
.storeInt(parameters.subaccountId ?? 0, 16)
.storeInt(parameters.returnRepayRemainingsFlag ? -1 : 0, 2)
.storeAddress(parameters.customPayloadRecipient)
.storeInt(
parameters.customPayloadSaturationFlag ? -1 : 0,
2,
);
}

const operationPayload = operationPayloadBuilder.endCell();

if (!isTon) {
return this.createJettonTransferMessage(parameters, FEES.SUPPLY, operationPayload);
Expand Down