nuttycom/aftok - Change POX3UAMTGCNS3SU5I6IKDNCCSHEAUSFBZ3WCMQ3EXKPNXETOI6BAC

Enabling logging of time to contributor/project accounts

Created by Kris Nuttycombe on June 19, 2016

POX3UAMTGCNS3SU5I6IKDNCCSHEAUSFBZ3WCMQ3EXKPNXETOI6BAC

Dependencies

In channels

main

Change contents

Insertion in TASKS.md at line 26 [5.1]

[4.79]

[5.1518]

  * Events
    * User-identified events
      - Associate events with user identifier as well as BTC address, and add 
        late resolution of BTC addresses at point of payout calculation.

Replacement in TASKS.md at line 35 [5.1]

B:BD[5.1860] → [5.1860:1952]

    * Payouts should not include events younger than <commit_delay hours> to permit amends.

[5.1860]

[5.1952]

    * Payouts should not include events younger than <commit_delay hours> to permit amends.

Replacement in TASKS.md at line 41 [5.1]

∅:D[2.1816] → [5.2054:2140]

B:BD[5.2054] → [5.2054:2140]

    * Include hours won in resource auction - requires confirmation that contribution

[2.1816]

[5.2140]

    * Include hours won in resource auction - requires confirmation that contribution - Kris wip

Insertion in TASKS.md at line 43 [5.1]

[5.2203]

    * Ensure that we avoid creating dust transactions on the blockchain. Any payout fragment
      falling below the estimated cost of redemption should be instead deducted from the 
      cost to the purchaser?

Replacement in TASKS.md at line 56 [5.1]
B:BD[5.2512] → [4.228:248]
```
Webserver
---------
```
[5.2512]
[6.1]
```
Server
------
```
Replacement in TASKS.md at line 68 [5.1]
B:BD[5.2758] → [4.249:281]
```
Payouts Service
---------------
```
[5.2758]
[4.281]
```
Scheduled event Service
-----------------------
```
Replacement in TASKS.md at line 71 [5.1]
∅:D[4.282] → [5.2775:2808]
B:BD[5.2775] → [5.2775:2808]
B:BD[5.2836] → [5.2836:2875]
```
  * Read blockchain transactions
    * Payout Address Update validation
```
[4.282]
[5.2940]
```
  * Based on blockchain transactions:
```
Insertion in aftok.cabal at line 64 [9.1]
[7.1051]
[8.2887]
```
    , unordered-containers
```
Insertion in lib/Aftok/Json.hs at line 16 [11.19]
[10.1270]
[11.231]
```
import           Data.HashMap.Strict              as O
```
Insertion in lib/Aftok/Json.hs at line 75 [11.19]
[12.4903]
[12.4903]
```
v2 :: Value -> Value
v2 = versioned $ Version 2 0
```

Replacement in lib/Aftok/Json.hs at line 80 [11.19]

B:BD[12.4963] → [12.4963:4979]

B:BD[12.4979] → [10.1605:1631]

∅:D[10.1631] → [12.5006:5114]

B:BD[12.5006] → [12.5006:5114]

unv1 name f v =
  let p (Version 1 0) = f
      p ver = const . fail $ "Unrecognized " <> name <> " schema version: " <> show ver
  in  unversion p v

[12.4963]

[12.5114]

unv1 name f = unversion $ \x -> case x of
  Version 1 0 -> f
  _           -> badVersion name x
badVersion :: String -> Version -> Value -> Parser a
badVersion name ver = const . fail $ "Unrecognized " <> name <> " schema version: " <> show ver

Insertion in lib/Aftok/Json.hs at line 123 [11.19]

[13.2561]

[3.580]

creditToJSON :: CreditTo -> Value
creditToJSON (CreditToAddress addr) = v2 $ object [ "creditToAddress" .= addr ]
creditToJSON (CreditToUser uid)     = v2 $ object [ "creditToUser"    .= (uid ^. _UserId) ]
creditToJSON (CreditToProject pid)  = v2 $ object [ "creditToProject" .= projectIdJSON pid ]

Replacement in lib/Aftok/Json.hs at line 130 [11.19]
B:BD[12.5372] → [12.5372:5410]
```
  toJSON $ MS.mapKeys (^. _BtcAddr) m
```
[12.5372]
[14.1904]
```
  toJSON $ (creditToJSON *** id) <$> MS.assocs m
```

