Pour les développeurs / SENDIT

SenditBank

Un seul contrat détient l'argent de chaque compte SENDIT. Un portefeuille dépose une fois et enregistre une clé ; la clé signe ensuite les trades, et chaque venue la ramène au compte du portefeuille.

Le modèle

  • Comptes. Un compte est une adresse de portefeuille (ou n'importe quel contrat qui agit comme son propre compte). Les soldes sont balanceOf[account][asset], jamais indexés par une clé.
  • Actifs. pUSD, l'ETH sous la forme address(0), et les jetons d'un launcher ajouté par l'opérateur (isAsset). Tout autre jeton est refusé. totalHeld[asset] est la somme exacte de tous les soldes et n'excède jamais ce que détient la banque.
  • Clés. Des adresses qu'un compte a enregistrées avec une preuve signée par la clé. Une clé dépense le solde du compte auprès des venues, envoie, retire vers le propre portefeuille du compte, recharge son propre gas et révoque. Elle ne peut ni enregistrer de clés, ni changer les plafonds, ni faire un withdrawTo vers une autre adresse.
  • Venues. Les contrats autorisés à débiter les comptes : le moteur, le carnet d'ordres, le coffre, la copy factory, le routeur spot, l'échange pUSD. Chacun appelle bank.pull(msg.sender, asset, amount) avec son propre appelant, si bien qu'un venue ne peut pas choisir l'argent de qui il prend. Chaque paiement revient par bank.push(account, ...), jamais vers le signataire.

Il n'y a ni receive(), ni balayage, ni modification de solde, ni mise à niveau, ni frais. L'ETH n'entre que par deposit et push.

Les comptes et accountOf

accountOf(sender) est le compte pour lequel agit un expéditeur : le propriétaire tant que sender est une clé enregistrée sous le keyEpoch actuel du compte et le globalEpoch actuel, et sender lui-même sinon. Un portefeuille se résout donc vers lui-même, et chaque venue fonctionne aussi avec une signature du portefeuille. Les positions, les parts du coffre, les comptes de copie et chaque événement désignent le compte, jamais la clé.

Une clé est périmée quand accountOf(keyOf(account)) != account. Il n'y a pas de playerOf ici : c'est le nom que la banque de l'arcade donne à la même idée.

La preuve de clé

La clé consent à servir le compte en signant un condensé :

Solidity
keyDigest(account, key) = keccak256(abi.encode(
  "SENDIT/key-proof/v1", block.chainid, address(bank), account, key,
  keyEpoch[account], globalEpoch))

La preuve est la signature EIP-191 de ces 32 octets par la clé ("\x19Ethereum Signed Message:\n32" || digest) : 65 octets, s bas, v à 27 ou 28 (0 et 1 sont acceptés). Le portefeuille l'envoie ensuite avec setKey(key, proof) ou dans deposit(pusdAmount, gasToKey, key, proof), qui peut aussi financer le gas de la clé dans la même transaction.

viem
import { encodeAbiParameters, parseAbiParameters, keccak256 } from "viem";
import { generatePrivateKey, privateKeyToAccount } from "viem/accounts";

const key = privateKeyToAccount(generatePrivateKey()); // keep the private key safe

// ADD a key under the epochs in force: the bank computes the digest for you.
const digest = await client.readContract({
  address: bank, abi: bankAbi, functionName: "keyDigest", args: [account, key.address],
});
const proof = await key.signMessage({ message: { raw: digest } }); // EIP-191, 32 bytes

// REPLACE every key of the account: the same digest under keyEpoch + 1.
const [epoch, global] = await Promise.all([
  client.readContract({ address: bank, abi: bankAbi, functionName: "keyEpoch", args: [account] }),
  client.readContract({ address: bank, abi: bankAbi, functionName: "globalEpoch" }),
]);
const nextDigest = keccak256(encodeAbiParameters(
  parseAbiParameters("string, uint256, address, address, address, uint64, uint64"),
  ["SENDIT/key-proof/v1", 78270n, bank, account, key.address, epoch + 1n, global],
));
const replaceProof = await key.signMessage({ message: { raw: nextDigest } });
Comment l'application fabrique sa clé

Le front end de SENDIT dérive la clé d'une signature, par le portefeuille, d'un message EIP-4361 fixe ("Unlock my SENDIT trading key...", lié au domaine, à la chaîne, à la banque et aux deux époques), si bien que chaque appareil redérive la même clé. Un bot n'en a pas besoin : n'importe quelle clé que vous détenez fonctionne, du moment que sa preuve est correcte.

Époques : ajouter ou remplacer

Une preuve est vérifiée contre l'une de deux paires d'époques, et c'est elle qui décide de ce qui se passe :

  • Époques actuelles : AJOUT. La clé rejoint les clés actives du compte ; toutes les autres clés restent actives (une clé par appareil).
  • keyEpoch + 1 : REMPLACEMENT. La banque révoque d'abord (l'époque avance, toutes les clés prennent fin, KeyRevoked), puis enregistre la clé sous la nouvelle époque.

