Options
All
  • Public
  • Public/Protected
  • All
Menu

roller-rpc-client

Index

References

Classes

Interfaces

Type aliases

References

default

Renames and exports RollerRPCAPI

Type aliases

Adopt

Adopt: (sig: Signature, force: Force, from: From, address: EthAddress, data: SponsorshipParams) => Promise<Hash>

Type declaration

Allowance

Allowance: number

AnyOfShipEthAddressSignatureForceFromEthAddressTransferPointParamsSignatureForceFromEthAddressSpawnParamsSignatureForceFromEthAddressConfigureKeysParamsSignatureForceFromEthAddressSponsorshipParamsSignatureForceFromEthAddressSponsorshipParamsSignatureForceFromEthAddressSponsorshipParamsSignatureForceFromEthAddressSponsorshipParamsSignatureForceFromEthAddressSponsorshipParamsSignatureForceFromEthAddressAddressParamsSignatureForceFromEthAddressAddressParamsSignatureForceFromEthAddressAddressParamsShipEthAddressHashShipShipShipHash32EthAddressFromSignatureForceHash32TransactionTypeShipSignatureForceFromTransactionTypeL2DataNonceFromTransactionTypeL2DataNonceFromTransactionTypeL2DataNonceFromTransactionTypeL2DataEthAddressEthAddressEthAddressEthAddressEthAddressShipShipShipL2PointShipsHashHashHashHashHashHashHashHashHashHashHashListOfPendingTxsListOfPendingTxsListOfPendingTxsPendingTransactionSpawnedPointsUnspawnedPointsSpawnsLeftNextBatchTimestampTransactionStatusTransactionHistoryNonceSuccessConfigListOfDNSHashHashHashSerializedTxShipsShipsShipsShipsShipsNaiveStateNaiveStateSponsoredPointsRemainingQuotaAllowance

AnyOfShipEthAddressSignatureForceFromEthAddressTransferPointParamsSignatureForceFromEthAddressSpawnParamsSignatureForceFromEthAddressConfigureKeysParamsSignatureForceFromEthAddressSponsorshipParamsSignatureForceFromEthAddressSponsorshipParamsSignatureForceFromEthAddressSponsorshipParamsSignatureForceFromEthAddressSponsorshipParamsSignatureForceFromEthAddressSponsorshipParamsSignatureForceFromEthAddressAddressParamsSignatureForceFromEthAddressAddressParamsSignatureForceFromEthAddressAddressParamsShipEthAddressHashShipShipShipHash32EthAddressFromSignatureForceHash32TransactionTypeShipSignatureForceFromTransactionTypeL2DataNonceFromTransactionTypeL2DataNonceFromTransactionTypeL2DataNonceFromTransactionTypeL2DataEthAddressEthAddressEthAddressEthAddressEthAddressShipShipShipL2PointShipsHashHashHashHashHashHashHashHashHashHashHashListOfPendingTxsListOfPendingTxsListOfPendingTxsPendingTransactionSpawnedPointsUnspawnedPointsSpawnsLeftNextBatchTimestampTransactionStatusTransactionHistoryNonceSuccessConfigListOfDNSHashHashHashSerializedTxShipsShipsShipsShipsShipsNaiveStateNaiveStateSponsoredPointsRemainingQuotaAllowance: Ship | EthAddress | Signature | Force | From | TransferPointParams | SpawnParams | ConfigureKeysParams | SponsorshipParams | AddressParams | Hash | Hash32 | TransactionType | L2Data | Nonce | L2Point | Ships | ListOfPendingTxs | PendingTransaction | SpawnedPoints | UnspawnedPoints | SpawnsLeft | NextBatch | Timestamp | TransactionStatus | TransactionHistory | Success | Config | ListOfDNS | SerializedTx | NaiveState | SponsoredPoints | RemainingQuota | Allowance

Generated! Represents an alias to any of the provided schemas

Auth

Auth: string

^0x[0-9a-f]{64}$

AzimuthRefreshRate

AzimuthRefreshRate: number

How often the Azimuth agent checks for L1 updates