Replacement in lib/Aftok/Json.hs at line 132 [11.19]

B:BD[14.1905] → [14.1905:1941]

B:BD[14.1941] → [12.5411:5449]

B:BD[12.5449] → [15.1180:1264]

workIndexJSON :: WorkIndex -> Value
workIndexJSON (WorkIndex widx) = v1 $
  toJSON $ (L.toList . fmap intervalJSON) <$> MS.mapKeysMonotonic (^._BtcAddr) widx

[14.1905]

[14.2061]

workIndexJSONV1 :: WorkIndex -> Value
workIndexJSONV1 (WorkIndex widx) = v1 $
  toJSON $ (L.toList . fmap intervalJSON) <$> 
  MS.mapKeysMonotonic (^? (_CreditToAddress._BtcAddr)) widx

Replacement in lib/Aftok/Json.hs at line 142 [11.19]
B:BD[16.1833] → [12.5520:5558]
∅:D[12.5558] → [16.1867:1909]
B:BD[16.1867] → [16.1867:1909]
```
logEntryJSON (LogEntry a ev m) = v1 $
  object [ "btcAddr"   .= (a ^. _BtcAddr)
```
[16.1833]
[16.1909]
```
logEntryJSON (LogEntry c ev m) = v2 $ 
  object [ "creditTo"  .= creditToJSON c
```

Replacement in lib/Aftok/Json.hs at line 159 [11.19]

B:BD[12.5811] → [10.1697:1744]

  Payouts . MS.mapKeys BtcAddr <$> parseJSON v

[12.5811]

[12.5859]

  Payouts . MS.mapKeys (CreditToAddress . BtcAddr) <$> parseJSON v

Replacement in lib/Aftok/Json.hs at line 162 [11.19]

B:BD[12.5925] → [10.1745:1769]

∅:D[10.1769] → [12.5950:6047]

B:BD[12.5950] → [12.5950:6047]

B:BD[12.6047] → [10.1770:1919]

∅:D[10.1919] → [12.6202:6236]

B:BD[12.6202] → [12.6202:6236]

B:BD[12.6236] → [10.1920:1954]

∅:D[10.1954] → [12.6271:6317]

B:BD[12.6271] → [12.6271:6317]

B:BD[12.6317] → [10.1955:1978]

∅:D[10.1978] → [12.6341:6406]

B:BD[12.6341] → [12.6341:6406]

parseEventAmendment t =
  let parseA x "timeChange" = TimeChange t <$> x .: "eventTime"
      parseA x "addrChage"  = do
        addrText <- x .: "btcAddr"
        maybe
          (fail $ show addrText <> "is not a valid BTC address")
          (pure . AddressChange t)
          $ parseBtcAddr addrText
      parseA x "metadataChange" =
        MetadataChange t <$> x .: "eventMeta"
      parseA _ other =
        fail $ "Amendment value " <> other <> " not recognized."

[12.5925]

[12.6406]

parseEventAmendment t = unversion $ \v -> case v of
  Version 1 0 -> parseEventAmendmentV1 t
  Version 2 0 -> parseEventAmendmentV2 t
  _           -> badVersion "EventAmendment" v
parseEventAmendmentV1 :: ModTime -> Value -> Parser EventAmendment
parseEventAmendmentV1 t v@(Object x) =
  let parseA :: Text -> Parser EventAmendment
      parseA "timeChange"     = TimeChange t <$> x .: "eventTime"
      parseA "addrChange"     = CreditToChange t <$> parseCreditTo v
      parseA "metadataChange" = MetadataChange t <$> x .: "eventMeta"
      parseA id = fail . show $ "Amendment type " <> id <> " not recognized."
  in  x .: "amendment" >>= parseA 
parseEventAmendmentV1 t x =
  fail $ "Value " <> show x <> " is not a JSON object."
parseEventAmendmentV2 :: ModTime -> Value -> Parser EventAmendment
parseEventAmendmentV2 t v@(Object x) =
  let parseA :: Text -> Parser EventAmendment
      parseA "timeChange"     = TimeChange t <$> x .: "eventTime"
      parseA "creditToChange" = CreditToChange t <$> parseCreditTo v
      parseA "metadataChange" = MetadataChange t <$> x .: "eventMeta"
      parseA id = fail . show $ "Amendment type " <> id <> " not recognized."
  in  x .: "amendment" >>= parseA 
