storj/pkg/audit/containment.go
2019-05-23 10:37:23 -04:00

45 lines
1.3 KiB
Go

// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.
package audit
import (
"context"
"github.com/zeebo/errs"
"storj.io/storj/pkg/pb"
"storj.io/storj/pkg/storj"
)
var (
// ContainError is the containment errs class
ContainError = errs.Class("containment error")
// ErrContainedNotFound is the errs class for when a pending audit isn't found
ErrContainedNotFound = errs.Class("pending audit not found")
// ErrContainDelete is the errs class for when a pending audit can't be deleted
ErrContainDelete = errs.Class("unable to delete pending audit")
// ErrAlreadyExists is the errs class for when a pending audit with the same nodeID but different share data already exists
ErrAlreadyExists = errs.Class("pending audit already exists for nodeID")
)
// PendingAudit contains info needed for retrying an audit for a contained node
type PendingAudit struct {
NodeID storj.NodeID
PieceID storj.PieceID
StripeIndex uint32
ShareSize int64
ExpectedShareHash []byte
ReverifyCount uint32
}
// Containment holds information about pending audits for contained nodes
type Containment interface {
Get(ctx context.Context, nodeID pb.NodeID) (*PendingAudit, error)
IncrementPending(ctx context.Context, pendingAudit *PendingAudit) error
Delete(ctx context.Context, nodeID pb.NodeID) (bool, error)
}