tx attributes & integrator fees (#54)

* update txtypes

* add req and get for L2ApproveIntegrator

* add L1Sig capabilities for ApproveIntegrator, add SignApproveIntegrator to sharedlib

* Pass integrator attributes to create order tx

* Pass integrator attributes to modify order tx

* wasm + readme

---------

Co-authored-by: mihaimarcu <mihai2004marcu@gmail.com>

Author: lavrric

README.md

@@ -53,6 +53,9 @@ SignBurnShares
 === Staking ===
 SignStakeAssets
 SignUnstakeAssets
+
+=== Integrators ===
+SignApproveIntegrator
 ```
 
 ## How to specify an account

client/client.go

@@ -22,7 +22,7 @@ var (
 
 // GenerateAPIKey generates a new API key pair from a seed
 func GenerateAPIKey() (string, string, error) {
-	key := curve.SampleScalar(nil)
+	key := curve.SampleScalar()
 	publicKeyStr := hexutil.Encode(schnorr.SchnorrPkFromSk(key).ToLittleEndianBytes())
 	privateKeyStr := hexutil.Encode(key.ToLittleEndianBytes())
 

client/tx_get.go

@@ -231,3 +231,23 @@ func (c *TxClient) GetUnstakeAssetsTransaction(tx *types.UnstakeAssetsTxReq, ops
 	}
 	return txInfo, nil
 }
+
+func (c *TxClient) GetApproveIntegratorTx(tx *types.ApproveIntegratorTxReq, ops *types.TransactOpts) (*txtypes.L2ApproveIntegratorTxInfo, error) {
+	ops, err := c.FullFillDefaultOps(ops)
+	if err != nil {
+		return nil, err
+	}
+	txInfo, err := types.ConstructApproveIntegratorTx(c.keyManager, c.chainId, tx, ops)
+	if err != nil {
+		return nil, err
+	}
+
+	pk := c.keyManager.PubKeyBytes()
+	msgHash, _ := txInfo.Hash(c.chainId)
+
+	if err := schnorr.Validate(pk[:], msgHash, txInfo.Sig); err != nil {
+		return nil, fmt.Errorf("failed to validate signature. error: %v", err)
+	}
+
+	return txInfo, nil
+}

go.mod

@@ -5,7 +5,7 @@ go 1.23.0
 toolchain go1.23.1
 
 require (
-	github.com/elliottech/poseidon_crypto v0.0.11
+	github.com/elliottech/poseidon_crypto v0.0.15
 	github.com/ethereum/go-ethereum v1.15.6
 )
 

go.sum

@@ -20,8 +20,8 @@ github.com/decred/dcrd/crypto/blake256 v1.0.0 h1:/8DMNYp9SGi5f0w7uCm6d6M4OU2rGFK
 github.com/decred/dcrd/crypto/blake256 v1.0.0/go.mod h1:sQl2p6Y26YV+ZOcSTP6thNdn47hh8kt6rqSlvmrXFAc=
 github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1 h1:YLtO71vCjJRCBcrPMtQ9nqBsqpA1m5sE92cU+pd5Mcc=
 github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1/go.mod h1:hyedUtir6IdtD/7lIxGeCxkaw7y45JueMRL4DIyJDKs=
-github.com/elliottech/poseidon_crypto v0.0.11 h1:iX4rCg0m1XIX/7mhXVUEYUJIdQD57zNGNLeb6RZRl7g=
-github.com/elliottech/poseidon_crypto v0.0.11/go.mod h1:NhWxSjPGr5JXRuB2Aepl/+ZrbmUG3hvku/GarB1JR8c=
+github.com/elliottech/poseidon_crypto v0.0.15 h1:+f/YTnIFEWX1Xss75Ky7QRvhDpR372XAAMtpWxKvp+k=
+github.com/elliottech/poseidon_crypto v0.0.15/go.mod h1:/nFxH8V+3yk3eakI+Arlu5U8XwRXgydBvsiwfA/yYrg=
 github.com/ethereum/c-kzg-4844 v1.0.0 h1:0X1LBXxaEtYD9xsyj9B9ctQEZIpnvVDeoBx8aHEwTNA=
 github.com/ethereum/c-kzg-4844 v1.0.0/go.mod h1:VewdlzQmpT5QSrVhbBuGoCdFJkpaJlO1aQputP83wc0=
 github.com/ethereum/go-ethereum v1.15.6 h1:jgLoUM6/pNjp0uEnXyWcWikDwa4j1wZlcqkX8Pm8A+I=

sharedlib/main.go

@@ -36,7 +36,7 @@ typedef struct {
 } ApiKeyResponse;
 
 typedef struct {
-    uint8_t MarketIndex;
+    int16_t MarketIndex;
     int64_t ClientOrderIndex;
     int64_t BaseAmount;
     uint32_t Price;
@@ -46,6 +46,9 @@ typedef struct {
     uint8_t ReduceOnly;
     uint32_t TriggerPrice;
     int64_t OrderExpiry;
+	int64_t IntegratorAccountIndex;
+	int64_t IntegratorMakerFee;
+	int64_t IntegratorTakerFee;
 } CreateOrderTxReq;
 */
 import "C"
@@ -65,6 +68,8 @@ func messageToSign(txInfo txtypes.TxInfo) string {
 		return typed.GetL1SignatureBody()
 	case *txtypes.L2TransferTxInfo:
 		return typed.GetL1SignatureBody(chainId)
+	case *txtypes.L2ApproveIntegratorTxInfo:
+		return typed.GetL1SignatureBody(chainId)
 	default:
 		return ""
 	}
@@ -207,7 +212,7 @@ func SignChangePubKey(cPubKey *C.char, cNonce C.longlong, cApiKeyIndex C.int, cA
 }
 
 //export SignCreateOrder
-func SignCreateOrder(cMarketIndex C.int, cClientOrderIndex C.longlong, cBaseAmount C.longlong, cPrice C.int, cIsAsk C.int, cOrderType C.int, cTimeInForce C.int, cReduceOnly C.int, cTriggerPrice C.int, cOrderExpiry C.longlong, cNonce C.longlong, cApiKeyIndex C.int, cAccountIndex C.longlong) (ret C.SignedTxResponse) {
+func SignCreateOrder(cMarketIndex C.int, cClientOrderIndex C.longlong, cBaseAmount C.longlong, cPrice C.int, cIsAsk C.int, cOrderType C.int, cTimeInForce C.int, cReduceOnly C.int, cTriggerPrice C.int, cOrderExpiry C.longlong, cIntegratorAccountIndex C.int, cIntegratorTakerFee C.int, cIntegratorMakerFee C.int, cNonce C.longlong, cApiKeyIndex C.int, cAccountIndex C.longlong) (ret C.SignedTxResponse) {
 	defer func() {
 		if r := recover(); r != nil {
 			ret = signedTxResponsePanic(r)
@@ -230,21 +235,28 @@ func SignCreateOrder(cMarketIndex C.int, cClientOrderIndex C.longlong, cBaseAmou
 	triggerPrice := uint32(cTriggerPrice)
 	orderExpiry := int64(cOrderExpiry)
 
+	integratorAccountIndex := int(cIntegratorAccountIndex)
+	integratorMakerFee := int(cIntegratorMakerFee)
+	integratorTakerFee := int(cIntegratorTakerFee)
+
 	if orderExpiry == -1 {
 		orderExpiry = time.Now().Add(time.Hour * 24 * 28).UnixMilli() // 28 days
 	}
 
 	tx := &types.CreateOrderTxReq{
-		MarketIndex:      marketIndex,
-		ClientOrderIndex: clientOrderIndex,
-		BaseAmount:       baseAmount,
-		Price:            price,
-		IsAsk:            isAsk,
-		Type:             orderType,
-		TimeInForce:      timeInForce,
-		ReduceOnly:       reduceOnly,
-		TriggerPrice:     triggerPrice,
-		OrderExpiry:      orderExpiry,
+		MarketIndex:            marketIndex,
+		ClientOrderIndex:       clientOrderIndex,
+		BaseAmount:             baseAmount,
+		Price:                  price,
+		IsAsk:                  isAsk,
+		Type:                   orderType,
+		TimeInForce:            timeInForce,
+		ReduceOnly:             reduceOnly,
+		TriggerPrice:           triggerPrice,
+		OrderExpiry:            orderExpiry,
+		IntegratorAccountIndex: integratorAccountIndex,
+		IntegratorTakerFee:     integratorTakerFee,
+		IntegratorMakerFee:     integratorMakerFee,
 	}
 	ops := getTransactOpts(cNonce)
 
@@ -278,16 +290,19 @@ func SignCreateGroupedOrders(cGroupingType C.uint8_t, cOrders *C.CreateOrderTxRe
 		}
 
 		orders[i] = &types.CreateOrderTxReq{
-			MarketIndex:      int16(order.MarketIndex),
-			ClientOrderIndex: int64(order.ClientOrderIndex),
-			BaseAmount:       int64(order.BaseAmount),
-			Price:            uint32(order.Price),
-			IsAsk:            uint8(order.IsAsk),
-			Type:             uint8(order.Type),
-			TimeInForce:      uint8(order.TimeInForce),
-			ReduceOnly:       uint8(order.ReduceOnly),
-			TriggerPrice:     uint32(order.TriggerPrice),
-			OrderExpiry:      orderExpiry,
+			MarketIndex:            int16(order.MarketIndex),
+			ClientOrderIndex:       int64(order.ClientOrderIndex),
+			BaseAmount:             int64(order.BaseAmount),
+			Price:                  uint32(order.Price),
+			IsAsk:                  uint8(order.IsAsk),
+			Type:                   uint8(order.Type),
+			TimeInForce:            uint8(order.TimeInForce),
+			ReduceOnly:             uint8(order.ReduceOnly),
+			TriggerPrice:           uint32(order.TriggerPrice),
+			OrderExpiry:            orderExpiry,
+			IntegratorAccountIndex: int(order.IntegratorAccountIndex),
+			IntegratorTakerFee:     int(order.IntegratorTakerFee),
+			IntegratorMakerFee:     int(order.IntegratorMakerFee),
 		}
 	}
 
@@ -401,7 +416,7 @@ func SignCancelAllOrders(cTimeInForce C.int, cTime C.longlong, cNonce C.longlong
 }
 
 //export SignModifyOrder
-func SignModifyOrder(cMarketIndex C.int, cIndex C.longlong, cBaseAmount C.longlong, cPrice C.longlong, cTriggerPrice C.longlong, cNonce C.longlong, cApiKeyIndex C.int, cAccountIndex C.longlong) (ret C.SignedTxResponse) {
+func SignModifyOrder(cMarketIndex C.int, cIndex C.longlong, cBaseAmount C.longlong, cPrice C.longlong, cTriggerPrice C.longlong, cIntegratorAccountIndex C.int, cIntegratorTakerFee C.int, cIntegratorMakerFee C.int, cNonce C.longlong, cApiKeyIndex C.int, cAccountIndex C.longlong) (ret C.SignedTxResponse) {
 	defer func() {
 		if r := recover(); r != nil {
 			ret = signedTxResponsePanic(r)
@@ -419,12 +434,19 @@ func SignModifyOrder(cMarketIndex C.int, cIndex C.longlong, cBaseAmount C.longlo
 	price := uint32(cPrice)
 	triggerPrice := uint32(cTriggerPrice)
 
+	integratorAccountIndex := int(cIntegratorAccountIndex)
+	integratorMakerFee := int(cIntegratorMakerFee)
+	integratorTakerFee := int(cIntegratorTakerFee)
+
 	tx := &types.ModifyOrderTxReq{
-		MarketIndex:  marketIndex,
-		Index:        index,
-		BaseAmount:   baseAmount,
-		Price:        price,
-		TriggerPrice: triggerPrice,
+		MarketIndex:            marketIndex,
+		Index:                  index,
+		BaseAmount:             baseAmount,
+		Price:                  price,
+		TriggerPrice:           triggerPrice,
+		IntegratorAccountIndex: integratorAccountIndex,
+		IntegratorTakerFee:     integratorTakerFee,
+		IntegratorMakerFee:     integratorMakerFee,
 	}
 	ops := getTransactOpts(cNonce)
 
@@ -738,4 +760,36 @@ func SignUnstakeAssets(cStakingPoolIndex C.longlong, cShareAmount C.longlong, cN
 	return convertTxInfoToResponse(txInfo, err)
 }
 
+//export SignApproveIntegrator
+func SignApproveIntegrator(cIntegratorIndex C.longlong, cMaxPerpsTakerFee C.uint32_t, cMaxPerpsMakerFee C.uint32_t, cMaxSpotTakerFee C.uint32_t, cMaxSpotMakerFee C.uint32_t, cApprovalExpiry C.longlong, cNonce C.longlong, cApiKeyIndex C.int, cAccountIndex C.longlong) (ret C.SignedTxResponse) {
+	defer func() {
+		if r := recover(); r != nil {
+			ret = signedTxResponsePanic(r)
+		}
+	}()
+	c, err := getClient(cApiKeyIndex, cAccountIndex)
+	if err != nil {
+		return signedTxResponseErr(err)
+	}
+
+	IntegratorIndex := int64(cIntegratorIndex)
+	MaxPerpsMakerFee := uint32(cMaxPerpsMakerFee)
+	MaxPerpsTakerFee := uint32(cMaxPerpsTakerFee)
+	MaxSpotMakerFee := uint32(cMaxSpotMakerFee)
+	MaxSpotTakerFee := uint32(cMaxSpotTakerFee)
+	ApprovalExpiry := int64(cApprovalExpiry)
+
+	tx := &types.ApproveIntegratorTxReq{
+		IntegratorAccountIndex: IntegratorIndex,
+		MaxPerpsTakerFee:       MaxPerpsTakerFee,
+		MaxPerpsMakerFee:       MaxPerpsMakerFee,
+		MaxSpotTakerFee:        MaxSpotTakerFee,
+		MaxSpotMakerFee:        MaxSpotMakerFee,
+		ApprovalExpiry:         ApprovalExpiry,
+	}
+	ops := getTransactOpts(cNonce)
+	txInfo, err := c.GetApproveIntegratorTx(tx, ops)
+	return convertTxInfoToResponse(txInfo, err)
+}
+
 func main() {}

types/tx_request.go

@@ -43,16 +43,19 @@ type WithdrawTxReq struct {
 }
 
 type CreateOrderTxReq struct {
-	MarketIndex      int16
-	ClientOrderIndex int64
-	BaseAmount       int64
-	Price            uint32
-	IsAsk            uint8
-	Type             uint8
-	TimeInForce      uint8
-	ReduceOnly       uint8
-	TriggerPrice     uint32
-	OrderExpiry      int64
+	MarketIndex            int16
+	ClientOrderIndex       int64
+	BaseAmount             int64
+	Price                  uint32
+	IsAsk                  uint8
+	Type                   uint8
+	TimeInForce            uint8
+	ReduceOnly             uint8
+	TriggerPrice           uint32
+	OrderExpiry            int64
+	IntegratorAccountIndex int
+	IntegratorMakerFee     int
+	IntegratorTakerFee     int
 }
 
 type CreateGroupedOrdersTxReq struct {
@@ -61,11 +64,14 @@ type CreateGroupedOrdersTxReq struct {
 }
 
 type ModifyOrderTxReq struct {
-	MarketIndex  int16
-	Index        int64
-	BaseAmount   int64
-	Price        uint32
-	TriggerPrice uint32
+	MarketIndex            int16
+	Index                  int64
+	BaseAmount             int64
+	Price                  uint32
+	TriggerPrice           uint32
+	IntegratorAccountIndex int
+	IntegratorMakerFee     int
+	IntegratorTakerFee     int
 }
 
 type CancelOrderTxReq struct {
@@ -123,6 +129,15 @@ type UpdateMarginTxReq struct {
 	Direction   uint8
 }
 
+type ApproveIntegratorTxReq struct {
+	IntegratorAccountIndex int64
+	MaxPerpsTakerFee       uint32
+	MaxPerpsMakerFee       uint32
+	MaxSpotTakerFee        uint32
+	MaxSpotMakerFee        uint32
+	ApprovalExpiry         int64
+}
+
 func ConstructAuthToken(key signer.Signer, deadline time.Time, ops *TransactOpts) (string, error) {
 	if ops.FromAccountIndex == nil {
 		return "", fmt.Errorf("missing FromAccountIndex")
@@ -478,6 +493,28 @@ func ConstructUpdateMarginTx(key signer.Signer, lighterChainId uint32, tx *Updat
 	return convertedTx, nil
 }
 
+func ConstructApproveIntegratorTx(key signer.Signer, lighterChainId uint32, tx *ApproveIntegratorTxReq, ops *TransactOpts) (*txtypes.L2ApproveIntegratorTxInfo, error) {
+	convertedTx := ConvertApproveIntegratorTx(tx, ops)
+	err := convertedTx.Validate()
+	if err != nil {
+		return nil, err
+	}
+
+	msgHash, err := convertedTx.Hash(lighterChainId)
+	if err != nil {
+		return nil, err
+	}
+
+	signature, err := key.Sign(msgHash, p2.NewPoseidon2())
+	if err != nil {
+		return nil, err
+	}
+
+	convertedTx.SignedHash = ethCommon.Bytes2Hex(msgHash)
+	convertedTx.Sig = signature
+	return convertedTx, nil
+}
+
 func ConvertTransferTx(tx *TransferTxReq, ops *TransactOpts) *txtypes.L2TransferTxInfo {
 	return &txtypes.L2TransferTxInfo{
 		FromAccountIndex: *ops.FromAccountIndex,
@@ -511,6 +548,11 @@ func ConvertCreateOrderTx(tx *CreateOrderTxReq, ops *TransactOpts) *txtypes.L2Cr
 		},
 		ExpiredAt: ops.ExpiredAt,
 		Nonce:     *ops.Nonce,
+		L2TxAttributes: txtypes.L2TxAttributes{
+			txtypes.AttributeTypeIntegratorAccountIndex: tx.IntegratorAccountIndex,
+			txtypes.AttributeTypeIntegratorTakerFee:     tx.IntegratorTakerFee,
+			txtypes.AttributeTypeIntegratorMakerFee:     tx.IntegratorMakerFee,
+		},
 	}
 }
 
@@ -563,6 +605,11 @@ func ConvertModifyOrderTx(tx *ModifyOrderTxReq, ops *TransactOpts) *txtypes.L2Mo
 		TriggerPrice: tx.TriggerPrice,
 		ExpiredAt:    ops.ExpiredAt,
 		Nonce:        *ops.Nonce,
+		L2TxAttributes: txtypes.L2TxAttributes{
+			txtypes.AttributeTypeIntegratorAccountIndex: tx.IntegratorAccountIndex,
+			txtypes.AttributeTypeIntegratorTakerFee:     tx.IntegratorTakerFee,
+			txtypes.AttributeTypeIntegratorMakerFee:     tx.IntegratorMakerFee,
+		},
 	}
 }
 
@@ -744,3 +791,20 @@ func ConvertUnstakeAssetsTx(tx *UnstakeAssetsTxReq, ops *TransactOpts) *txtypes.
 		Nonce:            *ops.Nonce,
 	}
 }
+
+func ConvertApproveIntegratorTx(tx *ApproveIntegratorTxReq, ops *TransactOpts) *txtypes.L2ApproveIntegratorTxInfo {
+	return &txtypes.L2ApproveIntegratorTxInfo{
+		AccountIndex: *ops.FromAccountIndex,
+		ApiKeyIndex:  *ops.ApiKeyIndex,
+
+		IntegratorAccountIndex: tx.IntegratorAccountIndex,
+		MaxPerpsTakerFee:       tx.MaxPerpsTakerFee,
+		MaxPerpsMakerFee:       tx.MaxPerpsMakerFee,
+		MaxSpotTakerFee:        tx.MaxSpotTakerFee,
+		MaxSpotMakerFee:        tx.MaxSpotMakerFee,
+		ApprovalExpiry:         tx.ApprovalExpiry,
+
+		ExpiredAt: ops.ExpiredAt,
+		Nonce:     *ops.Nonce,
+	}
+}