parseEventAmendmentV2 t x =
  fail $ "Value " <> show x <> " is not a JSON object."
parseBtcAddrJson :: Value -> Parser BtcAddr
parseBtcAddrJson v = do
  t <- parseJSON v
  maybe (fail $ show t <> " is not a valid BTC address") pure $ parseBtcAddr t

Replacement in lib/Aftok/Json.hs at line 196 [11.19]

B:BD[12.6407] → [12.6407:6529]

B:BD[12.6529] → [10.1979:2003]

      p (Object x) = x .: "amendment" >>= parseA x
      p x = fail $ "Value " <> show x <> " missing 'amendment' field."
  in unv1 "amendment" p

[12.6407]

[12.6554]

parseCreditTo :: Value -> Parser CreditTo
parseCreditTo = unversion $ \x -> case x of
  Version 1 0 -> withObject "BtcAddr" parseCreditToV1
  Version 2 0 -> withObject "CreditTo" parseCreditToV2
  _           -> badVersion "EventAmendment" x
parseCreditToV1 :: Object -> Parser CreditTo 
parseCreditToV1 x = CreditToAddress <$> (parseBtcAddrJson =<< (x .: "btcAddr"))

Insertion in lib/Aftok/Json.hs at line 205 [11.19]

[12.6555]

