OutputType
OutputType =
object
Defined in: packages/synapse-core/src/pay/get-rail.ts:29
The rail information from the payments contract.
Properties
Section titled “Properties”commissionRateBps
Section titled “commissionRateBps”commissionRateBps:
bigint
Defined in: packages/synapse-core/src/pay/get-rail.ts:51
Commission rate in basis points (e.g., 500 = 5%)
endEpoch
Section titled “endEpoch”endEpoch:
bigint
Defined in: packages/synapse-core/src/pay/get-rail.ts:49
End epoch (0 for active rails, > 0 for terminated rails)
from:
Address
Defined in: packages/synapse-core/src/pay/get-rail.ts:33
The address of the payer
lockupFixed
Section titled “lockupFixed”lockupFixed:
bigint
Defined in: packages/synapse-core/src/pay/get-rail.ts:45
Fixed lockup amount (in token base units)
lockupPeriod
Section titled “lockupPeriod”lockupPeriod:
bigint
Defined in: packages/synapse-core/src/pay/get-rail.ts:43
Lockup period in epochs
operator
Section titled “operator”operator:
Address
Defined in: packages/synapse-core/src/pay/get-rail.ts:37
The address of the operator
paymentRate
Section titled “paymentRate”paymentRate:
bigint
Defined in: packages/synapse-core/src/pay/get-rail.ts:41
Payment rate per epoch (in token base units)
serviceFeeRecipient
Section titled “serviceFeeRecipient”serviceFeeRecipient:
Address
Defined in: packages/synapse-core/src/pay/get-rail.ts:53
Address that receives service fees
settledUpTo
Section titled “settledUpTo”settledUpTo:
bigint
Defined in: packages/synapse-core/src/pay/get-rail.ts:47
Epoch up to which the rail has been settled
to:
Address
Defined in: packages/synapse-core/src/pay/get-rail.ts:35
The address of the payee
token:
Address
Defined in: packages/synapse-core/src/pay/get-rail.ts:31
The address of the ERC20 token used for payments
validator
Section titled “validator”validator:
Address
Defined in: packages/synapse-core/src/pay/get-rail.ts:39
The address of the validator