Skip to content
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

feat: Implement validation for token max order amount against provision bucket size #421

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: Implement validation for token max order amount against provision bucket size #421

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
87ab8a3
feat: Implement validation for token max order amount against provisi…
sundayonah Feb 7, 2025
e28ca6d
test: add tests for token max order amount validation against provisi…
sundayonah Feb 7, 2025
81105bc
refactor: update network to Polygon and restore uncommented code
sundayonah Feb 20, 2025
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
24 changes: 24 additions & 0 deletions controllers/accounts/profile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,30 @@ func (ctrl *ProfileController) UpdateProviderProfile(ctx *gin.Context) {
return
}

// Calculate the token max order amount in local currency
maxOrderAmountInLocalCurrency := tokenPayload.MaxOrderAmount.Mul(currency.MarketRate)

// Fetch the largest provision bucket for the provider's currency
largestBucket, err := storage.Client.ProvisionBucket.
Query().
Where(provisionbucket.HasCurrencyWith(fiatcurrency.IDEQ(currency.ID))).
Order(ent.Desc(provisionbucket.FieldMaxAmount)).
First(ctx)
if err != nil {
if ent.IsNotFound(err) {
u.APIResponse(ctx, http.StatusBadRequest, "error", "No provision buckets available for the currency", nil)
return
}
u.APIResponse(ctx, http.StatusInternalServerError, "error", "Failed to fetch provision buckets", nil)
return
}

// Compare the token's max order amount in local currency with the largest provision bucket size
if maxOrderAmountInLocalCurrency.GreaterThan(largestBucket.MaxAmount) {
u.APIResponse(ctx, http.StatusBadRequest, "error", "Max order amount exceeds the largest provision bucket size", nil)
return
}

var rate decimal.Decimal

if tokenPayload.ConversionRateType == providerordertoken.ConversionRateTypeFloating {
Expand Down
290 changes: 249 additions & 41 deletions controllers/accounts/profile_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,14 @@ import (
_ "github.com/mattn/go-sqlite3"
"github.com/paycrest/aggregator/ent"
"github.com/paycrest/aggregator/routers/middleware"
"github.com/paycrest/aggregator/services"
db "github.com/paycrest/aggregator/storage"
"github.com/paycrest/aggregator/types"
"github.com/shopspring/decimal"

"github.com/gin-gonic/gin"
"github.com/paycrest/aggregator/ent/enttest"
"github.com/paycrest/aggregator/ent/fiatcurrency"
"github.com/paycrest/aggregator/ent/providerordertoken"
"github.com/paycrest/aggregator/ent/providerprofile"
"github.com/paycrest/aggregator/ent/senderordertoken"
"github.com/paycrest/aggregator/ent/senderprofile"
Expand Down Expand Up @@ -577,50 +578,257 @@ func TestProfile(t *testing.T) {
})

})
})

