funds

Documentation

Index

• type DealFunds
  • func NewDealFunds(ds datastore.Batching, key datastore.Key) (DealFunds, error)

Types

type DealFunds

type DealFunds interface {
	// returns the current amount tracked
	Get() abi.TokenAmount

	// Reserve is used to mark funds as "in-use" for a deal
	// returns the new amount tracked
	Reserve(amount abi.TokenAmount) (abi.TokenAmount, error)

	// Release releases reserved committed funds back to the available pool
	// returns total amount reserved afterwards
	Release(amount abi.TokenAmount) (abi.TokenAmount, error)
}

DealFunds is used to track funds needed for (possibly multiple) deals in progress

func NewDealFunds

func NewDealFunds(ds datastore.Batching, key datastore.Key) (DealFunds, error)