Skip to content

@superfluid:flow

Current flow rate between a sender and a receiver, in wei per second (0 when no stream exists).

⚗️ Experimental — available at next.evmcrispr.com.

Returns: number

@superfluid:flow(token sender receiver)
NameTypeDescription
tokensupertokenSuperToken symbol or address
senderaddressStream sender
receiveraddressStream receiver
# Print the current flow rate between two accounts
print "Flow rate:" @superfluid:flow(xDAIx 0x4F2083f5fBede34C2714aFfb3105539775f7FE64 0x8790B75cF2BD36a2502A24e0E16AA1B23eBeBC71)

Read getFlowrate(token, sender, receiver) at assertion time, so a batch gates on the stream still running when it executes rather than when it was built. The SuperToken resolves at composition time; sender and receiver may be live values.