Breach

Breach: boolean

CancelEscape

CancelEscape: (sig: Signature, force: Force, from: From, address: EthAddress, data: SponsorshipParams) => Promise<Hash>

Type declaration

CancelTransaction

CancelTransaction: (sig: Signature, force: Force, hash: Hash32, type: TransactionType, ship: Ship) => Promise<Success>

Type declaration

ChainId

ChainId: number

For more info: https://chainid.network/

ConfigureKeys

ConfigureKeys: (sig: Signature, force: Force, from: From, address: EthAddress, data: ConfigureKeysParams) => Promise<Hash>

Type declaration

Crypto

Crypto: string

^0x[0-9a-f]{64}$

CryptoSuite

CryptoSuite: string

DNS

DNS: string

Detach

Detach: (sig: Signature, force: Force, from: From, address: EthAddress, data: SponsorshipParams) => Promise<Hash>

Type declaration

Dominion

Dominion: string

One of: l1, l2, spawn

Escape

Escape: (sig: Signature, force: Force, from: From, address: EthAddress, data: SponsorshipParams) => Promise<Hash>

Type declaration

EthAddress

EthAddress: string

hex encoded address

Force

Force: boolean

If true, forces the Roller to include this transaction, even if it fails to validate.

Frequency

Frequency: number

How often the Roller sends out a new batch

GetAllPending

GetAllPending: () => Promise<ListOfPendingTxs>

Type declaration

GetAllowance

GetAllowance: (ship: Ship) => Promise<Allowance>

Type declaration

GetDns

GetDns: () => Promise<ListOfDNS>

Type declaration

GetHistory

GetHistory: (address: EthAddress) => Promise<TransactionHistory>

Type declaration

GetManagerFor

GetManagerFor: (address: EthAddress) => Promise<Ships>

Type declaration

GetNaiveState

GetNaiveState: () => Promise<NaiveState>

Type declaration

GetNonce

GetNonce: (from: From) => Promise<Nonce>

Type declaration

GetOwnedPoints

GetOwnedPoints: (address: EthAddress) => Promise<Ships>

Type declaration

GetPendingByAddress

GetPendingByAddress: (address: EthAddress) => Promise<ListOfPendingTxs>

Type declaration

GetPendingByShip

GetPendingByShip: (ship: Ship) => Promise<ListOfPendingTxs>

Type declaration

GetPendingTx

GetPendingTx: (hash: Hash) => Promise<PendingTransaction>

Type declaration

GetPoint

GetPoint: (ship: Ship) => Promise<L2Point>

Type declaration

GetPredictedState

GetPredictedState: () => Promise<NaiveState>

Type declaration

GetRemainingQuota

GetRemainingQuota: (ship: Ship) => Promise<RemainingQuota>

Type declaration

GetRollerConfig

GetRollerConfig: () => Promise<Config>

Type declaration

GetShips

GetShips: (address: EthAddress) => Promise<Ships>

Type declaration

GetSpawned

GetSpawned: (ship: Ship) => Promise<SpawnedPoints>

Type declaration

GetSpawningFor

GetSpawningFor: (address: EthAddress) => Promise<Ships>

Type declaration

GetSponsoredPoints

GetSponsoredPoints: (ship: Ship) => Promise<SponsoredPoints>

Type declaration

GetTransactionStatus

GetTransactionStatus: (hash: Hash32) => Promise<TransactionStatus>

Type declaration

GetTransferringFor

GetTransferringFor: (address: EthAddress) => Promise<Ships>

Type declaration

GetUnsignedTx

GetUnsignedTx: (nonce: Nonce, from: From, tx: TransactionType, data: L2Data) => Promise<Hash>

Type declaration

GetUnspawned

GetUnspawned: (ship: Ship) => Promise<UnspawnedPoints>

Type declaration

GetVotingFor

GetVotingFor: (address: EthAddress) => Promise<Ships>

Type declaration

Has

Has: boolean

Hash

Hash: string

Keccak-256 (not the standardized SHA3-256) of the given data.

Hash32

Hash32: string

HashRawTransaction

