Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 13 additions & 1 deletion docs/services/storage/ttxdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,16 @@ The following example shows how to retrieve the total amount of transactions for
}
fmt.Printf("Transaction: %s\n", tx.ID())
}
```
```

## Composite Owners

An output owned by a composite identity (multisig, boolpolicy) carries one
audit row per member, so identity consumers (`ByRecipient`,
`RevocationHandles`) see every member. Amount aggregations — payments,
holdings, transaction records — count each `(output index, enrollment ID)`
pair once (`OutputStream.UniquePerOutput`), so members sharing an enrollment
ID do not multiply the recorded amount. A spent input is expanded the same
way, one row per member carrying the token's full quantity; sent-amount
aggregation counts each `(token ID, enrollment ID)` pair once
(`InputStream.UniquePerInput`).
12 changes: 6 additions & 6 deletions integration/token/fungible/views/auditor.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ func (a *AuditView) Call(context view.Context) (any, error) {
continue
}
// compute the payment done in the transaction
sent := inputs.ByEnrollmentID(eID).ByType(tokenType).Sum()
received := outputs.ByEnrollmentID(eID).ByType(tokenType).Sum()
sent := inputs.ByEnrollmentID(eID).ByType(tokenType).UniquePerInput().Sum()
received := outputs.ByEnrollmentID(eID).ByType(tokenType).UniquePerOutput().Sum()
fmt.Printf("Payment Limit: [%s] Sent [%d], Received [%d], type [%s]\n", eID, sent.Int64(), received.Int64(), tokenType)

diff := big.NewInt(0).Sub(sent, received)
Expand All @@ -97,8 +97,8 @@ func (a *AuditView) Call(context view.Context) (any, error) {
continue
}
// compute the payment done in the transaction
sent := inputs.ByEnrollmentID(eID).ByType(tokenType).Sum()
received := outputs.ByEnrollmentID(eID).ByType(tokenType).Sum()
sent := inputs.ByEnrollmentID(eID).ByType(tokenType).UniquePerInput().Sum()
received := outputs.ByEnrollmentID(eID).ByType(tokenType).UniquePerOutput().Sum()
fmt.Printf("Cumulative Limit: [%s] Sent [%d], Received [%d], type [%s]\n", eID, sent.Int64(), received.Int64(), tokenType)

diff := sent.Sub(sent, received)
Expand Down Expand Up @@ -129,8 +129,8 @@ func (a *AuditView) Call(context view.Context) (any, error) {
continue
}
// compute the amount received
received := outputs.ByEnrollmentID(eID).ByType(tokenType).Sum()
sent := inputs.ByEnrollmentID(eID).ByType(tokenType).Sum()
received := outputs.ByEnrollmentID(eID).ByType(tokenType).UniquePerOutput().Sum()
sent := inputs.ByEnrollmentID(eID).ByType(tokenType).UniquePerInput().Sum()
fmt.Printf("Holding Limit: [%s] Sent [%d], Received [%d], type [%s]\n", eID, sent.Int64(), received.Int64(), tokenType)

