Structs Library
Structs.sol is shared by CapTable, StockLib, TxHelper, and Adjustment.
Core
| Struct | Key fields |
|---|---|
Issuer | id, legal_name, shares_issued, shares_authorized |
StockClass | id, class_type, price_per_share, shares_issued, shares_authorized |
Stakeholder | id, stakeholder_type, current_relationship |
StockLegendTemplate | id |
Positions
| Struct | Key fields |
|---|---|
ActivePosition | stock_class_id, quantity, share_price, timestamp |
ActivePositions | activePositions[stakeholder_id][security_id] |
SecIdsStockClass | activeSecurityIdsByStockClass[stakeholder_id][stock_class_id] |
Initial seeding
| Struct | Key fields |
|---|---|
IssuerInitialShares | shares_authorized, shares_issued |
StockClassInitialShares | id, shares_authorized, shares_issued |
InitialShares | issuerInitialShares, stockClassesInitialShares |
Inputs
| Struct | Used by | Key fields |
|---|---|---|
ShareNumbersIssued | Issuance | starting_share_number, ending_share_number |
StockIssuanceParams | Issuance | stock_class_id, quantity, share_price, stakeholder_id, approvals, legends, comments |
StockTransferParams | Transfer | transferor_stakeholder_id, transferee_stakeholder_id, stock_class_id, is_buyer_verified, quantity, share_price, nonce, custom_id |
StockParams | Retraction, reissue, cancellation, repurchase | stakeholder_id, stock_class_id, security_id, comments, reason_text |
StockParamsQuantity | Cancellation, repurchase | nonce, quantity, stakeholder/security IDs, comments, reason text |
Transaction payloads
| Struct | Tx type | Key fields |
|---|---|---|
StockIssuance | TX_STOCK_ISSUANCE | id, object_type, security_id, params |
StockTransfer | TX_STOCK_TRANSFER | id, quantity, security_id, balance_security_id, resulting_security_ids |
StockCancellation | TX_STOCK_CANCELLATION | id, quantity, security_id, reason_text, balance_security_id |
StockRetraction | TX_STOCK_RETRACTION | id, security_id, reason_text, comments |
StockReissuance | TX_STOCK_REISSUANCE | id, security_id, resulting_security_ids, split_transaction_id, reason_text |
StockRepurchase | TX_STOCK_REPURCHASE | id, security_id, quantity, price, consideration_text, balance_security_id |
StockAcceptance | TX_STOCK_ACCEPTANCE | id, security_id, comments |
IssuerAuthorizedSharesAdjustment | TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT | id, new_shares_authorized, approvals, comments |
StockClassAuthorizedSharesAdjustment | TX_STOCK_CLASS_AUTHORIZED_SHARES_ADJUSTMENT | id, new_shares_authorized, approvals, comments |
IDs
| Type | Solidity | API |
|---|---|---|
| Issuer/stakeholder/class/security IDs | bytes16 | UUID strings converted by server utilities. |
| Onchain tx IDs | bytes16 | Decoded before MongoDB persistence. |
| Wallets | address | Hex EVM address strings. |
Route shapes: API Reference. Lifecycle behavior: Stock Functions.