Files
simplex-chat/apps/simplex-store-service/src/StoreService/Names/Community.hs
T
ad75fe706f store: sell and register SimpleX names (#7979)
* core: add prepaid name codes and length bounds

* store: run the names migration after badges

* store: issue and revoke prepaid name codes

* store: document issuing prepaid name codes

* store: move the ABI helpers to Names.Abi

* store: read the [names] and [chain] settings

* store: add the names chain client and reads

* store: refuse group name codes while names are off

* store: search names and preview links

* store: serve each site on its own port

* scripts: deploy the badges and names sites

* store: document search and the two sites

* store: add the drop_taken_codes migration

* store: read the names codes_only setting

* store: add the names store and order signatures

* store: take name orders by card, crypto or code

* store: document name orders and codes-only

* store: add the names transaction sender

* store: commit and register queued orders

* store: reveal and retry an owner's order

* store: document the gas key

* store: add the name balance migrations

* store: read crypto units, rates and confirmations

* store: keep a taken order's money as a balance

* store: spend a balance on another name

* store: record refunds with //refund

* store: document balances and refunds

* store: add the agreed terms migration

* store: read the terms and community names

* store: answer community and terms in search

* store: sign and store the agreed terms

* store: document the terms and community names

* store: add the invoiced units migration

* store: read the crypto an invoice asks

* store: credit late and overpaid crypto by share

* store: document crediting late crypto by share

* store: add the record changes migration

* store: find an owner's orders and move one

* store: relay owners' link edits on chain

* store: document link edits

* store: move isLoopbackHost to Config

* store: trust dev issuer keys on the local chain

* scripts: build the names site from a submodule

* scripts: add the dev setup and contract run

* store: document the dev setup and names image

* store: send a Stripe idempotency key for names

* tests: wait until a relay lets go of its edit

* store: refuse a link edit deadline under 10 min

* store: count reverted link edits in the year limit

* store: require https for a remote chain node

* store: refuse zero chain confirmations

* store: set up the dev stack from the names branch

* store: rerun a failed unpaid cleanup next pass

* store: never replace a succeeded Stripe intent

* store: refuse an ini setting written as key: value

* store: note the webapp submodule's pinned branch

* store: document confirmLanded judging by ownerOf

* store: update the names webapp submodule

* store-service: register names under the name policy, every name accepting its terms on chain (#7889)

* store: accept each name's terms on chain under the name policy

* ci: run the reduced build on sh/names-deploy

* store: address review: policy re-read, terms reads and startup log

* store: never credit an unconfirmed extra

* store: alert money sent to a paid name invoice

* store: refuse to start on another chain's node

* store: keep orders while the allowance is used up

* store: replace a stalled transaction after 3 blocks

* store: judge a name taken at confirmation depth

* store: bind the template's listener to loopback

* store: scan only the ids of active name orders

* store: refuse unknown [names] and [chain] settings

* store: fetch the webapp submodule in upgrade steps

* store: delete definitions only tests use

* store: lock only name invoices at settlement

* store: retry an unexpired commitment as usual

* store: share the helpers defined twice

* store: test route limits on the running service

* store: fix tests that could not fail

* ci: test the store service on Postgres

* store: count IPv6 clients by their /64

* store: sweep invoices read alone past a list cap

* store: cap checkouts of all clients together

* store: cap the long polls held at once

* store: stop the old badge project at upgrade

* store: keep search lookups free of previews

* store: read the ini as UTF-8 in any locale

* ci: run Postgres store tests in a UTF-8 locale

* store: cap the transactions one order sends

* store: cancel a card intent after three declines

* store: refuse a name price under a cent

* store: send each transaction with gas headroom

* store: cap searches and read terms once per block

* store: never log the group join link

* store: mask the database password at startup

* store: run one instance per database

* store: limit name codes to admins, 100 a day

* store: refuse HighSpeed settlement with names

* store: no unverified receipts with a trusted key

* store: cap the log lines of refused webhooks

* store: check Apple certificates at the signed date

* store: refuse a malformed Stripe publishable key

* store: check the owner before a refund

* store: fold the names migrations into one

* store: read onion name links through the proxy

* store: refund money after paid once confirmed

* store: limit the allowance wait to a dry run

* store: bind loopback when upgrading

* ci: cache and widen the store Postgres job

* store: fix stale and duplicate names tests

* store: fix the submodule path in the upgrade

* store: refuse unpaid name codes on the CLI

* store: apply the review's names test list

* store: finish the review's names test list

* store: restore the base registration tests

* store: pass link hosts that do not resolve here

* store: refuse a move once its sends are used up

* store: take the shared checkout at the provider

* store: hold a search slot for chain reads only

* store: state which refunds are safe on a reference

* store: check a failed order's name before refusing its move (#8060)

* store: test and document the shared checkout cap for name orders

* store: check a failed order's name on chain before refusing its move

* store: test name links whose host lookup fails

* store: test that a search holds its slot through the chain reads only

* store: restore the signed transaction check in the chain tests

* store: remove the chain tests' copy of the signed transaction check

* store: correct the search slot texts and the README's balance endpoints

* docs: system and sequence diagrams of the names service (#8068)

---------

Co-authored-by: sh-agents <350651734+sh-agents@users.noreply.github.com>
Co-authored-by: Evgeny Poberezkin <evgeny@poberezkin.com>
Co-authored-by: brenzi-agent <brenzi-agent@brenzi.ch>
Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com>
2026-11-07 10:45:19 +00:00

90 lines
3.8 KiB
Haskell

{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
module StoreService.Names.Community
( communityFor,
termsFor,
agreedTermsHash,
communityTermsPrefix,
communityJSON,
yearsFor,
termsJSON,
kindTerms,
nameTerms,
readableTerms,
AcceptanceAsked (..),
currentAcceptance,
)
where
import Control.Monad.Except (ExceptT (..), runExceptT, throwError)
import Data.Aeson ((.=))
import qualified Data.Aeson as J
import Data.Bifunctor (bimap)
import Data.ByteString (ByteString)
import qualified Data.Map.Strict as M
import Data.Text (Text)
import qualified Data.Text as T
import Data.Word (Word64)
import Simplex.Messaging.Eth.Address (Address)
import Simplex.Messaging.SimplexName (LabelHash (..))
import StoreService.Config (NamesConfig (..))
import StoreService.Names.Abi (bytes32FromHex, hex)
import StoreService.Names.Chain (ChainError (..))
import StoreService.Names.Contracts (Contracts, Terms (..), TermsRefusal (..), communityName, concurrent, namePolicy, policyNonce, termsLinks, termsOf, termsText, together)
communityFor :: NamesConfig -> LabelHash -> Maybe Text
communityFor NamesConfig {nCommunity} (LabelHash h) = M.lookup h nCommunity
-- | The prefix records that the buyer agreed to the community terms, whose hash follows it.
termsFor :: Bool -> Terms -> Text
termsFor listed Terms {tmHash} = (if listed then communityTermsPrefix else "") <> T.drop 2 (hex tmHash)
-- | The community terms hash an order signed, Nothing for plain terms.
agreedTermsHash :: Text -> Maybe ByteString
agreedTermsHash terms = bytes32FromHex . ("0x" <>) =<< T.stripPrefix communityTermsPrefix terms
communityTermsPrefix :: Text
communityTermsPrefix = "community/"
-- | Null for plain terms.
communityJSON :: NamesConfig -> LabelHash -> Bool -> J.Value
communityJSON cfg lh listed = if listed then J.object ["for" .= communityFor cfg lh, "years" .= communityYears] else J.Null
-- | The paid years of a community name, whatever years its code or [names] years gives.
communityYears :: Int
communityYears = 2
yearsFor :: Bool -> Int -> Int
yearsFor listed years = if listed then communityYears else years
termsJSON :: Maybe Terms -> J.Value
termsJSON = maybe J.Null $ \Terms {tmLink, tmHash} -> J.object ["hash" .= hex tmHash, "link" .= tmLink]
kindTerms :: Bool -> (Text, Text) -> Maybe Terms
kindTerms listed (generalLink, communityLink) = termsOf $ if listed then communityLink else generalLink
-- | Whether the policy lists the name, and the terms it is sold under: the community terms for a listed name, else the
-- general terms; Nothing until the owner sets them.
nameTerms :: Contracts -> LabelHash -> IO (Either ChainError (Bool, Maybe Terms))
nameTerms ct lh = together $ (\listed links -> (listed, kindTerms listed links)) <$> concurrent (communityName ct lh) <*> concurrent (termsLinks ct)
readableTerms :: Contracts -> Maybe Terms -> IO (Either (Maybe Int) Terms)
readableTerms ct = maybe (pure $ Left Nothing) $ \t -> bimap waitOf (const t) <$> termsText ct t
where
waitOf (TRWait seconds) = Just seconds
waitOf TRLink = Nothing
-- | What the page signs to accept the terms of the name's kind.
data AcceptanceAsked = AcceptanceAsked {acCommunity :: Bool, acPolicy :: Address, acTermsHash :: ByteString, acNonce :: Word64}
deriving (Eq, Show)
-- | Fails while the terms of the name's kind are not set.
currentAcceptance :: Contracts -> LabelHash -> Address -> IO (Either ChainError AcceptanceAsked)
currentAcceptance ct lh owner = runExceptT $ do
(acCommunity, terms) <- ExceptT $ nameTerms ct lh
Terms {tmHash = acTermsHash} <- maybe (throwError $ ChainUnavailable "the name policy has not set these terms yet") pure terms
acPolicy <- ExceptT $ namePolicy ct
acNonce <- ExceptT $ policyNonce ct owner
pure AcceptanceAsked {acCommunity, acPolicy, acTermsHash, acNonce}