contracts

Dec 20, 2023

Changes in this version

type ContractManager

+ func (cm *ContractManager) ScanHeight() uint64

Sep 26, 2023

Changes in this version

type Usage

+ RegistryRead types.Currency

+ RegistryWrite types.Currency

Jul 16, 2023

Changes in this version

type ContractStore

+ ExpireContract func(types.FileContractID, ContractStatus) error

Jun 22, 2023

Changes in this version

+ const ActionBroadcastFinalRevision

+ const ActionBroadcastFormation

+ const ActionBroadcastResolution

+ const ActionExpire

+ const ActionReject

+ const ContractSortExpirationHeight

+ const ContractSortNegotiationHeight

+ const ContractSortStatus

+ const RebroadcastBuffer

+ const RevisionSubmissionBuffer

+ var ErrContractExists = errors.New("contract already exists")

+ var ErrNotFound = errors.New("contract not found")

+ type Alerts interface

+ Dismiss func(...types.Hash256)

+ Register func(alerts.Alert)

+ type ChainManager interface

+ IndexAtHeight func(height uint64) (types.ChainIndex, error)

+ Subscribe func(s modules.ConsensusSetSubscriber, ccID modules.ConsensusChangeID, ...) error

+ TipState func() consensus.State

+ type Contract struct

+ FormationConfirmed bool

+ LockedCollateral types.Currency

+ NegotiationHeight uint64

+ RenewedFrom types.FileContractID

+ RenewedTo types.FileContractID

+ ResolutionHeight uint64

+ RevisionConfirmed bool

+ Status ContractStatus

+ Usage Usage

+ type ContractFilter struct

+ ContractIDs []types.FileContractID

+ Limit int

+ MaxExpirationHeight uint64

+ MaxNegotiationHeight uint64

+ MinExpirationHeight uint64

+ MinNegotiationHeight uint64

+ Offset int

+ RenewedFrom []types.FileContractID

+ RenewedTo []types.FileContractID

+ RenterKey []types.PublicKey

+ SortDesc bool

+ SortField string

+ Statuses []ContractStatus

+ type ContractManager struct

+ func NewManager(store ContractStore, alerts Alerts, storage StorageManager, c ChainManager, ...) (*ContractManager, error)

+ func (cm *ContractManager) AddContract(revision SignedRevision, formationSet []types.Transaction, ...) error

+ func (cm *ContractManager) CheckIntegrity(ctx context.Context, contractID types.FileContractID) (<-chan IntegrityResult, uint64, error)

+ func (cm *ContractManager) Close() error

+ func (cm *ContractManager) Contract(id types.FileContractID) (Contract, error)

+ func (cm *ContractManager) Contracts(filter ContractFilter) ([]Contract, int, error)

+ func (cm *ContractManager) Lock(ctx context.Context, id types.FileContractID) (SignedRevision, error)

+ func (cm *ContractManager) ProcessConsensusChange(cc modules.ConsensusChange)

+ func (cm *ContractManager) RenewContract(renewal SignedRevision, existing SignedRevision, ...) error

+ func (cm *ContractManager) ReviseContract(contractID types.FileContractID) (*ContractUpdater, error)

+ func (cm *ContractManager) SectorRoots(id types.FileContractID, limit, offset uint64) ([]types.Hash256, error)

+ func (cm *ContractManager) Unlock(id types.FileContractID)

+ type ContractStatus uint8

+ const ContractStatusActive

+ const ContractStatusFailed

+ const ContractStatusPending

+ const ContractStatusRejected

+ const ContractStatusSuccessful

+ func (c *ContractStatus) UnmarshalJSON(b []byte) error

+ func (c ContractStatus) MarshalJSON() ([]byte, error)

+ func (c ContractStatus) String() string

+ type ContractStore interface

+ AddContract func(revision SignedRevision, formationSet []types.Transaction, ...) error

+ Contract func(types.FileContractID) (Contract, error)

+ ContractAction func(height uint64, contractFn func(types.FileContractID, uint64, string)) error

+ ContractFormationSet func(types.FileContractID) ([]types.Transaction, error)