revokeKey() met fin à toutes les clés du compte ; rotateKey(newKey, proof) révoque et enregistre dans une seule transaction, avec une preuve sous la nouvelle époque. invalidateAllKeys() fait avancer globalEpoch et met fin à toutes les clés de la banque. keyOf(account) n'est que la dernière clé enregistrée, celle qui reçoit le gas du dépôt.

Plafonds

Les sorties de pUSD et d'ETH d'une clé vers des tiers (send, refuel, et les prélèvements par un venue plafonné, aujourd'hui le routeur spot) s'imputent sur des plafonds quotidiens par compte, sur une fenêtre fixe de 24 heures qui démarre à la première sortie imputée. Les perps, le coffre et la copie ne sont pas plafonnés, les jetons lancés non plus, et les appels signés par le portefeuille ne sont jamais imputés. Les valeurs par défaut du contrat sont 10 000 pUSD et 5 ETH par jour ; le déploiement du testnet les a désactivées (UNCAPPED, lisez defaultCaps()). Un compte fixe les siens avec setKeyCaps depuis son portefeuille : 0 signifie la valeur par défaut.

Pause

setPaused(true) arrête le pull et le move des venues, ainsi que le send et le refuel signés par une clé. Elle n'arrête jamais withdraw, withdrawTo, push (les positions se ferment donc toujours et les paiements arrivent), les dépôts, l'enregistrement et la révocation des clés, ni le send propre d'un portefeuille ou d'un contrat (un compte de copie paie son copieur par send). L'échange pUSD respecte la pause de la banque pour ses deux portes.

Les venues et le délai de 24 heures

Un venue peut débiter n'importe quel compte via l'expéditeur qu'il transmet : les venues sont donc la racine de confiance de la banque. En ajouter un passe par proposeVenue, puis activateVenue après VENUE_DELAY (24 heures) : un événement VenueProposed laisse à chaque compte une journée pour retirer d'abord. listVenueNow saute l'attente uniquement avant le tout premier crédit de la banque. removeVenue est immédiat, et un venue retiré peut toujours faire un push.

Fonctions et événements

Where every SENDIT account's money lives: pUSD, ETH (address(0)) and launched tokens, keyed by the account (the wallet), never by a key. Venues debit it with pull and credit it with push.

Wallet

FunctionWhat it does
deposit(uint256 pusdAmount, uint256 gasToKey, address key, bytes keyProof) payableThe one wallet transaction: pulls pUSD with no approve, credits msg.value - gasToKey as ETH, registers key when non-zero, and sends gasToKey to the account's key. Every argument may be zero.
depositToken(address token, uint256 amount)Deposits a launched token (or pUSD) already in the wallet. A launched token needs an approve to the bank first; pUSD does not.
setKey(address key, bytes keyProof)Registers a key. A proof under the current epochs ADDS it; a proof under keyEpoch + 1 REPLACES every key of the account.
setKeyCaps(uint128 pusdPerDay, uint128 ethPerDay)The account's own daily caps on its keys' sends, spot buys and launches. 0 means the default, UNCAPPED means none. Wallet only.
withdrawTo(address asset, uint256 amount, address to)Wallet only: pays another address, for a smart account with no receive(). Never paused, never capped.

Wallet or key

FunctionWhat it does
withdraw(address asset, uint256 amount)Pays accountOf(msg.sender), the wallet, whoever signs. Never paused, never capped.
send(address to, address asset, uint256 amount, bool toWallet)From the signer's account to `to`: credited in the bank (toWallet false; a live key named as `to` credits its account) or paid out as the asset. Key-signed pUSD and ETH count against the caps and stop while paused.
revokeKey()Ends every key of the account: keyEpoch moves on, so every device derives a new key.
rotateKey(address newKey, bytes keyProof)revokeKey, then registers newKey with a proof under the NEW account epoch, in one transaction.
refuel() returns (uint256 amount)A live key below REFUEL_BELOW tops itself up to REFUEL_TO from its account's ETH, once per REFUEL_EVERY. Stops while paused.

Venues

FunctionWhat it does
pull(address sender, address asset, uint256 amount) returns (address account)A venue debits accountOf(sender) and receives the asset. The venue passes its own msg.sender, so it never names whose money it takes. Stops while paused.
push(address account, address asset, uint256 amount) payableA venue credits `account` with what it hands over in this call. Never paused, and a removed venue can still push, so payouts in flight land.
move(address sender, address to, address asset, uint256 amount) returns (address account)A venue debits accountOf(sender) and credits `to` with no token moving (how a copy account is funded). Stops while paused.

Reading an account

FunctionWhat it does
accountOf(address sender) view returns (address)The account behind a sender: the owner while sender is one of its live keys, sender itself otherwise.
balanceOf(address account, address asset) view returns (uint256)One balance. asset address(0) is ETH.
keyOf(address account) view returns (address)The key registered last (address(0) after a revoke). Not proof that it is live: compare accountOf(keyOf(account)) with account.
ownerOfKey(address key) view returns (address)The account a key was registered for, live or not.
keyEpoch(address account) view returns (uint64)The account's key epoch. A revoke adds one.
keyAccountEpochOf(address key) view returns (uint64)The account epoch a key was registered under.
keyGlobalEpochOf(address key) view returns (uint64)The global epoch a key was registered under.
globalEpoch() view returns (uint64)The bank-wide epoch. invalidateAllKeys adds one.
keyDigest(address account, address key) view returns (bytes32)What the key signs (EIP-191) to consent to serving the account under the epochs in force now.
keyCapsOf(address account) view returns (uint256 pusdPerDay, uint256 ethPerDay, uint256 pusdSpent, uint256 ethSpent, uint64 windowEnds)The caps in force and what the keys spent in the current 24-hour window (zeros once it ended).
lastRefuelAt(address key) view returns (uint64)When a key last refuelled.
totalHeld(address asset) view returns (uint256)The sum of every balance of an asset. Never more than the bank holds.
isAsset(address asset) view returns (bool)ETH, pUSD, or a token launched by a launcher the operator added.

Reading the bank

FunctionWhat it does
pusd() view returns (address)The pUSD token.
operator() view returns (address)The operator: pause, venues, default caps, launchers, the key brake.
paused() view returns (bool)Whether venue pulls and moves and key-signed sends and refuels are stopped.
everFunded() view returns (bool)Set by the first credit; closes listVenueNow for ever.
defaultCaps() view returns (uint128 pusdPerDay, uint128 ethPerDay)The caps an account gets when it set none.
isVenue(address) view returns (bool)Whether an address may pull and move.
isCappedVenue(address) view returns (bool)Whether a key's pUSD and ETH spent through this venue count against the caps (the spot router).
wasVenue(address) view returns (bool)Ever listed: may still push after a removal.
venueActiveAt(address) view returns (uint64)When a proposed venue may be activated; 0 when none is pending.
proposedCapped(address) view returns (bool)The capped flag a pending venue will be listed with.
isLauncher(address) view returns (bool)Whether a launcher's tokens are accepted.
launchers(uint256) view returns (address)The added launchers, by index.
launcherCount() view returns (uint256)How many launchers were added.

Operator

FunctionWhat it does
proposeVenue(address venue, bool capped)Starts the VENUE_DELAY wait before a venue can be listed.
activateVenue(address venue)Lists a proposed venue once its delay has passed.
listVenueNow(address venue, bool capped)Lists a venue at once, only while the bank has never been credited (how the deploy lists its own venues).
removeVenue(address venue)Immediate. The venue can no longer pull or move, but can still push.
setPaused(bool paused_)The pause (see the pause rules).
setDefaultCaps(uint128 pusdPerDay, uint128 ethPerDay)The default caps. Both must be non-zero.
addLauncher(address launcher)Add-only: a launcher's tokens stay accepted for ever.
invalidateAllKeys()Moves globalEpoch on: every key on the bank stops resolving at once. Moves no balance; costs every account one setKey.
setOperator(address next)Hands the operator role on.

Constants

FunctionWhat it does
VERSION() view returns (uint256)1.
ETH() view returns (address)address(0), the ETH asset.
VENUE_DELAY() view returns (uint64)24 hours between proposeVenue and activateVenue.
CAP_WINDOW() view returns (uint64)24 hours, from the first charged outflow.
UNCAPPED() view returns (uint128)type(uint128).max: a cap of this value is no cap.
REFUEL_BELOW() view returns (uint256)0.002 ETH: a key may refuel below this.
REFUEL_TO() view returns (uint256)0.01 ETH: what a refuel tops the key up to.
REFUEL_EVERY() view returns (uint256)1 hour between two refuels of one key.

Events

EventWhat it does
Deposited(address indexed account, address indexed asset, uint256 amount)A deposit credited, pUSD, ETH or a token.
GasSent(address indexed account, address indexed key, uint256 amount, bool fromBalance)ETH sent to a key: the deposit's gas seed (fromBalance false) or a refuel (true).
Withdrawn(address indexed account, address indexed asset, uint256 amount, address to, address by)A withdrawal; `by` is the signer, a key or the wallet.
Sent(address indexed from, address indexed to, address indexed asset, uint256 amount, bool toWallet, address by)A send, in the bank or paid out.
Pulled(address indexed venue, address indexed account, address indexed asset, uint256 amount, address by)A venue took money from an account; `by` is who signed.
Pushed(address indexed venue, address indexed account, address indexed asset, uint256 amount)A venue paid an account.
Moved(address indexed venue, address indexed from, address indexed to, address asset, uint256 amount, address by)A venue moved money between two accounts.
KeySet(address indexed account, address indexed key, uint64 accountEpoch, uint64 globalEpoch)A key registered.
KeyRevoked(address indexed account, address indexed key, uint64 nextEpoch, address by)Every key of an account ended.
KeysInvalidated(uint64 globalEpoch)The operator ended every key on the bank.
CapsSet(address indexed account, uint256 pusdPerDay, uint256 ethPerDay)Caps changed; account address(0) is the default.
VenueProposed(address indexed venue, bool capped, uint64 activeAt)A venue proposed; activeAt is when it can be listed.
VenueSet(address indexed venue, bool allowed, bool capped)A venue listed or removed.
Paused(bool paused)The pause switched.
OperatorSet(address indexed previous, address indexed next)The operator changed.
LauncherAdded(address indexed launcher)A launcher's tokens accepted.