Skip to content

Commit 225d25b

Browse files
committed
Add field documentation to Model type
1 parent 4703b0b commit 225d25b

File tree

1 file changed

+8
-0
lines changed
  • contrib/core-contract-tests/tests/sip-031/commands

1 file changed

+8
-0
lines changed

contrib/core-contract-tests/tests/sip-031/commands/types.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,20 @@ export type Real = {
99
};
1010

1111
export interface Model {
12+
// Total STX balance currently held by SIP-031.
1213
balance: bigint;
14+
// Current block height used for vesting calculations.
1315
blockHeight: bigint;
16+
// SIP-031 constants including vesting parameters and error codes.
1417
constants: typeof contracts.sip031.constants;
18+
// Block height that marks when vesting becomes active.
1519
deployBlockHeight: bigint;
20+
// Flag indicating whether the initial funding has been transferred.
1621
initialized: boolean;
22+
// Current recipient address eligible to claim STX and update the recipient.
1723
recipient: string;
24+
// Running total of all STX that have been claimed from the contract.
1825
totalClaimed: bigint;
26+
// Map tracking command execution statistics for reporting purposes.
1927
statistics: Map<string, number>;
2028
}

0 commit comments

Comments
 (0)