Skip to content

Commit 4205405

Browse files
committed
fix(signer): limit ticket exposure before signing (review #2)
Review-Finding: 2 Original-Commit: 366c2d68b39143f7b805c1aa98a0da069104134e Original-Author: Rafał Leszko <rafal@livepeer.org> Original-Author-Date: 2023-10-25T10:48:31+02:00 Original-Commit-Date: 2023-10-25T10:48:31+02:00 Original-Commit: d1b2c93a65d816ebdcca40c2f74fd5894f101995 Original-Author: Yondon Fu <yondon.fu@gmail.com> Original-Author-Date: 2020-07-31T15:19:23-04:00 Original-Commit-Date: 2020-08-05T17:34:01-04:00
1 parent 456d5bb commit 4205405

12 files changed

Lines changed: 266 additions & 45 deletions

‎eth/abi.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ package eth
55
var contractABIs = map[string]string{
66
"controller": `[{"inputs":[{"internalType":"bytes32","name":"_id","type":"bytes32"}],"name":"getContract","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"}]`,
77
"bondingManager": `[{"inputs":[{"internalType":"uint256","name":"_amount","type":"uint256"},{"internalType":"address","name":"_to","type":"address"}],"name":"bond","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_endRound","type":"uint256"}],"name":"claimEarnings","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_delegator","type":"address"}],"name":"getDelegator","outputs":[{"internalType":"uint256","name":"bondedAmount","type":"uint256"},{"internalType":"uint256","name":"fees","type":"uint256"},{"internalType":"address","name":"delegateAddress","type":"address"},{"internalType":"uint256","name":"delegatedAmount","type":"uint256"},{"internalType":"uint256","name":"startRound","type":"uint256"},{"internalType":"uint256","name":"lastClaimRound","type":"uint256"},{"internalType":"uint256","name":"nextUnbondingLockId","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_delegator","type":"address"},{"internalType":"uint256","name":"_unbondingLockId","type":"uint256"}],"name":"getDelegatorUnbondingLock","outputs":[{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"uint256","name":"withdrawRound","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getFirstTranscoderInPool","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_transcoder","type":"address"}],"name":"getNextTranscoderInPool","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_transcoder","type":"address"}],"name":"getTranscoder","outputs":[{"internalType":"uint256","name":"lastRewardRound","type":"uint256"},{"internalType":"uint256","name":"rewardCut","type":"uint256"},{"internalType":"uint256","name":"feeShare","type":"uint256"},{"internalType":"uint256","name":"lastActiveStakeUpdateRound","type":"uint256"},{"internalType":"uint256","name":"activationRound","type":"uint256"},{"internalType":"uint256","name":"deactivationRound","type":"uint256"},{"internalType":"uint256","name":"activeCumulativeRewards","type":"uint256"},{"internalType":"uint256","name":"cumulativeRewards","type":"uint256"},{"internalType":"uint256","name":"cumulativeFees","type":"uint256"},{"internalType":"uint256","name":"lastFeeRound","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getTranscoderPoolMaxSize","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getTranscoderPoolSize","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_transcoder","type":"address"}],"name":"isActiveTranscoder","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_delegator","type":"address"},{"internalType":"uint256","name":"_endRound","type":"uint256"}],"name":"pendingFees","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_unbondingLockId","type":"uint256"}],"name":"rebond","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"reward","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_rewardCut","type":"uint256"},{"internalType":"uint256","name":"_feeShare","type":"uint256"}],"name":"transcoder","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"unbond","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"addresspayable","name":"_recipient","type":"address"},{"internalType":"uint256","name":"_amount","type":"uint256"}],"name":"withdrawFees","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_unbondingLockId","type":"uint256"}],"name":"withdrawStake","outputs":[],"stateMutability":"nonpayable","type":"function"}]`,
8-
"ticketBroker": `[{"inputs":[],"name":"cancelUnlock","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_depositAmount","type":"uint256"},{"internalType":"uint256","name":"_reserveAmount","type":"uint256"}],"name":"fundDepositAndReserve","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"_sender","type":"address"}],"name":"getSenderInfo","outputs":[{"components":[{"internalType":"uint256","name":"deposit","type":"uint256"},{"internalType":"uint256","name":"withdrawRound","type":"uint256"}],"internalType":"structMixinTicketBrokerCore.Sender","name":"sender","type":"tuple"},{"components":[{"internalType":"uint256","name":"fundsRemaining","type":"uint256"},{"internalType":"uint256","name":"claimedInCurrentRound","type":"uint256"}],"internalType":"structMReserve.ReserveInfo","name":"reserve","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"recipient","type":"address"},{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint256","name":"faceValue","type":"uint256"},{"internalType":"uint256","name":"winProb","type":"uint256"},{"internalType":"uint256","name":"senderNonce","type":"uint256"},{"internalType":"bytes32","name":"recipientRandHash","type":"bytes32"},{"internalType":"bytes","name":"auxData","type":"bytes"}],"internalType":"structMTicketBrokerCore.Ticket","name":"_ticket","type":"tuple"},{"internalType":"bytes","name":"_sig","type":"bytes"},{"internalType":"uint256","name":"_recipientRand","type":"uint256"}],"name":"redeemWinningTicket","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"unlock","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"name":"usedTickets","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"withdraw","outputs":[],"stateMutability":"nonpayable","type":"function"}]`,
8+
"ticketBroker": `[{"inputs":[{"name":"_reserveHolder","type":"address"},{"name":"_claimant","type":"address"}],"name":"claimableReserve","outputs":[{"name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"cancelUnlock","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_depositAmount","type":"uint256"},{"internalType":"uint256","name":"_reserveAmount","type":"uint256"}],"name":"fundDepositAndReserve","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"_sender","type":"address"}],"name":"getSenderInfo","outputs":[{"components":[{"internalType":"uint256","name":"deposit","type":"uint256"},{"internalType":"uint256","name":"withdrawRound","type":"uint256"}],"internalType":"structMixinTicketBrokerCore.Sender","name":"sender","type":"tuple"},{"components":[{"internalType":"uint256","name":"fundsRemaining","type":"uint256"},{"internalType":"uint256","name":"claimedInCurrentRound","type":"uint256"}],"internalType":"structMReserve.ReserveInfo","name":"reserve","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"recipient","type":"address"},{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint256","name":"faceValue","type":"uint256"},{"internalType":"uint256","name":"winProb","type":"uint256"},{"internalType":"uint256","name":"senderNonce","type":"uint256"},{"internalType":"bytes32","name":"recipientRandHash","type":"bytes32"},{"internalType":"bytes","name":"auxData","type":"bytes"}],"internalType":"structMTicketBrokerCore.Ticket","name":"_ticket","type":"tuple"},{"internalType":"bytes","name":"_sig","type":"bytes"},{"internalType":"uint256","name":"_recipientRand","type":"uint256"}],"name":"redeemWinningTicket","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"unlock","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"name":"usedTickets","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"withdraw","outputs":[],"stateMutability":"nonpayable","type":"function"}]`,
99
"roundsManager": `[{"inputs":[{"internalType":"uint256","name":"_round","type":"uint256"}],"name":"blockHashForRound","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"currentRound","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"initializeRound","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"lastInitializedRound","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}]`,
1010
"serviceRegistry": `[{"inputs":[{"internalType":"address","name":"_addr","type":"address"}],"name":"getServiceURI","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"string","name":"_serviceURI","type":"string"}],"name":"setServiceURI","outputs":[],"stateMutability":"nonpayable","type":"function"}]`,
1111
"livepeerToken": `[{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"spender","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}]`,

‎eth/contracts_test.go‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,10 @@ func TestContractTransactionLifecycle(t *testing.T) {
146146
require.Equal(t, int64(50), snapshot.Block.Int64())
147147
require.Equal(t, int64(5), snapshot.Round.Int64())
148148
require.Equal(t, ethcommon.HexToHash("0x1234"), snapshot.RoundHash)
149-
require.NoError(t, (PaymentChain{Contracts: contracts}).ValidateSender(t.Context(), key.Address(), big.NewInt(1)))
149+
funds, err := (PaymentChain{Contracts: contracts}).SenderInfo(t.Context(), key.Address(), key.Address())
150+
require.NoError(t, err)
151+
require.Equal(t, big.NewInt(10), funds.Deposit)
152+
require.Equal(t, big.NewInt(10), funds.Reserve)
150153
redeemedHash, err := (PaymentChain{Contracts: contracts}).Redeem(context.Background(), key, big.NewInt(1), RedeemTicket{Recipient: key.Address(), Sender: ethcommon.HexToAddress("0x3000"), FaceValue: big.NewInt(10), WinProb: big.NewInt(100), SenderNonce: 2, RecipientRandHash: ethcommon.HexToHash("0x4000"), AuxData: make([]byte, 64), Signature: make([]byte, 65), RecipientRand: big.NewInt(7)})
151154
require.NoError(t, err)
152155
require.NotEqual(t, ethcommon.Hash{}, redeemedHash)

‎eth/payment.go‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,3 +256,45 @@ func (c PaymentChain) PrepareRedemption(ctx context.Context, key *Key, chainID *
256256
}
257257
return c.Contracts.Prepare(ctx, plan, key, chainID)
258258
}
259+
260+
// SenderInfo is a coherent view of a sender's collateral and the amount of
261+
// reserve this particular recipient can claim in the initialized round.
262+
type SenderInfo struct {
263+
Snapshot ChainSnapshot
264+
Deposit, Reserve, WithdrawRound *big.Int
265+
}
266+
267+
func (c PaymentChain) SenderInfo(ctx context.Context, sender, recipient ethcommon.Address) (SenderInfo, error) {
268+
snapshot, err := c.Snapshot(ctx)
269+
if err != nil {
270+
return SenderInfo{}, err
271+
}
272+
address, err := c.Contracts.ResolveAt(ctx, snapshot.blockReference, "ticketBroker")
273+
if err != nil {
274+
return SenderInfo{}, err
275+
}
276+
values, err := c.Contracts.CallAt(ctx, snapshot.blockReference, "ticketBroker", address, "getSenderInfo", sender)
277+
if err != nil {
278+
return SenderInfo{}, err
279+
}
280+
if len(values) != 2 {
281+
return SenderInfo{}, errors.New("invalid sender info")
282+
}
283+
deposit, err := tupleBigInt(values[0], "Deposit")
284+
if err != nil {
285+
return SenderInfo{}, err
286+
}
287+
withdraw, err := tupleBigInt(values[0], "WithdrawRound")
288+
if err != nil {
289+
return SenderInfo{}, err
290+
}
291+
values, err = c.Contracts.CallAt(ctx, snapshot.blockReference, "ticketBroker", address, "claimableReserve", sender, recipient)
292+
if err != nil {
293+
return SenderInfo{}, err
294+
}
295+
reserve, ok := values[0].(*big.Int)
296+
if !ok {
297+
return SenderInfo{}, errors.New("invalid claimable reserve")
298+
}
299+
return SenderInfo{Snapshot: snapshot, Deposit: deposit, Reserve: reserve, WithdrawRound: withdraw}, nil
300+
}

‎orchestrator/payment_test.go‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ func TestPaidFixedSessionWithRemoteSigner(t *testing.T) {
5757
require.NoError(t, err)
5858
defer store.Close()
5959
max := new(big.Int).Sub(new(big.Int).Lsh(big.NewInt(1), 256), big.NewInt(1))
60-
engine, err := pm.NewEngine(store, paymentTestChain{}, recipient.Address(), big.NewInt(10), max)
60+
engine, err := pm.NewEngine(store, paymentTestChain{}, recipient.Address(), big.NewInt(10), new(big.Int).Sub(max, big.NewInt(1)))
6161
require.NoError(t, err)
6262
registry := NewRegistry("bootstrap", "http://127.0.0.1:8935", time.Second, 30*time.Second)
6363
registry.SetWeiPerUSD(big.NewRat(10, 1))
@@ -72,6 +72,7 @@ func TestPaidFixedSessionWithRemoteSigner(t *testing.T) {
7272
signerService, err := signer.OpenService(payer, filepath.Join(t.TempDir(), "signer.sqlite"), "")
7373
require.NoError(t, err)
7474
defer signerService.Close()
75+
signerService.SetPaymentChain(paymentTestChain{})
7576
reserveURL := "/apps/runner1/session"
7677
first := httptest.NewRequest(http.MethodPost, reserveURL, nil)
7778
first.Header.Set("Livepeer-Payer-Address", payer.Address().Hex())
@@ -139,7 +140,7 @@ func TestPinnedPythonPaidSingleShot(t *testing.T) {
139140
require.NoError(t, err)
140141
defer store.Close()
141142
max := new(big.Int).Sub(new(big.Int).Lsh(big.NewInt(1), 256), big.NewInt(1))
142-
engine, err := pm.NewEngine(store, paymentTestChain{}, recipient.Address(), big.NewInt(10), max)
143+
engine, err := pm.NewEngine(store, paymentTestChain{}, recipient.Address(), big.NewInt(10), new(big.Int).Sub(max, big.NewInt(1)))
143144
require.NoError(t, err)
144145
registry := NewRegistry("", "http://127.0.0.1:0", time.Second, 30*time.Second)
145146
registry.SetWeiPerUSD(big.NewRat(10, 1))
@@ -156,6 +157,7 @@ func TestPinnedPythonPaidSingleShot(t *testing.T) {
156157
signerService, err := signer.OpenService(payer, filepath.Join(t.TempDir(), "signer.sqlite"), "")
157158
require.NoError(t, err)
158159
defer signerService.Close()
160+
signerService.SetPaymentChain(paymentTestChain{})
159161
signerHTTP := httptest.NewServer(signerService)
160162
defer signerHTTP.Close()
161163
fixture := filepath.Join(root, "cmd", "livepeer", "testdata", "python_paid_compat.py")
@@ -186,6 +188,7 @@ func TestPinnedPythonSignerDiscovery(t *testing.T) {
186188
signerService, err := signer.OpenService(paymentTestKey(t), filepath.Join(t.TempDir(), "signer.sqlite"), "")
187189
require.NoError(t, err)
188190
defer signerService.Close()
191+
signerService.SetPaymentChain(paymentTestChain{})
189192
require.NoError(t, signerService.SetDiscovery([]string{orch.URL}, []string{strings.TrimPrefix(orch.URL, "http://")}, ""))
190193
signerHTTP := httptest.NewServer(signerService)
191194
defer signerHTTP.Close()
@@ -230,3 +233,12 @@ func pinnedPythonSDK(t *testing.T) (python, export, root string) {
230233
require.NoError(t, tar.Wait())
231234
return
232235
}
236+
237+
func (c paymentTestChain) SenderInfo(ctx context.Context, _, _ ethcommon.Address) (eth.SenderInfo, error) {
238+
snapshot, err := c.Snapshot(ctx)
239+
return eth.SenderInfo{Snapshot: snapshot, Deposit: big.NewInt(1000000000), Reserve: big.NewInt(1000000000), WithdrawRound: new(big.Int)}, err
240+
}
241+
242+
func (paymentTestChain) IsActiveAt(context.Context, ethcommon.Address, pm.ChainSnapshot) (bool, error) {
243+
return true, nil
244+
}

‎pm/engine.go‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,3 +337,8 @@ func (e *Engine) Balance(manifest string) (*big.Rat, error) {
337337
}
338338
return result, nil
339339
}
340+
341+
// SenderChain contains the sender collateral observation used by both payment sides.
342+
type SenderChain interface {
343+
SenderInfo(context.Context, ethcommon.Address, ethcommon.Address) (eth.SenderInfo, error)
344+
}

0 commit comments

Comments
 (0)