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

Jump to bottom

replace AddAsk with SetAsk, to convey intent #275

Merged
merged 1 commit into from
Jun 15, 2020
Merged

replace AddAsk with SetAsk, to convey intent #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions retrievalmarket/storage_retrieval_integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ func TestStorageRetrieval(t *testing.T) {
_ = sh.Client.SubscribeToEvents(clientSubscriber)

// set ask price where we'll accept any price
err := sh.Provider.AddAsk(big.NewInt(0), 50_000)
err := sh.Provider.SetAsk(big.NewInt(0), 50_000)
assert.NoError(t, err)

result := sh.ProposeStorageDeal(t, &storagemarket.DataRef{TransferType: storagemarket.TTGraphsync, Root: sh.PayloadCid})
Expand Down Expand Up @@ -247,7 +247,7 @@ func newStorageHarness(ctx context.Context, t *testing.T) *storageHarness {
require.NoError(t, err)

// set ask price where we'll accept any price
require.NoError(t, provider.AddAsk(big.NewInt(0), 50_000))
require.NoError(t, provider.SetAsk(big.NewInt(0), 50_000))
require.NoError(t, provider.Start(ctx))

// Closely follows the MinerInfo struct in the spec
Expand Down
14 changes: 5 additions & 9 deletions storagemarket/impl/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ var _ storagemarket.StorageProvider = &Provider{}

type StoredAsk interface {
GetAsk(address.Address) *storagemarket.SignedStorageAsk
AddAsk(price abi.TokenAmount, duration abi.ChainEpoch, options ...storagemarket.StorageAskOption) error
SetAsk(price abi.TokenAmount, duration abi.ChainEpoch, options ...storagemarket.StorageAskOption) error
}

// Provider is a storage provider implementation
Expand Down Expand Up @@ -256,12 +256,8 @@ func (p *Provider) ImportDataForDeal(ctx context.Context, propCid cid.Cid, data

}

func (p *Provider) ListAsks(addr address.Address) []*storagemarket.SignedStorageAsk {
ask := p.storedAsk.GetAsk(addr)
if ask != nil {
return []*storagemarket.SignedStorageAsk{ask}
}
return nil
func (p *Provider) GetAsk(addr address.Address) *storagemarket.SignedStorageAsk {
return p.storedAsk.GetAsk(addr)
}

func (p *Provider) ListDeals(ctx context.Context) ([]storagemarket.StorageDeal, error) {
Expand Down Expand Up @@ -316,8 +312,8 @@ func (p *Provider) ListLocalDeals() ([]storagemarket.MinerDeal, error) {
return out, nil
}

func (p *Provider) AddAsk(price abi.TokenAmount, duration abi.ChainEpoch, options ...storagemarket.StorageAskOption) error {
return p.storedAsk.AddAsk(price, duration, options...)
func (p *Provider) SetAsk(price abi.TokenAmount, duration abi.ChainEpoch, options ...storagemarket.StorageAskOption) error {
return p.storedAsk.SetAsk(price, duration, options...)
}

func (p *Provider) HandleAskStream(s network.StorageAskStream) {
Expand Down
4 changes: 2 additions & 2 deletions storagemarket/impl/storedask/storedask.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ func NewStoredAsk(ds datastore.Batching, dsKey datastore.Key, spn storagemarket.
if s.ask == nil {
// TODO: we should be fine with this state, and just say it means 'not actively accepting deals'
// for now... lets just set a price
if err := s.AddAsk(defaultPrice, defaultDuration); err != nil {
if err := s.SetAsk(defaultPrice, defaultDuration); err != nil {
return nil, xerrors.Errorf("failed setting a default price: %w", err)
}
}
return s, nil
}

func (s *StoredAsk) AddAsk(price abi.TokenAmount, duration abi.ChainEpoch, options ...storagemarket.StorageAskOption) error {
func (s *StoredAsk) SetAsk(price abi.TokenAmount, duration abi.ChainEpoch, options ...storagemarket.StorageAskOption) error {
s.askLk.Lock()
defer s.askLk.Unlock()
var seqno uint64
Expand Down
8 changes: 4 additions & 4 deletions storagemarket/impl/storedask/storedask_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func TestStoredAsk(t *testing.T) {
})
t.Run("setting ask price", func(t *testing.T) {
minPieceSize := abi.PaddedPieceSize(1024)
err := storedAsk.AddAsk(testPrice, testDuration, storagemarket.MinPieceSize(minPieceSize))
err := storedAsk.SetAsk(testPrice, testDuration, storagemarket.MinPieceSize(minPieceSize))
require.NoError(t, err)
ask := storedAsk.GetAsk(actor)
require.Equal(t, ask.Ask.Price, testPrice)
Expand Down Expand Up @@ -64,7 +64,7 @@ func TestStoredAsk(t *testing.T) {
// should load cause ask is is still in data store
storedAskError, err := storedask.NewStoredAsk(ds, datastore.NewKey("latest-ask"), spnStateIDErr, actor)
require.NoError(t, err)
err = storedAskError.AddAsk(testPrice, testDuration)
err = storedAskError.SetAsk(testPrice, testDuration)
require.Error(t, err)

spnMinerWorkerErr := &testnodes.FakeProviderNode{
Expand All @@ -76,7 +76,7 @@ func TestStoredAsk(t *testing.T) {
// should load cause ask is is still in data store
storedAskError, err = storedask.NewStoredAsk(ds, datastore.NewKey("latest-ask"), spnMinerWorkerErr, actor)
require.NoError(t, err)
err = storedAskError.AddAsk(testPrice, testDuration)
err = storedAskError.SetAsk(testPrice, testDuration)
require.Error(t, err)

spnSignBytesErr := &testnodes.FakeProviderNode{
Expand All @@ -88,7 +88,7 @@ func TestStoredAsk(t *testing.T) {
// should load cause ask is is still in data store
storedAskError, err = storedask.NewStoredAsk(ds, datastore.NewKey("latest-ask"), spnSignBytesErr, actor)
require.NoError(t, err)
err = storedAskError.AddAsk(testPrice, testDuration)
err = storedAskError.SetAsk(testPrice, testDuration)
require.Error(t, err)
})
}
4 changes: 2 additions & 2 deletions storagemarket/integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ func TestMakeDeal(t *testing.T) {
_ = h.Client.SubscribeToEvents(clientSubscriber)

// set ask price where we'll accept any price
err = h.Provider.AddAsk(big.NewInt(0), 50_000)
err = h.Provider.SetAsk(big.NewInt(0), 50_000)
assert.NoError(t, err)

result := h.ProposeStorageDeal(t, &storagemarket.DataRef{TransferType: storagemarket.TTGraphsync, Root: h.PayloadCid})
Expand Down Expand Up @@ -314,7 +314,7 @@ func newHarness(t *testing.T, ctx context.Context) *harness {
assert.NoError(t, err)

// set ask price where we'll accept any price
err = provider.AddAsk(big.NewInt(0), 50_000)
err = provider.SetAsk(big.NewInt(0), 50_000)
assert.NoError(t, err)

err = provider.Start(ctx)
Expand Down
11 changes: 7 additions & 4 deletions storagemarket/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,16 +392,19 @@ type MessagePublishedCallback func(mcid cid.Cid, err error)
type ProviderSubscriber func(event ProviderEvent, deal MinerDeal)
type ClientSubscriber func(event ClientEvent, deal ClientDeal)

// StorageProvider is the interface provided for storage providers
// StorageProvider provides an interface to the storage market for a single
// storage miner.
type StorageProvider interface {
Start(ctx context.Context) error

Stop() error

AddAsk(price abi.TokenAmount, duration abi.ChainEpoch, options ...StorageAskOption) error
// SetAsk configures the storage miner's ask with the provided price,
// duration, and options. Any previously-existing ask is replaced.
SetAsk(price abi.TokenAmount, duration abi.ChainEpoch, options ...StorageAskOption) error

// ListAsks lists current asks
ListAsks(addr address.Address) []*SignedStorageAsk
// GetAsk returns the storage miner's ask, or nil if one does not exist.
GetAsk(addr address.Address) *SignedStorageAsk

// ListDeals lists on-chain deals associated with this storage provider
ListDeals(ctx context.Context) ([]StorageDeal, error)
Expand Down