RPCCost (RHPv2) #123
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,8 +3,8 @@ package rhp | |
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "net" | ||
| "strings" | ||
| "time" | ||
|
|
@@ -141,6 +141,29 @@ var ( | |
| RPCReadStop = types.NewSpecifier("ReadStop") | ||
| ) | ||
|
|
||
| // RPC read/write errors | ||
| var ( | ||
| // ErrOffsetOutOfBounds is returned when the offset exceeds and length | ||
| // exceed the sector size. | ||
| ErrOffsetOutOfBounds = errors.New("update section is out of bounds") | ||
|
|
||
| // ErrInvalidSectorLength is returned when a sector is not the correct | ||
| // length. | ||
| ErrInvalidSectorLength = errors.New("length of sector data must be exactly 4MiB") | ||
| // ErrSwapOutOfBounds is returned when one of the swap indices exceeds the | ||
| // total number of sectors | ||
| ErrSwapOutOfBounds = errors.New("swap index is out of bounds") | ||
| // ErrTrimOutOfBounds is returned when a trim operation exceeds the total | ||
| // number of sectors | ||
| ErrTrimOutOfBounds = errors.New("trim size exceeds number of sectors") | ||
| // ErrUpdateOutOfBounds is returned when the update index exceeds the total | ||
| // number of sectors | ||
| ErrUpdateOutOfBounds = errors.New("update index is out of bounds") | ||
| // ErrUpdateProofSize is returned when a proof is requested for an update | ||
| // operation that is not a multiple of 64 bytes. | ||
| ErrUpdateProofSize = errors.New("update section is not a multiple of the segment size") | ||
| ) | ||
|
|
||
| // RPC request/response objects | ||
| type ( | ||
| // RPCFormContractRequest contains the request parameters for the | ||
|
|
@@ -280,45 +303,116 @@ type ( | |
| } | ||
| ) | ||
|
|
||
| type RPCCost struct { | ||
| Base types.Currency | ||
| Storage types.Currency | ||
| Ingress types.Currency | ||
| Egress types.Currency | ||
| Collateral types.Currency | ||
| } | ||
|
|
||
| func (c RPCCost) Add(o RPCCost) RPCCost { | ||
| return RPCCost{ | ||
| Base: c.Base.Add(o.Base), | ||
| Storage: c.Storage.Add(o.Storage), | ||
| Ingress: c.Ingress.Add(o.Ingress), | ||
| Egress: c.Egress.Add(o.Egress), | ||
| Collateral: c.Collateral.Add(o.Collateral), | ||
| } | ||
| } | ||
|
|
||
| func (c RPCCost) Total() (cost, collateral types.Currency) { | ||
| return c.Base.Add(c.Storage).Add(c.Ingress).Add(c.Egress), c.Collateral | ||
| } | ||
|
|
||
| // RPCReadCost returns the cost of a Read RPC. | ||
| func (hs *HostSettings) RPCReadCost(sections []RPCReadRequestSection, proof bool) (RPCCost, error) { | ||
| // validate the request sections and calculate the cost | ||
| var bandwidth uint64 | ||
| for _, sec := range sections { | ||
| switch { | ||
| case uint64(sec.Offset)+uint64(sec.Length) > SectorSize: | ||
| return RPCCost{}, ErrOffsetOutOfBounds | ||
| case sec.Length == 0: | ||
| return RPCCost{}, errors.New("length cannot be zero") | ||
| case proof && (sec.Offset%LeafSize != 0 || sec.Length%LeafSize != 0): | ||
| return RPCCost{}, errors.New("offset and length must be multiples of LeafSize when requesting a Merkle proof") | ||
| } | ||
|
|
||
| bandwidth += uint64(sec.Length) | ||
| if proof { | ||
| start := sec.Offset / LeafSize | ||
| end := (sec.Offset + sec.Length) / LeafSize | ||
| proofSize := RangeProofSize(LeavesPerSector, start, end) | ||
| bandwidth += proofSize * 32 | ||
| } | ||
| } | ||
|
|
||
| return RPCCost{ | ||
| Base: hs.BaseRPCPrice.Add(hs.SectorAccessPrice.Mul64(uint64(len(sections)))), | ||
| Egress: hs.DownloadBandwidthPrice.Mul64(bandwidth), | ||
| }, nil | ||
| } | ||
|
|
||
|
There was a problem hiding this comment. @n8maninger |
||
| // RPCSectorRootsCost returns the cost of a SectorRoots RPC. | ||
| func (hs *HostSettings) RPCSectorRootsCost(rootOffset, numRoots uint64) RPCCost { | ||
| proofSize := RangeProofSize(LeavesPerSector, rootOffset, rootOffset+numRoots) | ||
| return RPCCost{ | ||
| Base: hs.BaseRPCPrice, | ||
| Egress: hs.DownloadBandwidthPrice.Mul64((numRoots + proofSize) * 32), | ||
| } | ||
| } | ||
|
|
||
| // RPCWriteCost returns the cost of a Write RPC. | ||
| func (hs *HostSettings) RPCWriteCost(actions []RPCWriteAction, oldSectors, remainingDuration uint64, proof bool) (RPCCost, error) { | ||
| var uploadBytes uint64 | ||
| newSectors := oldSectors | ||
| for _, action := range actions { | ||
| switch action.Type { | ||
| case RPCWriteActionAppend: | ||
| if len(action.Data) != SectorSize { | ||
| return RPCCost{}, fmt.Errorf("invalid sector size: %v: %w", len(action.Data), ErrInvalidSectorLength) | ||
| } | ||
| newSectors++ | ||
| uploadBytes += SectorSize | ||
| case RPCWriteActionTrim: | ||
| if action.A > newSectors { | ||
| return RPCCost{}, ErrTrimOutOfBounds | ||
| } | ||
| newSectors -= action.A | ||
| case RPCWriteActionSwap: | ||
| if action.A >= newSectors || action.B >= newSectors { | ||
| return RPCCost{}, ErrSwapOutOfBounds | ||
| } | ||
| case RPCWriteActionUpdate: | ||
| idx, offset := action.A, action.B | ||
| if idx >= newSectors { | ||
| return RPCCost{}, ErrUpdateOutOfBounds | ||
| } else if offset+uint64(len(action.Data)) > SectorSize { | ||
| return RPCCost{}, ErrOffsetOutOfBounds | ||
| } else if proof && (offset%LeafSize != 0) || len(action.Data)%LeafSize != 0 { | ||
| return RPCCost{}, ErrUpdateProofSize | ||
| } | ||
| default: | ||
| return RPCCost{}, fmt.Errorf("unknown write action type '%v'", action.Type) | ||
| } | ||
| } | ||
|
|
||
| cost := RPCCost{ | ||
| Base: hs.BaseRPCPrice, // base cost of the RPC | ||
| Ingress: hs.UploadBandwidthPrice.Mul64(uploadBytes), // cost of uploading the new sectors | ||
| } | ||
|
|
||
| if newSectors > oldSectors { | ||
| additionalSectors := (newSectors - oldSectors) | ||
| cost.Storage = hs.StoragePrice.Mul64(SectorSize * additionalSectors * remainingDuration) // cost of storing the new sectors | ||
| cost.Collateral = hs.Collateral.Mul64(SectorSize * additionalSectors * remainingDuration) // collateral for the new sectors | ||
| } | ||
|
|
||
| if proof { | ||
| // estimate cost of Merkle proof | ||
| proofSize := DiffProofSize(actions, oldSectors) | ||
| cost.Egress = hs.DownloadBandwidthPrice.Mul64(proofSize * 32) | ||
| } | ||
| return cost, nil | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Functionally this type matches the
ResourceCostin RHPv3, we could move this into thetypespackage maybe and use the one type. I didn't want to do that yet mostly because of the documentation inResourceCostwhich is tailored to the MDM... Maybe it's fine to just have both, for the same reasonhostdhad its own internalrpcCosttype.