+ Contracts func(ContractFilter) ([]Contract, int, error)

+ ExpireContractSectors func(height uint64) error

+ LastContractChange func() (id modules.ConsensusChangeID, err error)

+ RenewContract func(renewal SignedRevision, existing SignedRevision, ...) error

+ ReviseContract func(revision SignedRevision, usage Usage, oldSectors uint64, ...) error

+ SectorRoots func(id types.FileContractID, limit, offset uint64) ([]types.Hash256, error)

+ SetContractStatus func(types.FileContractID, ContractStatus) error

+ UpdateContractState func(modules.ConsensusChangeID, uint64, func(UpdateStateTransaction) error) error

+ type ContractUpdater struct

+ func (cu *ContractUpdater) AppendSector(root types.Hash256)

+ func (cu *ContractUpdater) Close() error

+ func (cu *ContractUpdater) Commit(revision SignedRevision, usage Usage) error

+ func (cu *ContractUpdater) MerkleRoot() types.Hash256

+ func (cu *ContractUpdater) SectorCount() uint64

+ func (cu *ContractUpdater) SectorRoot(i uint64) (types.Hash256, error)

+ func (cu *ContractUpdater) SectorRoots() []types.Hash256

+ func (cu *ContractUpdater) SwapSectors(a, b uint64) error

+ func (cu *ContractUpdater) TrimSectors(n uint64) error

+ func (cu *ContractUpdater) UpdateSector(root types.Hash256, i uint64) error

+ type IntegrityResult struct

+ ActualRoot types.Hash256

+ Error error

+ ExpectedRoot types.Hash256

+ func (i *IntegrityResult) UnmarshalJSON(b []byte) error

+ func (i IntegrityResult) MarshalJSON() ([]byte, error)

+ type SectorAction string

+ const SectorActionAppend

+ const SectorActionSwap

+ const SectorActionTrim

+ const SectorActionUpdate

+ type SectorChange struct

+ A uint64

+ Action SectorAction

+ B uint64

+ Root types.Hash256

+ type SignedRevision struct

+ HostSignature types.Signature

+ RenterSignature types.Signature

+ Revision types.FileContractRevision

+ func (sr SignedRevision) RenterKey() types.PublicKey

+ func (sr SignedRevision) Signatures() []types.TransactionSignature

+ type StorageManager interface

+ Read func(root types.Hash256) (*[rhpv2.SectorSize]byte, error)

+ type TransactionPool interface

+ AcceptTransactionSet func([]types.Transaction) error

+ RecommendedFee func() types.Currency

+ type UpdateContractTransaction interface

+ AddUsage func(Usage) error

+ AppendSector func(root types.Hash256) error

+ ReviseContract func(SignedRevision) error

+ SwapSectors func(i, j uint64) error

+ TrimSectors func(n int) error

+ UpdateSector func(index uint64, newRoot types.Hash256) error

+ type UpdateStateTransaction interface

+ ConfirmFormation func(types.FileContractID) error

+ ConfirmResolution func(id types.FileContractID, height uint64) error

+ ConfirmRevision func(types.FileContractRevision) error

+ ContractRelevant func(types.FileContractID) (bool, error)

+ RevertFormation func(types.FileContractID) error

+ RevertResolution func(types.FileContractID) error

+ RevertRevision func(types.FileContractID) error

+ SetStatus func(types.FileContractID, ContractStatus) error

+ type Usage struct

+ AccountFunding types.Currency

+ EgressRevenue types.Currency

+ IngressRevenue types.Currency

+ RPCRevenue types.Currency

+ RiskedCollateral types.Currency

+ StorageRevenue types.Currency

+ func (u Usage) Add(b Usage) (c Usage)

+ type Wallet interface

+ Address func() types.Address

+ FundTransaction func(txn *types.Transaction, amount types.Currency) (toSign []types.Hash256, release func(), err error)

+ SignTransaction func(cs consensus.State, txn *types.Transaction, toSign []types.Hash256, ...) error

+ UnlockConditions func() types.UnlockConditions