Update documentation and error handling in tokenization module

trevormil · trevormil · commit a9e04c6f520e · 2026-02-18T07:28:44.000-05:00
- Added new error types for approval amounts and max number of transfers to improve internal state management.
- Updated the OwnershipQueryResponsePacket structure in the protobuf definition to reflect changes in field ordering and remove unused fields.
- Enhanced various documentation files to improve clarity and usability for developers, including API references and best practices.
- Cleaned up test cases and integration tests to align with the updated structures and error handling mechanisms.
diff --git a/contracts/docs/API_REFERENCE.md b/contracts/docs/API_REFERENCE.md
@@ -358,3 +358,6 @@ Most query methods return protobuf-encoded bytes. For production use:
 
 
 
+
+
+
diff --git a/contracts/docs/BEST_PRACTICES.md b/contracts/docs/BEST_PRACTICES.md
@@ -435,4 +435,7 @@ function testIntegrationTransfer() public {
 
 
 
+
+
+
 
diff --git a/contracts/docs/EVM_SEND_OPTIONS.md b/contracts/docs/EVM_SEND_OPTIONS.md
@@ -243,3 +243,6 @@ For simple (denom, amount) sends from EVM, **use the ERC20 wrapper approach** (O
 
 
 
+
+
+
diff --git a/contracts/docs/EXAMPLES.md b/contracts/docs/EXAMPLES.md
@@ -435,4 +435,7 @@ contract SubscriptionToken {
 
 
 
+
+
+
 
diff --git a/contracts/docs/GAMM_BEST_PRACTICES.md b/contracts/docs/GAMM_BEST_PRACTICES.md
@@ -360,4 +360,7 @@ function testSwap() public {
 
 
 
+
+
+
 
diff --git a/contracts/docs/GAMM_EXAMPLES.md b/contracts/docs/GAMM_EXAMPLES.md
@@ -363,4 +363,7 @@ contract CrossChainSwapBridge {
 
 
 
+
+
+
 
diff --git a/contracts/docs/GAMM_GETTING_STARTED.md b/contracts/docs/GAMM_GETTING_STARTED.md
@@ -153,4 +153,7 @@ function joinPoolWithBuilder(uint64 poolId, uint256 shareOutAmount) external {
 
 
 
+
+
+
 
diff --git a/contracts/docs/GAMM_PATTERNS.md b/contracts/docs/GAMM_PATTERNS.md
@@ -402,4 +402,7 @@ function calculateSwapOutput(
 
 
 
+
+
+
 
diff --git a/contracts/docs/GAMM_TROUBLESHOOTING.md b/contracts/docs/GAMM_TROUBLESHOOTING.md
@@ -358,4 +358,7 @@ function safeSwap(...) external {
 
 
 
+
+
+
 
diff --git a/contracts/docs/GAS_OPTIMIZATION.md b/contracts/docs/GAS_OPTIMIZATION.md
@@ -390,4 +390,7 @@ console.log("Gas used:", gasUsed);
 
 
 
+
+
+
 
diff --git a/contracts/docs/GETTING_STARTED.md b/contracts/docs/GETTING_STARTED.md
@@ -288,4 +288,7 @@ function transferWithCompliance(
 
 
 
+
+
+
 
diff --git a/contracts/docs/PATTERNS.md b/contracts/docs/PATTERNS.md
@@ -477,4 +477,7 @@ See [Best Practices](./BEST_PRACTICES.md) for more detailed guidance.
 
 
 
+
+
+
 
diff --git a/contracts/docs/SENDMANAGER_PRECOMPILE.md b/contracts/docs/SENDMANAGER_PRECOMPILE.md
@@ -323,3 +323,6 @@ The SendManager Precompile provides a simple, secure way to send native Cosmos c
 
 
 
+
+
+
diff --git a/contracts/docs/TROUBLESHOOTING.md b/contracts/docs/TROUBLESHOOTING.md
@@ -336,4 +336,7 @@ try TOKENIZATION.createCollection(json) returns (uint256 collectionId) {
 
 
 
+
+
+
 
diff --git a/contracts/libraries/GammBuilders.sol b/contracts/libraries/GammBuilders.sol
@@ -263,3 +263,6 @@ library GammBuilders {
 
 
 
+
+
+
diff --git a/contracts/libraries/GammErrors.sol b/contracts/libraries/GammErrors.sol
@@ -132,4 +132,7 @@ library GammErrors {
 
 
 
+
+
+
 
diff --git a/contracts/libraries/GammHelpers.sol b/contracts/libraries/GammHelpers.sol
@@ -119,4 +119,7 @@ library GammHelpers {
 
 
 
+
+
+
 
diff --git a/contracts/libraries/GammTestHelpers.sol b/contracts/libraries/GammTestHelpers.sol
@@ -166,4 +166,7 @@ library GammTestHelpers {
 
 
 
+
+
+
 
diff --git a/contracts/libraries/GammWrappers.sol b/contracts/libraries/GammWrappers.sol
@@ -285,3 +285,6 @@ library GammWrappers {
 
 
 
+
+
+
diff --git a/contracts/libraries/TokenizationBuilders.sol b/contracts/libraries/TokenizationBuilders.sol
@@ -519,3 +519,6 @@ library TokenizationBuilders {
 
 
 
+
+
+
diff --git a/contracts/test/HelperLibrariesTestContract.sol b/contracts/test/HelperLibrariesTestContract.sol
@@ -653,4 +653,7 @@ contract HelperLibrariesTestContract {
 
 
 
+
+
+
 
diff --git a/proto/tokenization/icq.proto b/proto/tokenization/icq.proto
@@ -38,14 +38,11 @@ message OwnershipQueryResponsePacket {
   // Total amount owned for the specified token IDs and ownership times
   string total_amount = 3 [(gogoproto.customtype) = "Uint", (gogoproto.nullable) = false];
 
-  // IAVL Merkle proof of the balance (for trustless verification)
-  bytes balance_proof = 4;
-
-  // Block height at which the proof was generated
-  uint64 proof_height = 5;
+  // Block height at which the response was generated
+  uint64 proof_height = 4;
 
   // Error message if the query failed (empty on success)
-  string error = 6;
+  string error = 5;
 }
 
 // BulkOwnershipQueryPacket allows querying multiple addresses/collections in a single IBC packet.
diff --git a/x/gamm/keeper/event_helpers.go b/x/gamm/keeper/event_helpers.go
@@ -48,3 +48,6 @@ func MarshalMessageForEvent(msg interface{}) (string, error) {
 
 
 
+
+
+
diff --git a/x/gamm/types/errors.go b/x/gamm/types/errors.go
@@ -108,4 +108,5 @@ var (
 	ErrHitMinScaledAssets         = errorsmod.Register(ModuleName, 66, "post-scaled pool assets can not be less than 1")
 	ErrNoGaugeToRedirect          = errorsmod.Register(ModuleName, 67, "could not find gauge to redirect")
 	ErrMustHaveTwoDenoms          = errorsmod.Register(ModuleName, 68, "can only have 2 denoms in CL pool")
+	ErrWeightOverflow             = errorsmod.Register(ModuleName, 69, "weight calculation overflow - asset weights too large")
 )
diff --git a/x/tokenization/keeper/approved_transfers.go b/x/tokenization/keeper/approved_transfers.go
@@ -513,7 +513,7 @@ func (k Keeper) GetMaxPossible(
 	// Get approval tracker details
 	// Check if ApprovalAmounts is nil before accessing
 	if approval.ApprovalCriteria.ApprovalAmounts == nil {
-		panic("ApprovalAmounts is nil")
+		return "", nil, types.ErrApprovalAmountsIsNil
 	}
 	amountsTrackerId := approval.ApprovalCriteria.ApprovalAmounts.AmountTrackerId
 
@@ -943,7 +943,7 @@ func (k Keeper) GetPredeterminedBalancesForPrecalculationId(
 
 		// Check if MaxNumTransfers is nil before accessing
 		if approvalCriteria.MaxNumTransfers == nil {
-			panic("MaxNumTransfers is nil")
+			return nil, types.ErrMaxNumTransfersIsNil
 		}
 		maxNumTransfersTrackerId := approvalCriteria.MaxNumTransfers.AmountTrackerId
 
diff --git a/x/tokenization/keeper/icq_queries.go b/x/tokenization/keeper/icq_queries.go
@@ -46,7 +46,6 @@ func (k Keeper) ProcessOwnershipQuery(
 			query.QueryId,
 			false,
 			sdkmath.ZeroUint(),
-			nil,
 			uint64(ctx.BlockHeight()),
 			"",
 		)
@@ -74,7 +73,6 @@ func (k Keeper) ProcessOwnershipQuery(
 		query.QueryId,
 		ownsTokens,
 		totalAmount,
-		nil, // balance_proof - not implemented yet
 		uint64(ctx.BlockHeight()),
 		"",
 	)
diff --git a/x/tokenization/keeper/icq_queries_test.go b/x/tokenization/keeper/icq_queries_test.go
@@ -318,7 +318,6 @@ func (suite *ICQTestSuite) TestOwnershipQueryResponsePacket_GetBytes() {
 		"query-1",
 		true,
 		sdkmath.NewUint(100),
-		nil,
 		12345,
 		"",
 	)
@@ -353,7 +352,7 @@ func (suite *ICQTestSuite) TestGetICQPacketType() {
 	suite.Require().Equal(types.ICQPacketTypeOwnershipQuery, types.GetICQPacketType(packetData))
 
 	// Test OwnershipQueryResponse
-	response := types.NewOwnershipQueryResponsePacket("q1", true, sdkmath.NewUint(1), nil, 0, "")
+	response := types.NewOwnershipQueryResponsePacket("q1", true, sdkmath.NewUint(1), 0, "")
 	packetData = &types.TokenizationPacketData{
 		Packet: &types.TokenizationPacketData_OwnershipQueryResponse{
 			OwnershipQueryResponse: response,
diff --git a/x/tokenization/keeper/pool_integration.go b/x/tokenization/keeper/pool_integration.go
@@ -348,8 +348,6 @@ func (k Keeper) SpendFromCommunityPoolViaAliasDenom(ctx sdk.Context, fromAddress
 	return k.SendNativeTokensViaAliasDenom(ctx, fromAddress, toAddress, denom, amount)
 }
 
-// TODO: For both of these, I'd love to DRY more with sendManager. I just need to handle the pre/post approvals (and also the prioritized correctly which isn't supported natively)
-
 // SendCoinsToPoolWithAliasRouting sends coins to a pool, wrapping tokenization denoms if needed.
 // IMPORTANT: Should ONLY be called when to address is a pool address
 // bankKeeper is required for sending non-tokenization coins
diff --git a/x/tokenization/keeper/transfers.go b/x/tokenization/keeper/transfers.go
@@ -128,7 +128,6 @@ func (k Keeper) HandleTransfers(ctx sdk.Context, collection *types.TokenCollecti
 					return err
 				}
 
-				// TODO: Deprecate this in favor of actually calculating the balances in indexer
 				amountsJsonData, err := json.Marshal(transfer)
 				if err != nil {
 					return err
diff --git a/x/tokenization/precompile/test/integration/solidity_contract_test.go b/x/tokenization/precompile/test/integration/solidity_contract_test.go
@@ -596,38 +596,6 @@ func (suite *SolidityContractTestSuite) TestSolidity_AllMethods_ThroughContract(
 	suite.T().Log("Testing all methods through contract - implementation pending contract ABI")
 }
 
-// TestSolidity_ReentrancyProtection tests reentrancy protection
-func (suite *SolidityContractTestSuite) TestSolidity_ReentrancyProtection() {
-	// Deploy contract first if not already deployed
-	if suite.TestContractAddr == (common.Address{}) {
-		if len(suite.ContractBytecode) == 0 {
-			suite.ContractBytecode = []byte{
-				0x60, 0x80, 0x60, 0x40, 0x52, 0x34, 0x80, 0x15, 0x60, 0x0f, 0x57, 0x60, 0x00, 0xfd, 0x5b,
-				0x50, 0x60, 0x3f, 0x80, 0x60, 0x1d, 0x60, 0x00, 0x39, 0x60, 0x00, 0xf3, 0xfe,
-			}
-		}
-		contractAddr, response, deployErr := helpers.DeployContract(
-			suite.Ctx,
-			suite.EVMKeeper,
-			suite.DeployerKey,
-			suite.ContractBytecode,
-			suite.ChainID,
-		)
-		if deployErr != nil {
-			if response != nil && response.GasUsed > 0 {
-				suite.T().Skip("Skipping test - contract deployment reverted.")
-				return
-			}
-			suite.Require().NoError(deployErr)
-		}
-		suite.TestContractAddr = contractAddr
-	}
-
-	// TODO: Create malicious contract that attempts reentrancy
-	// TODO: Verify protection works
-	suite.T().Log("Reentrancy protection test - implementation pending")
-}
-
 // TestSolidity_ErrorHandling tests error handling
 func (suite *SolidityContractTestSuite) TestSolidity_ErrorHandling() {
 	// Deploy contract first if not already deployed
diff --git a/x/tokenization/types/errors.go b/x/tokenization/types/errors.go
@@ -77,4 +77,6 @@ var (
 	ErrAmountNilInArbitraryValue                   = sdkerrors.Register(ModuleName, 1609, "amount is nil in ArbitraryValue")
 	ErrInvalidCheckType                            = sdkerrors.Register(ModuleName, 1610, "invalid checkType")
 	ErrUnrecognizedPacketType                      = sdkerrors.Register(ModuleName, 1611, "unrecognized packet type")
+	ErrApprovalAmountsIsNil                        = sdkerrors.Register(ModuleName, 1612, "approval amounts is nil - internal state error")
+	ErrMaxNumTransfersIsNil                        = sdkerrors.Register(ModuleName, 1613, "max num transfers is nil - internal state error")
 )
diff --git a/x/tokenization/types/icq.pb.go b/x/tokenization/types/icq.pb.go
diff --git a/x/tokenization/types/packet_icq.go b/x/tokenization/types/packet_icq.go

Original file line number	Diff line number	Diff line change
`@@ -358,3 +358,6 @@ Most query methods return protobuf-encoded bytes. For production use:`
`358`	`358`
`359`	`359`
`360`	`360`
	`361`	`+`
	`362`	`+`
	`363`	`+`
Original file line number	Diff line number	Diff line change
`@@ -435,4 +435,7 @@ function testIntegrationTransfer() public {`
`435`	`435`
`436`	`436`
`437`	`437`
	`438`	`+`
	`439`	`+`
	`440`	`+`
`438`	`441`
Original file line number	Diff line number	Diff line change
`@@ -243,3 +243,6 @@ For simple (denom, amount) sends from EVM, use the ERC20 wrapper approach (O`
`243`	`243`
`244`	`244`
`245`	`245`
	`246`	`+`
	`247`	`+`
	`248`	`+`
Original file line number	Diff line number	Diff line change
`@@ -435,4 +435,7 @@ contract SubscriptionToken {`
`435`	`435`
`436`	`436`
`437`	`437`
	`438`	`+`
	`439`	`+`
	`440`	`+`
`438`	`441`
Original file line number	Diff line number	Diff line change
`@@ -360,4 +360,7 @@ function testSwap() public {`
`360`	`360`
`361`	`361`
`362`	`362`
	`363`	`+`
	`364`	`+`
	`365`	`+`
`363`	`366`
Original file line number	Diff line number	Diff line change
`@@ -363,4 +363,7 @@ contract CrossChainSwapBridge {`
`363`	`363`
`364`	`364`
`365`	`365`
	`366`	`+`
	`367`	`+`
	`368`	`+`
`366`	`369`
Original file line number	Diff line number	Diff line change
`@@ -153,4 +153,7 @@ function joinPoolWithBuilder(uint64 poolId, uint256 shareOutAmount) external {`
`153`	`153`
`154`	`154`
`155`	`155`
	`156`	`+`
	`157`	`+`
	`158`	`+`
`156`	`159`
Original file line number	Diff line number	Diff line change
`@@ -402,4 +402,7 @@ function calculateSwapOutput(`
`402`	`402`
`403`	`403`
`404`	`404`
	`405`	`+`
	`406`	`+`
	`407`	`+`
`405`	`408`
Original file line number	Diff line number	Diff line change
`@@ -358,4 +358,7 @@ function safeSwap(...) external {`
`358`	`358`
`359`	`359`
`360`	`360`
	`361`	`+`
	`362`	`+`
	`363`	`+`
`361`	`364`
Original file line number	Diff line number	Diff line change
`@@ -390,4 +390,7 @@ console.log("Gas used:", gasUsed);`
`390`	`390`
`391`	`391`
`392`	`392`
	`393`	`+`
	`394`	`+`
	`395`	`+`
`393`	`396`