HashRawTransaction: (sig: Signature, force: Force, from: From, tx: TransactionType, data: L2Data) => Promise<Hash>

Type declaration

HashTransaction

HashTransaction: (nonce: Nonce, from: From, tx: TransactionType, data: L2Data) => Promise<Hash>

Type declaration

L2Data

L2Data: TransferPointParams | SpawnParams | ConfigureKeysParams | SponsorshipParams | AddressParams

Data requiered for a L2 Transaction

Life

Life: string

ListOfDNS

ListOfDNS: DNS[]

A list of DNS

ListOfPendingTxs

ListOfPendingTxs: PendingTransaction[]

ManagementProxy

ManagementProxy: string

NaivePoints

NaivePoints: NaivePoint[]

NextBatch

NextBatch: number

Timestamp of when the next roll of L2 txs will be sent out

Nonce

Nonce: number

Number

Number: number

Number representing a ship

OperatorAddress

OperatorAddress: string

OperatorAddresses

OperatorAddresses: EthAddress[]

Operators

Operators: Operator[]

OwnershipAddress

OwnershipAddress: string

Patp

Patp: string

patp-encoded string with leading ~

default

~wanzod

PrepareForSigning

PrepareForSigning: (nonce: Nonce, from: From, tx: TransactionType, data: L2Data) => Promise<SerializedTx>

Type declaration

Proxy

Proxy: OwnershipAddress | SpawnProxy | VotingProxy | ManagementProxy | TransferProxy

Reject

Reject: (sig: Signature, force: Force, from: From, address: EthAddress, data: SponsorshipParams) => Promise<Hash>

Type declaration

RemainingQuota

RemainingQuota: number

Reset

Reset: boolean

Residents

Residents: Ship[]

Rift

Rift: string

RollerResendTime

RollerResendTime: number

How ofthen the Roller retries to send a batch

RollerUpdateRate

RollerUpdateRate: number

How ofthen the Roller updates its state

SerializedTx

SerializedTx: string

SetManagementProxy

SetManagementProxy: (sig: Signature, force: Force, from: From, address: EthAddress, data: AddressParams) => Promise<Hash>

Type declaration

SetSpawnProxy

SetSpawnProxy: (sig: Signature, force: Force, from: From, address: EthAddress, data: AddressParams) => Promise<Hash>

Type declaration

SetTransferProxy

SetTransferProxy: (sig: Signature, force: Force, from: From, address: EthAddress, data: AddressParams) => Promise<Hash>

Type declaration

Ship

Ship: Patp | Number

An Azimuth Ship

Ships

Ships: Ship[]

Signature

Signature: string

Hex-encoded signature

Spawn

Spawn: (sig: Signature, force: Force, from: From, address: EthAddress, data: SpawnParams) => Promise<Hash>

Type declaration

SpawnProxy

SpawnProxy: string

SpawnedPoints

SpawnedPoints: Number[]

SpawnsLeft

SpawnsLeft: number

SpawnsRemaining

SpawnsRemaining: (ship: Ship) => Promise<SpawnsLeft>

Type declaration

SponsorRequests

SponsorRequests: Ship[]

Success

Success: string

Always returns "ok"

Timestamp

Timestamp: number

TransactionHistory

TransactionHistory: RollerTransaction[]

TransactionStatus

TransactionStatus: string

One of: confirmed, pending, sending, confirmed, failed, unknown

TransactionType

TransactionType: string

One of transfer-point, spawn, configure-keys, escape, cancel-escape, adopt, reject, detach, set-management-proxy, set-spawn-proxy, set-transfer-proxy

TransferPoint

TransferPoint: (sig: Signature, force: Force, from: From, address: EthAddress, data: TransferPointParams) => Promise<Hash>

Type declaration

TransferProxy

TransferProxy: string

UnspawnedPoints

UnspawnedPoints: Number[]

VotingProxy

VotingProxy: string

WhenNextBatch

WhenNextBatch: () => Promise<NextBatch>

Type declaration

WhenNextSlice

WhenNextSlice: () => Promise<Timestamp>

Type declaration