escrow_v4 source realm

 1const (
 2	// PlatformFeePct is only the fail-safe fallback rate (see resolveFee); the
 3	// live rate is cfg.GetFeeBPS(laneService), read at each payout.
 4	PlatformFeePct = 2
 5	// CancelFeePct is paid to the freelancer from each funded milestone when
 6	// the client cancels. Escrow-internal, not a protocol fee.
 7	CancelFeePct = 5
 8	// Timeouts, in blocks, as in v3 (sized at 3 s per block; at gnoland-1's
 9	// ~3.3 s they are ~33 and ~31 days). Blocks inside a pause's blocking
10	// window do not count (see the pause section).
11	AutoRefundBlks  = int64(864000)
12	AutoResolveBlks = int64(806400)
13	// UnfundedExpiryBlks: a contract none of whose milestones was ever funded
14	// can be cancelled by anyone after this many blocks, freeing its slot.
15	UnfundedExpiryBlks = AutoRefundBlks
16
17	MaxTitleLen        = 200  // bytes, after sanitising (also bounds the input)
18	MaxDescLen         = 5000 // bytes, after sanitising (also bounds the input)
19	MaxMilestones      = 20
20	MinMilestoneAmount = int64(1000) // 0.001 GNOT: below ~50 ugnot a 2% fee truncates to 0
21	// maxMilestonesArgLen bounds the raw milestones argument before parsing:
22	// 20 entries of a 200-byte title, a 19-digit amount and separators, with
23	// room for surrounding spaces.
24	maxMilestonesArgLen = MaxMilestones * (MaxTitleLen + 64)
25
26	// MaxActivePerClient bounds the open contracts one client address may
27	// hold. It counts only contracts the address created, never those naming
28	// it as freelancer, so nobody can use up someone else's slots, and it
29	// bounds what one key can lock (five of the largest contracts are about
30	// 15 GNOT of storage deposit). There is no global cap: nothing iterates
31	// over every contract, so a global number would bound no gas and would
32	// only give a funded attacker a switch to turn escrow off for everyone.
33	MaxActivePerClient = 5
34)

1const (
2	// MaxPauseBlks is the blocking window: about 7 days at gnoland-1's
3	// observed average of about 3.3 s per block (7*24*3600/3.3 = 183,273).
4	MaxPauseBlks = int64(183273)
5	// PauseCooldownBlks is the minimum gap between an Unpause and the next
6	// Pause, so a pause can hold exits shut at most half of the time.
7	PauseCooldownBlks = MaxPauseBlks
8)

1const RenderPageSize = 20

1const (
2	StatusActive    ContractStatus = "active"
3	StatusCompleted ContractStatus = "completed"
4	StatusDisputed  ContractStatus = "disputed"
5	StatusCancelled ContractStatus = "cancelled"
6)

1const (
2	MsPending   MilestoneStatus = "pending"
3	MsFunded    MilestoneStatus = "funded"
4	MsCompleted MilestoneStatus = "completed"
5	MsReleased  MilestoneStatus = "released"
6	MsDisputed  MilestoneStatus = "disputed"
7	MsRefunded  MilestoneStatus = "refunded"
8)

1func AcceptFeeRecipient(cur realm)

1func AcceptOwnership(cur realm)

1func ArchiveContract(cur realm, contractId string)

1func CancelContract(cur realm, contractId string)

1func CancelFeeRecipientProposal(cur realm)

1func CancelOwnershipTransfer(cur realm)

1func ClaimDisputeTimeout(cur realm, contractId string, milestoneIdx int)

1func ClaimRefund(cur realm, contractId string, milestoneIdx int)

1func CompleteMilestone(cur realm, contractId string, milestoneIdx int)

1func CreateContract(cur realm, freelancer address, title, description, milestones string) string

1func ExpireUnfunded(cur realm, contractId string)

1func FundMilestone(cur realm, contractId string, milestoneIdx int)

1func GetActiveCount() int

1func GetAdmin() string

1func GetArchivedCount() int

1func GetClientActiveCount(client address) int

1func GetClientContractsJSON(client address, before string, limit int) string

1func GetContractJSON(id string) string

1func GetCreatedCount() int

1func GetFeeRecipient() string

1func GetLiveCount() int

1func GetPauseStateJSON() string

1func GetPendingAdmin() string

1func GetPendingFeeRecipient() string

1func IsPaused() bool

1func Pause(cur realm)

1func ProposeFeeRecipient(cur realm, recipient address)

1func RaiseDispute(cur realm, contractId string, milestoneIdx int)

1func RealmAddress() string

1func ReleaseFunds(cur realm, contractId string, milestoneIdx int)

1func Render(path string) string

1func ResolveDispute(cur realm, contractId string, milestoneIdx int, refundClient bool)

1func TotalLiabilities() int64

1func TransferOwnership(cur realm, newAdmin address)

1func Unpause(cur realm)

1func GetGovernanceContract(id string) GovernanceContract

1func GetGovernanceFeeTerms() GovernanceFeeTerms

1func PauseState() PauseInfo

 1type Contract struct {
 2	ID          string
 3	Client      address
 4	Freelancer  address
 5	Title       string
 6	Description string
 7	Status      ContractStatus
 8	CreatedAt   int64 // block height
 9	Milestones  []Milestone
10
11	createdPauseMark int64 // pausedBlocksAt(CreatedAt), for UnfundedExpiryBlks
12}

1type ContractStatus string

1type GovernanceContract struct {
2	Exists                  bool
3	ID, ContentHash, Status string
4	Client, Freelancer      address
5	Count                   int
6	Milestones              [20]GovernanceMilestone
7}

1type GovernanceFeeTerms struct {
2	RawBPS, EffectiveBPS                             int64
3	RawTreasury, FallbackTreasury, EffectiveTreasury address
4}

1type GovernanceMilestone struct {
2	ID                                int
3	Amount                            int64
4	Status                            string
5	FundedAt, CompletedAt, DisputedAt int64
6	PreDisputeStatus                  string
7}

 1type Milestone struct {
 2	ID               int // equals the milestone's index
 3	Title            string
 4	Amount           int64 // ugnot
 5	Status           MilestoneStatus
 6	FundedAt         int64           // block height (0 if not funded)
 7	CompletedAt      int64           // block height (0 if not completed)
 8	DisputedAt       int64           // block height (0 if not disputed)
 9	PreDisputeStatus MilestoneStatus // status before dispute (MsFunded or MsCompleted)
10
11	fundedPauseMark   int64 // pausedBlocksAt(FundedAt), for AutoRefundBlks
12	disputedPauseMark int64 // pausedBlocksAt(DisputedAt), for AutoResolveBlks
13}

1type MilestoneStatus string

1type PauseInfo struct {
2	Paused        bool  // set by Pause, cleared only by Unpause
3	PausedAt      int64 // height of the current pause (0 when not paused)
4	ExitsReopenAt int64 // PausedAt + MaxPauseBlks (0 when not paused)
5	ExitsOpen     bool  // false only inside a blocking window
6	CooldownUntil int64 // first height at which Pause is accepted
7	PausedBlocks  int64 // total blocking-window blocks so far (clocks skip them)
8}