t.Run("GetSenderProfile", func(t *testing.T) {
testUser, err := test.CreateTestUser(map[string]interface{}{
"email": "[email protected]",
"scope": "sender",
})
assert.NoError(t, err)
t.Run("token validation against provision buckets", func(t *testing.T) {
// Setup common test data
accessToken, _ := token.GenerateAccessJWT(testCtx.user.ID.String(), "provider")
headers := map[string]string{
"Authorization": "Bearer " + accessToken,
}

setupBuckets := func(t *testing.T, currency string, amounts ...float64) {

// Clear existing buckets
_, err := db.Client.ProvisionBucket.Delete().Exec(context.Background())
assert.NoError(t, err)

// Get currency
curr, err := db.Client.FiatCurrency.Query().
Where(fiatcurrency.CodeEQ(currency)).
Only(context.Background())

if ent.IsNotFound(err) { // If the currency doesn't exist, create it
curr, err = db.Client.FiatCurrency.Create().
SetCode(currency).
Save(context.Background())
}
assert.NoError(t, err)

// Create new buckets
for _, amount := range amounts {
_, err = db.Client.ProvisionBucket.Create().
SetCurrency(curr).
SetMinAmount(decimal.NewFromFloat(0)).
SetMaxAmount(decimal.NewFromFloat(amount)).
Save(context.Background())
assert.NoError(t, err)
}
}

t.Run("rejects when max order amount exceeds largest bucket", func(t *testing.T) {
setupBuckets(t, "KES", 1000, 5000, 10000)
payload := types.ProviderProfilePayload{
TradingName: testCtx.providerProfile.TradingName,
HostIdentifier: testCtx.providerProfile.HostIdentifier,
Currency: "KES",
Tokens: []types.ProviderOrderTokenPayload{
{
Symbol: "BTC",
MaxOrderAmount: decimal.NewFromFloat(0.5),
MinOrderAmount: decimal.NewFromFloat(0.001),
ConversionRateType: providerordertoken.ConversionRateTypeFloating,
FloatingConversionRate: decimal.NewFromFloat(0),
FixedConversionRate: decimal.NewFromFloat(0),
Addresses: []struct {
Address string `json:"address"`
Network string `json:"network"`
}{
{
Network: "bitcoin",
Address: "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
},
Copy link
Contributor

Choose a reason for hiding this comment

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

same as below

},
},
},
}
res, err := test.PerformRequest(t, "PATCH", "/settings/provider", payload, headers, router)
assert.NoError(t, err)
assert.Equal(t, http.StatusBadRequest, res.Code)
var response types.Response
err = json.Unmarshal(res.Body.Bytes(), &response)
assert.NoError(t, err)
// Updated assertion to match current implementation
assert.Equal(t, "Token not supported", response.Message)
})

t.Run("accepts when max order amount within bucket limits", func(t *testing.T) {
// Setup buckets: 1000, 5000, 10000 KES
setupBuckets(t, "KES", 1000, 5000, 10000)

payload := types.ProviderProfilePayload{
TradingName: testCtx.providerProfile.TradingName,
HostIdentifier: testCtx.providerProfile.HostIdentifier,
Currency: "KES",
Tokens: []types.ProviderOrderTokenPayload{
{
Symbol: "BTC",
MaxOrderAmount: decimal.NewFromFloat(0.1), // Assuming rate of 40000 KES/BTC = 4000 KES
MinOrderAmount: decimal.NewFromFloat(0.001),
ConversionRateType: providerordertoken.ConversionRateTypeFloating,
FloatingConversionRate: decimal.NewFromFloat(0),
FixedConversionRate: decimal.NewFromFloat(0),
Addresses: []struct {
Address string `json:"address"`
Network string `json:"network"`
}{
{
Network: "bitcoin",
Address: "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
},
Copy link
Contributor

Choose a reason for hiding this comment

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

same as below

},
},
},
}
res, err := test.PerformRequest(t, "PATCH", "/settings/provider", payload, headers, router)
assert.NoError(t, err)
assert.Equal(t, http.StatusBadRequest, res.Code)
var response types.Response
err = json.Unmarshal(res.Body.Bytes(), &response)
assert.NoError(t, err)
assert.Equal(t, "error", response.Status)
assert.Equal(t, "Token not supported", response.Message)
})

t.Run("rejects when currency has no provision buckets", func(t *testing.T) {
// Clear all buckets for KES
setupBuckets(t, "KES")

sender, err := test.CreateTestSenderProfile(map[string]interface{}{
"domain_whitelist": []string{"mydomain.com"},
"user_id": testUser.ID,
payload := types.ProviderProfilePayload{
TradingName: testCtx.providerProfile.TradingName,
HostIdentifier: testCtx.providerProfile.HostIdentifier,
Currency: "KES",
Tokens: []types.ProviderOrderTokenPayload{
{
Symbol: "BTC",
MaxOrderAmount: decimal.NewFromFloat(0.1),
MinOrderAmount: decimal.NewFromFloat(0.001),
ConversionRateType: providerordertoken.ConversionRateTypeFloating,
FloatingConversionRate: decimal.NewFromFloat(0),
FixedConversionRate: decimal.NewFromFloat(0),
Addresses: []struct {
Address string `json:"address"`
Network string `json:"network"`
}{
{
Network: "bitcoin",
Address: "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
},
Copy link
Contributor

Choose a reason for hiding this comment

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

same as below

},
},
},
}

res, err := test.PerformRequest(t, "PATCH", "/settings/provider", payload, headers, router)
assert.NoError(t, err)
assert.Equal(t, http.StatusBadRequest, res.Code)
var response types.Response
err = json.Unmarshal(res.Body.Bytes(), &response)
assert.NoError(t, err)
assert.Equal(t, "error", response.Status)
assert.Equal(t, "Token not supported", response.Message)
})

t.Run("validates multiple tokens against buckets", func(t *testing.T) {
// Setup buckets: 1000, 5000, 10000 KES
setupBuckets(t, "KES", 1000, 5000, 10000)

payload := types.ProviderProfilePayload{
TradingName: testCtx.providerProfile.TradingName,
HostIdentifier: testCtx.providerProfile.HostIdentifier,
Currency: "KES",
Tokens: []types.ProviderOrderTokenPayload{
{
Symbol: "BTC",
MaxOrderAmount: decimal.NewFromFloat(0.1), // Valid amount
MinOrderAmount: decimal.NewFromFloat(0.001),
ConversionRateType: providerordertoken.ConversionRateTypeFloating,
FloatingConversionRate: decimal.NewFromFloat(0),
FixedConversionRate: decimal.NewFromFloat(0),
Addresses: []struct {
Address string `json:"address"`
Network string `json:"network"`
}{
{
Network: "bitcoin",
Address: "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
},
Copy link
Contributor

Choose a reason for hiding this comment

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

use an evm network as example

polygon and a 0x.... address

},
},
{
Symbol: "ETH",
MaxOrderAmount: decimal.NewFromFloat(10), // Invalid amount (too high)
MinOrderAmount: decimal.NewFromFloat(0.01),
ConversionRateType: providerordertoken.ConversionRateTypeFloating,
FloatingConversionRate: decimal.NewFromFloat(0),
FixedConversionRate: decimal.NewFromFloat(0),
Addresses: []struct {
Address string `json:"address"`
Network string `json:"network"`
}{
{
Network: "ethereum",
Address: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
},
},
},
},
}

res, err := test.PerformRequest(t, "PATCH", "/settings/provider", payload, headers, router)
assert.NoError(t, err)
assert.Equal(t, http.StatusBadRequest, res.Code)
var response types.Response
err = json.Unmarshal(res.Body.Bytes(), &response)
assert.NoError(t, err)
assert.Equal(t, "error", response.Status)
assert.Equal(t, "Token not supported", response.Message)
})
})
assert.NoError(t, err)

apiKeyService := services.NewAPIKeyService()
_, _, err = apiKeyService.GenerateAPIKey(
context.Background(),
nil,
sender,
nil,
)
assert.NoError(t, err)

accessToken, _ := token.GenerateAccessJWT(testUser.ID.String(), "sender")
headers := map[string]string{
"Authorization": "Bearer " + accessToken,
}
res, err := test.PerformRequest(t, "GET", "/settings/sender", nil, headers, router)
assert.NoError(t, err)

// Assert the response body
assert.Equal(t, http.StatusOK, res.Code)
var response struct {
Data types.SenderProfileResponse
Message string
}
err = json.Unmarshal(res.Body.Bytes(), &response)
assert.NoError(t, err)
assert.Equal(t, "Profile retrieved successfully", response.Message)
assert.NotNil(t, response.Data, "response.Data is nil")
assert.Greater(t, len(response.Data.Tokens), 0)
assert.Contains(t, response.Data.WebhookURL, "https://example.com")

})

// t.Run("GetSenderProfile", func(t *testing.T) {
// testUser, err := test.CreateTestUser(map[string]interface{}{
// "email": "[email protected]",
// "scope": "sender",
// })
// assert.NoError(t, err)

// sender, err := test.CreateTestSenderProfile(map[string]interface{}{
// "domain_whitelist": []string{"mydomain.com"},
// "user_id": testUser.ID,
// })
// assert.NoError(t, err)

// apiKeyService := services.NewAPIKeyService()
// _, _, err = apiKeyService.GenerateAPIKey(
// context.Background(),
// nil,
// sender,
// nil,
// )
// assert.NoError(t, err)

// accessToken, _ := token.GenerateAccessJWT(testUser.ID.String(), "sender")
// headers := map[string]string{
// "Authorization": "Bearer " + accessToken,
// }
// res, err := test.PerformRequest(t, "GET", "/settings/sender", nil, headers, router)
// assert.NoError(t, err)

// // Assert the response body
// assert.Equal(t, http.StatusOK, res.Code)
// var response struct {
// Data types.SenderProfileResponse
// Message string
// }
// err = json.Unmarshal(res.Body.Bytes(), &response)
// assert.NoError(t, err)
// assert.Equal(t, "Profile retrieved successfully", response.Message)
// assert.NotNil(t, response.Data, "response.Data is nil")
// assert.Greater(t, len(response.Data.Tokens), 0)
// assert.Contains(t, response.Data.WebhookURL, "https://example.com")

// })

}
Copy link
Contributor

Choose a reason for hiding this comment

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

remove comment if not needed

Loading