parseCreditToV2 :: Object -> Parser CreditTo
parseCreditToV2 x = 
  let parseCreditToAddr (Object x') = do 
        addrText <- O.lookup "creditToAddress" x'
        pure (CreditToAddress <$> parseBtcAddrJson addrText)
      parseCreditToAddr x' = Nothing
      parseCreditToUser (Object x') = Nothing
      parseCreditToUser x' = Nothing
      parseCreditToProject (Object x') = Nothing
      parseCreditToProject x' = Nothing
      notFound = fail $ "Value " <> show x <> " does not represent a CreditTo value."
      parseV v = (parseCreditToAddr v <|> parseCreditToUser v <|> parseCreditToProject v)
  in  do
    body <- x .: "creditTo"
    fromMaybe notFound $ parseV body

Replacement in lib/Aftok/Project.hs at line 15 [17.1031]

B:BD[17.1382] → [17.1382:1437]

newtype ProjectId = ProjectId UUID deriving (Show, Eq)

[17.1382]

[17.1437]

newtype ProjectId = ProjectId UUID deriving (Show, Eq, Ord)

Replacement in lib/Aftok/TimeLog.hs at line 5 [19.846]

∅:D[18.1805] → [19.907:924]

∅:D[20.4159] → [19.907:924]

∅:D[9.5325] → [19.907:924]

B:BD[19.907] → [19.907:924]

B:BD[19.924] → [21.1083:1130]

B:BD[21.1130] → [16.2033:2069]

  ( LogEntry(..)
  , btcAddr, event, eventMeta
  , LogEvent(..)
  , eventName, nameEvent, eventTime

[20.4159]

[14.2136]

  ( LogEntry(..), creditTo, event, eventMeta
  , CreditTo(..), _CreditToAddress, _CreditToUser, _CreditToProject
  , LogEvent(..), eventName, nameEvent, eventTime

Insertion in lib/Aftok/TimeLog.hs at line 36 [19.846]
[20.4695]
[19.1224]
```
import           Aftok.Project (ProjectId)
```

Insertion in lib/Aftok/TimeLog.hs at line 57 [19.846]

[22.3954]

[23.431]


data CreditTo 
  -- payouts are made directly to this address, or to an address replacing this one
  = CreditToAddress BtcAddr 
  -- payouts are distributed as requested by the specified contributor
  | CreditToUser UserId
  -- payouts are distributed to this project's contributors 
  | CreditToProject ProjectId
  deriving (Show, Eq, Ord)
makePrisms ''CreditTo

Replacement in lib/Aftok/TimeLog.hs at line 69 [19.846]
B:BD[20.4721] → [20.4721:4747]
```
  { _btcAddr   :: BtcAddr
```
[20.4721]
[20.4747]
```
  { _creditTo  :: CreditTo
```
Replacement in lib/Aftok/TimeLog.hs at line 77 [19.846]
∅:D[20.4791] → [21.1817:1865]
B:BD[24.259] → [21.1817:1865]
```
    let ordElems e = (e ^. event, e ^. btcAddr)
```
[20.4791]
[24.343]
```
    let ordElems e = (e ^. event, e ^. creditTo)
```

Replacement in lib/Aftok/TimeLog.hs at line 87 [19.846]

B:BD[12.6772] → [12.6772:6824]

                    | AddressChange ModTime BtcAddr

[12.6772]

[12.6824]

                    | CreditToChange ModTime CreditTo

Replacement in lib/Aftok/TimeLog.hs at line 93 [19.846]
B:BD[19.2287] → [4.5972:6021]
```
newtype Payouts = Payouts (Map BtcAddr Rational)
```
[4.5971]
[4.6021]
```
newtype Payouts = Payouts (Map CreditTo Rational)
```

Replacement in lib/Aftok/TimeLog.hs at line 96 [19.846]

B:BD[4.6562] → [24.384:468]

newtype WorkIndex = WorkIndex (Map BtcAddr (NonEmpty Interval)) deriving (Show, Eq)

[4.6043]

[24.468]

newtype WorkIndex = WorkIndex (Map CreditTo (NonEmpty Interval)) deriving (Show, Eq)

Replacement in lib/Aftok/TimeLog.hs at line 148 [19.846]

B:BD[21.2114] → [21.2114:2169]

type RawIndex = Map BtcAddr [Either LogEvent Interval]

[21.2114]

[21.2169]

type RawIndex = Map CreditTo [Either LogEvent Interval]

Replacement in lib/Aftok.hs at line 27 [19.2457]
∅:D[25.10878] → [16.2221:2270]
B:BD[19.2764] → [16.2221:2270]
```
newtype UserId = UserId UUID deriving (Show, Eq)
```
[25.10878]
[13.2771]
```
newtype UserId = UserId UUID deriving (Show, Eq, Ord)
```

Enabling logging of time to contributor/project accounts

Dependencies

In channels

Change contents

Insertion in TASKS.md at line 26 [5.1]

Replacement in TASKS.md at line 35 [5.1]

Replacement in TASKS.md at line 41 [5.1]

Insertion in TASKS.md at line 43 [5.1]

Replacement in TASKS.md at line 56 [5.1]

Replacement in TASKS.md at line 68 [5.1]

Replacement in TASKS.md at line 71 [5.1]

Insertion in aftok.cabal at line 64 [9.1]

Insertion in lib/Aftok/Json.hs at line 16 [11.19]

Insertion in lib/Aftok/Json.hs at line 75 [11.19]

Replacement in lib/Aftok/Json.hs at line 80 [11.19]

Insertion in lib/Aftok/Json.hs at line 123 [11.19]

Replacement in lib/Aftok/Json.hs at line 130 [11.19]

Replacement in lib/Aftok/Json.hs at line 132 [11.19]

Replacement in lib/Aftok/Json.hs at line 142 [11.19]

Replacement in lib/Aftok/Json.hs at line 159 [11.19]

Replacement in lib/Aftok/Json.hs at line 162 [11.19]

Replacement in lib/Aftok/Json.hs at line 196 [11.19]

Insertion in lib/Aftok/Json.hs at line 205 [11.19]

Replacement in lib/Aftok/Project.hs at line 15 [17.1031]

Replacement in lib/Aftok/TimeLog.hs at line 5 [19.846]

Insertion in lib/Aftok/TimeLog.hs at line 36 [19.846]

Insertion in lib/Aftok/TimeLog.hs at line 57 [19.846]

Replacement in lib/Aftok/TimeLog.hs at line 69 [19.846]

Replacement in lib/Aftok/TimeLog.hs at line 77 [19.846]

Replacement in lib/Aftok/TimeLog.hs at line 87 [19.846]

Replacement in lib/Aftok/TimeLog.hs at line 93 [19.846]

Replacement in lib/Aftok/TimeLog.hs at line 96 [19.846]

Replacement in lib/Aftok/TimeLog.hs at line 148 [19.846]

Replacement in lib/Aftok.hs at line 27 [19.2457]