diff := received.Sub(received, sent)
Expand Down
4 changes: 2 additions & 2 deletions integration/token/interop/views/auditor.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ func (a *AuditView) Call(context view.Context) (any, error) {
assert.NotEmpty(eID, "enrollment id should not be empty")
for _, tokenType := range tokenTypes {
// compute the payment done in the transaction
sent := inputs.ByEnrollmentID(eID).ByType(tokenType).Sum()
received := outputs.ByEnrollmentID(eID).ByType(tokenType).Sum()
sent := inputs.ByEnrollmentID(eID).ByType(tokenType).UniquePerInput().Sum()
received := outputs.ByEnrollmentID(eID).ByType(tokenType).UniquePerOutput().Sum()
logger.Debugf("Payment Limit: [%s] Sent [%d], Received [%d], type [%s]", eID, sent.Int64(), received.Int64(), tokenType)

diff := big.NewInt(0).Sub(sent, received)
Expand Down
224 changes: 224 additions & 0 deletions token/request_composite_output_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
/*
Copyright IBM Corp. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0
*/

package token

import (
"testing"

"github.com/LFDT-Panurus/panurus/token/driver"
driver2 "github.com/LFDT-Panurus/panurus/token/driver/mock"
"github.com/LFDT-Panurus/panurus/token/driver/protos-go/v1/request"
"github.com/LFDT-Panurus/panurus/token/services/logging"
"github.com/LFDT-Panurus/panurus/token/token"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

// stubLedgerOutput is a minimal driver.Output for extract*Outputs tests.
type stubLedgerOutput struct {
raw []byte
}

func (s *stubLedgerOutput) Serialize() ([]byte, error) { return s.raw, nil }
func (s *stubLedgerOutput) IsRedeem() bool { return false }
func (s *stubLedgerOutput) GetOwner() []byte { return []byte("policy-owner") }

// compositeRecipients returns the two member identities and the output
// metadata carrying them as receivers of a single ledger output.
func compositeRecipients() ([]Identity, []*driver.AuditableIdentity) {
m0 := Identity("member-0")
m1 := Identity("member-1")
receivers := []*driver.AuditableIdentity{
{Identity: m0, AuditInfo: []byte("audit-info-0")},
{Identity: m1, AuditInfo: []byte("audit-info-1")},
}

return []Identity{m0, m1}, receivers
}

// newCompositeTransferRequest builds a Request holding one transfer action
// with a single 40-unit output owned by a composite identity whose two
// members are enumerated as recipients.
func newCompositeTransferRequest(t *testing.T, ws *driver2.WalletService) *Request {
t.Helper()
recipients, receivers := compositeRecipients()

transferAction := &driver2.TransferAction{}
transferAction.NumInputsReturns(0)
transferAction.NumOutputsReturns(1)
transferAction.GetOutputsReturns([]driver.Output{&stubLedgerOutput{raw: []byte("ledger-output")}})

transferService := &driver2.TransferService{}
transferService.DeserializeTransferActionReturns(transferAction, nil)

tokensService := &driver2.TokensService{}
tokensService.DeobfuscateReturns(
&token.Token{Owner: Identity("policy-owner"), Type: "USD", Quantity: "0x28"},
nil, recipients, token.Format("fabtoken"), nil)

pp := &driver2.PublicParameters{}
pp.PrecisionReturns(64)
ppm := &driver2.PublicParamsManager{}
ppm.PublicParametersReturns(pp)

tms := &driver2.TokenManagerService{}
tms.TransferServiceReturns(transferService)
tms.IssueServiceReturns(&driver2.IssueService{})
tms.TokensServiceReturns(tokensService)
tms.WalletServiceReturns(ws)
tms.PublicParamsManagerReturns(ppm)

return &Request{
Anchor: "composite-anchor",
Actions: &driver.TokenRequest{
Actions: []*driver.TypedAction{
{Type: request.ActionType_ACTION_TYPE_TRANSFER, Raw: []byte("transfer1")},
},
},
Metadata: &driver.TokenRequestMetadata{
Actions: []*driver.ActionMetadataEntry{
{
ActionID: 0,
TransferMetadata: &driver.TransferMetadata{
Outputs: []*driver.TransferOutputMetadata{
{
OutputMetadata: []byte("output-metadata"),
OutputAuditInfo: []byte("output-audit-info"),
Receivers: receivers,
},
},
},
},
},
},
TokenService: &ManagementService{
tms: tms,
logger: logging.MustGetLogger(),
},
}
}

// TestRequest_Outputs_CompositeSameEIDKeepsMemberRows checks that every
// member of a composite owner keeps its own output row (identity and
// revocation handle stay visible), while UniquePerOutput collapses the rows
// so eid-keyed sums count the output amount exactly once.
func TestRequest_Outputs_CompositeSameEIDKeepsMemberRows(t *testing.T) {
ws := &driver2.WalletService{}
ws.GetEIDAndRHReturnsOnCall(0, "wallet-42", "rh-0", nil)
ws.GetEIDAndRHReturnsOnCall(1, "wallet-42", "rh-1", nil)

outputs, err := newCompositeTransferRequest(t, ws).Outputs(t.Context())
require.NoError(t, err)

// one row per member, same physical output index
require.Equal(t, 2, outputs.Count())
assert.Equal(t, "wallet-42", outputs.At(0).EnrollmentID)
assert.Equal(t, "wallet-42", outputs.At(1).EnrollmentID)
assert.Equal(t, outputs.At(0).Index, outputs.At(1).Index)

// identity consumers still see every member
assert.Equal(t, 1, outputs.ByRecipient(Identity("member-0")).Count())
assert.Equal(t, 1, outputs.ByRecipient(Identity("member-1")).Count())
assert.Equal(t, []string{"rh-0", "rh-1"}, outputs.RevocationHandles())

// economic view counts the amount once
assert.Equal(t, "40", outputs.ByEnrollmentID("wallet-42").UniquePerOutput().Sum().String())
}

// TestRequest_Outputs_CompositeDistinctEIDsKeepRows checks that members
// spanning enrollments keep one row each (cross-enrollment visibility).
func TestRequest_Outputs_CompositeDistinctEIDsKeepRows(t *testing.T) {
ws := &driver2.WalletService{}
ws.GetEIDAndRHReturnsOnCall(0, "wallet-42", "", nil)
ws.GetEIDAndRHReturnsOnCall(1, "wallet-43", "", nil)

outputs, err := newCompositeTransferRequest(t, ws).Outputs(t.Context())
require.NoError(t, err)

require.Equal(t, 2, outputs.Count())
assert.Equal(t, "wallet-42", outputs.At(0).EnrollmentID)
assert.Equal(t, "wallet-43", outputs.At(1).EnrollmentID)
}

// newCompositeIssueRequest is the issue-action twin of
// newCompositeTransferRequest: one 40-unit issued output, two members.
func newCompositeIssueRequest(t *testing.T, ws *driver2.WalletService) *Request {
t.Helper()
recipients, receivers := compositeRecipients()
issuer := Identity("issuer-1")

issueAction := &driver2.IssueAction{}
issueAction.NumInputsReturns(0)
issueAction.NumOutputsReturns(1)
issueAction.GetOutputsReturns([]driver.Output{&stubLedgerOutput{raw: []byte("ledger-output")}})
issueAction.GetIssuerReturns(issuer)

issueService := &driver2.IssueService{}
issueService.DeserializeIssueActionReturns(issueAction, nil)

tokensService := &driver2.TokensService{}
tokensService.DeobfuscateReturns(
&token.Token{Owner: Identity("policy-owner"), Type: "USD", Quantity: "0x28"},
issuer, recipients, token.Format("fabtoken"), nil)

pp := &driver2.PublicParameters{}
pp.PrecisionReturns(64)
ppm := &driver2.PublicParamsManager{}
ppm.PublicParametersReturns(pp)

tms := &driver2.TokenManagerService{}
tms.IssueServiceReturns(issueService)
tms.TransferServiceReturns(&driver2.TransferService{})
tms.TokensServiceReturns(tokensService)
tms.WalletServiceReturns(ws)
tms.PublicParamsManagerReturns(ppm)

return &Request{
Anchor: "composite-issue-anchor",
Actions: &driver.TokenRequest{
Actions: []*driver.TypedAction{
{Type: request.ActionType_ACTION_TYPE_ISSUE, Raw: []byte("issue1")},
},
},
Metadata: &driver.TokenRequestMetadata{
Actions: []*driver.ActionMetadataEntry{
{
ActionID: 0,
IssueMetadata: &driver.IssueMetadata{
Issuer: driver.AuditableIdentity{Identity: issuer},
Outputs: []*driver.IssueOutputMetadata{
{
OutputMetadata: []byte("output-metadata"),
OutputAuditInfo: []byte("output-audit-info"),
Receivers: receivers,
},
},
},
},
},
},
TokenService: &ManagementService{
tms: tms,
logger: logging.MustGetLogger(),
},
}
}

// TestRequest_Outputs_IssueCompositeSameEIDKeepsMemberRows is the issue-side
// twin of TestRequest_Outputs_CompositeSameEIDKeepsMemberRows.
func TestRequest_Outputs_IssueCompositeSameEIDKeepsMemberRows(t *testing.T) {
ws := &driver2.WalletService{}
ws.GetEIDAndRHReturnsOnCall(0, "wallet-42", "rh-0", nil)
ws.GetEIDAndRHReturnsOnCall(1, "wallet-42", "rh-1", nil)

outputs, err := newCompositeIssueRequest(t, ws).Outputs(t.Context())
require.NoError(t, err)

require.Equal(t, 2, outputs.Count())
assert.Equal(t, []string{"rh-0", "rh-1"}, outputs.RevocationHandles())
assert.Equal(t, "40", outputs.ByEnrollmentID("wallet-42").UniquePerOutput().Sum().String())
}
6 changes: 3 additions & 3 deletions token/services/storage/ttxdb/store.go
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ func TransactionRecords(ctx context.Context, record *token.AuditRecord, timestam
outTT := ous.TokenTypes()
for _, outEID := range outEIDs {
for _, tokenType := range outTT {
received := ous.ByEnrollmentID(outEID).ByType(tokenType).Sum()
received := ous.ByEnrollmentID(outEID).ByType(tokenType).UniquePerOutput().Sum()
if received.Cmp(big.NewInt(0)) <= 0 {
continue
}
Expand Down Expand Up @@ -431,8 +431,8 @@ func Movements(ctx context.Context, record *token.AuditRecord, created time.Time

for _, eID := range eIDs {
for _, tokenType := range tokenTypes {
received := outputs.ByEnrollmentID(eID).ByType(tokenType).Sum()
sent := inputs.ByEnrollmentID(eID).ByType(tokenType).Sum()
received := outputs.ByEnrollmentID(eID).ByType(tokenType).UniquePerOutput().Sum()
sent := inputs.ByEnrollmentID(eID).ByType(tokenType).UniquePerInput().Sum()
diff := new(big.Int).Sub(received, sent)
if sent.Cmp(received) == 0 {
continue
Expand Down
Loading
Loading