GET /keeperStakeChannel
stakeAddress
: The address of the KSA that owns the channel.channelNonce
: The channel nonce for the channel being fetched./keeperStakeChannel?stakeAddress=0x333D1eCc55E5e27c29ad39ba4e435Bb78f6A7141&channelNonce=0
refundAccrued
indicates the outstanding refunds accrued in the payment channel from lost auctions and failure to fill orders.isOpen
is true
if the Coordinator is still accepting bid commitments from the channel and false
otherwise.fullySettled
is set to true
once the KSA has withdrawn their remaining Rook for the payment channel from the staking contract and false
otherwise.latestStakeAddressSignedCommitment
may not necessarily be the latest commitment. When Keepers request a refund, the Coordinator generates a new commitment with the refundAccrued
subtracted from the prior commitment's stakeSpent
. This commitment will only have the Coordinator's signature on it. If the Keeper wants to withdraw with this commitment, they still have everything they need.GET /info
GET /refundRequestMessageHash
stakeAddress
: The stake address withdrawing their staked Rook.stakeNonce
: The latest stake nonce of the channel being withdrawn from.channelNonce
: The channel nonce of the channel being withdrawn from.refundRequestMessageHash?stakeAddress=0x333D1eCc55E5e27c29ad39ba4e435Bb78f6A7141&channelNonce=0&stakeNonce=5
GET /stakeAddressIdentityRegistrationMessageHash
stakeAddress
: The stake address being registered.identityAddress
: The identity address the stake address is being registered to.expirationTime
: Unix timestamp in seconds. The signature on the hash output of this endpoint is only valid till the supplied timestamp.POST /registerStakeAddressIdentity
stakeAddress
: The stake address being registered.identityAddress
: The identity address the stake address is being registered to.expirationTime
: Unix timestamp. The signature on the hash output of this endpoint is only valid till the supplied timestamp.stakeAddressSignature
: Only required if the stakeAddress
is already registered to an identityAddress
.identityAddressSignature
: The Ethereum signature of the identity address on the hash output from /stakeAddressIdentityRegistrationMessageHash
GET /takerAddressIdentityRegistrationMessageHash
takerAddress
: The taker address being registered.identityAddress
: The identity address the taker address is being registered to.expirationTime
: Unix timestamp. The signature on the hash output of this endpoint is only valid till the supplied timestamp.POST /registerTakerAddressIdentity
takerAddress
: The taker address being registered.identityAddress
: The identity address the stake address is being registered to.expirationTime
: Unix timestamp. The signature on the hash output of this endpoint is only valid till the supplied timestamp.takerAddressSignature
: Only required if the takerAddress
is already registered to an identityAddress
.identityAddressSignature
: The Ethereum signature of the identity address on the hash output from /takerAddressIdentityRegistrationMessageHash
GET /addressIdentityUnregistrationMessageHash
identityAddress
: The identity address the KTA or KSA is being unregistered from.expirationTime
: Unix timestamp. The signature on the hash output of this endpoint is only valid till the supplied timestamp.POST /unregisterStakeAddressIdentity
stakeAddress
: The stake address being unregistered.identityAddress
: The identity address the stake address is being unregistered from.expirationTime
: Unix timestamp. The signature on the hash output of this endpoint is only valid till the supplied timestamp.identityAddressSignature
: The Ethereum signature of the identity address on the hash output from /addressIdentityUnregistrationMessageHash
POST /unregisterTakerAddressIdentity
takerAddress
: The taker address being unregistered.identityAddress
: The identity address the taker address is being unregistered from.expirationTime
: Unix timestamp. The signature on the hash output of this endpoint is only valid till the supplied timestamp.identityAddressSignature
: The Ethereum signature of the identity address on the hash output from /addressIdentityUnregistrationMessageHash
GET /instantWithdrawalRequestMessageHash
stakeAddress
: The stake address withdrawing their staked Rook.channelNonce
: The channel nonce of the channel being withdrawn from./keeperStakeChannel
endpoint.POST /initiateInstantWithdrawal
stakeAddress
: The stake address being unregistered.channelNonce
: The channel nonce of the channel being withdrawn fromstakeAddressSignature
: The Ethereum signature of the stake address on the hash output from /instantWithdrawalRequestMessageHash
type
field.auctionId
is the hiding book order hash._withdrawalTimelock
will be non-zero if the payment channel is currently in the timelocked withdrawal process and will indicate the timestamp of the timelock's expiration.msg.sender
if there is one, and creating a new payment channel otherwise. Not that additional rook cannot be staked for a payment channel that is currently in a withdrawal timelock.