Module: typings
Index#
Enumerations#
Interfaces#
- AccruedInterestsObject
- AccruedInterestsRaw
- Amount
- AmountInternal
- BlockchainEvent
- ClosePathObject
- ClosePathRaw
- CloseTxObject
- DecimalsMap
- DecimalsObject
- DecimalsOptions
- DelegationFeesInternal
- DelegationFeesObject
- DelegationFeesRaw
- DeployIdentityResponse
- ECSignature
- EarnedMediationFeesListObject
- EarnedMediationFeesListRaw
- EthersWalletData
- EventFilterOptions
- ExchangeCancelEvent
- ExchangeCancelEventRaw
- ExchangeEvent
- ExchangeFillEvent
- ExchangeFillEventRaw
- ExchangeOptions
- ExchangeTx
- FeesRequest
- FeesResponse
- IdentityWalletData
- MediationFeeObject
- MediationFeeRaw
- MetaTransaction
- MetaTransactionFees
- MetaTransactionStatus
- Network
- NetworkDetails
- NetworkDetailsRaw
- NetworkEvent
- NetworkTransferEvent
- NetworkTransferEventRaw
- NetworkTrustlineBalanceUpdate
- NetworkTrustlineBalanceUpdateRaw
- NetworkTrustlineUpdateEvent
- NetworkTrustlineUpdateEventRaw
- Order
- OrderOptions
- OrderRaw
- Orderbook
- OrderbookOptions
- OrderbookRaw
- OrdersQuery
- PaidDelegationFeesRaw
- PathObject
- PathRaw
- PaymentMessage
- PaymentOptions
- PaymentRequestDeclineMessage
- PaymentRequestMessage
- PaymentTxObject
- ProviderUrl
- RawTxObject
- Signature
- SignedOrder
- SignedOrderRaw
- SigningKey
- TLEvent
- TLNetworkConfig
- TLWalletData
- TLWalletDataMeta
- TokenAmountEvent
- TokenAmountEventRaw
- TokenEvent
- TransactionStatusObject
- TransferDetails
- TransferDetailsRaw
- TransferIdentifier
- TrustlineAccruedInterestsObject
- TrustlineAccruedInterestsRaw
- TrustlineObject
- TrustlineRaw
- TrustlineUpdateOptions
- TxFeesAmounts
- TxFeesRaw
- TxInfos
- TxInfosRaw
- TxObject
- TxObjectInternal
- TxObjectRaw
- TxOptions
- TxOptionsInternal
- UserOverview
- UserOverviewRaw
- UsernameMessage
- Web3Log
- Web3TxReceipt
Type aliases#
- AmountEventRaw
- AnyEvent
- AnyEventRaw
- AnyExchangeEvent
- AnyExchangeEventRaw
- AnyNetworkEvent
- AnyNetworkEventRaw
- AnyNetworkTrustlineEvent
- AnyNetworkTrustlineEventRaw
- AnyOrder
- AnyTokenEvent
- AnyTokenEventRaw
- Direction
- ExchangeTxOptions
- NetworkTrustlineCancelEvent
- NetworkTrustlineCancelEventRaw
- ReconnectingWSOptions
- TLOptions
- UserAccruedInterestsObject
- UserAccruedInterestsRaw
- WalletType
- WalletTypeEthers
- WalletTypeIdentity
Functions#
Type aliases#
AmountEventRaw#
Ƭ AmountEventRaw: NetworkTransferEventRaw | TokenAmountEventRaw
Defined in src/typings.ts:277
AnyEvent#
Ƭ AnyEvent: AnyNetworkEvent | AnyTokenEvent | AnyExchangeEvent
Defined in src/typings.ts:272
AnyEventRaw#
Ƭ AnyEventRaw: AnyNetworkEventRaw | AnyTokenEventRaw | AnyExchangeEventRaw
Defined in src/typings.ts:273
AnyExchangeEvent#
Ƭ AnyExchangeEvent: ExchangeFillEvent | ExchangeCancelEvent
Defined in src/typings.ts:269
AnyExchangeEventRaw#
Ƭ AnyExchangeEventRaw: ExchangeFillEventRaw | ExchangeCancelEventRaw
Defined in src/typings.ts:270
AnyNetworkEvent#
Ƭ AnyNetworkEvent: NetworkTransferEvent | NetworkTrustlineUpdateEvent | NetworkTrustlineCancelEvent
Defined in src/typings.ts:174
AnyNetworkEventRaw#
Ƭ AnyNetworkEventRaw: NetworkTransferEventRaw | NetworkTrustlineUpdateEventRaw | NetworkTrustlineCancelEventRaw
Defined in src/typings.ts:178
AnyNetworkTrustlineEvent#
Ƭ AnyNetworkTrustlineEvent: NetworkTrustlineUpdateEvent | NetworkTrustlineCancelEvent | NetworkTrustlineBalanceUpdate
Defined in src/typings.ts:188
AnyNetworkTrustlineEventRaw#
Ƭ AnyNetworkTrustlineEventRaw: NetworkTrustlineUpdateEventRaw | NetworkTrustlineCancelEventRaw | NetworkTrustlineBalanceUpdateRaw
Defined in src/typings.ts:183
AnyOrder#
Ƭ AnyOrder: Order | OrderRaw | SignedOrder | SignedOrderRaw
Defined in src/typings.ts:819
AnyTokenEvent#
Ƭ AnyTokenEvent: TokenAmountEvent
Defined in src/typings.ts:205
AnyTokenEventRaw#
Ƭ AnyTokenEventRaw: TokenAmountEventRaw
Defined in src/typings.ts:206
Direction#
Ƭ Direction: "sent" | "received"
Defined in src/typings.ts:240
ExchangeTxOptions#
Ƭ ExchangeTxOptions: TxOptions & ExchangeOptions
Defined in src/typings.ts:845
NetworkTrustlineCancelEvent#
Ƭ NetworkTrustlineCancelEvent: NetworkEvent
Defined in src/typings.ts:165
NetworkTrustlineCancelEventRaw#
Ƭ NetworkTrustlineCancelEventRaw: NetworkEvent
Defined in src/typings.ts:164
ReconnectingWSOptions#
Ƭ ReconnectingWSOptions: ReconnectingOptions & { reconnectOnError?: boolean }
Defined in src/typings.ts:875
TLOptions#
Ƭ TLOptions: TxOptions & DecimalsOptions
Defined in src/typings.ts:78
UserAccruedInterestsObject#
Ƭ UserAccruedInterestsObject: TrustlineAccruedInterestsObject[]
Defined in src/typings.ts:690
UserAccruedInterestsRaw#
Ƭ UserAccruedInterestsRaw: TrustlineAccruedInterestsRaw[]
Defined in src/typings.ts:689
WalletType#
Ƭ WalletType: WalletTypeEthers | WalletTypeIdentity
Defined in src/typings.ts:564
WalletTypeEthers#
Ƭ WalletTypeEthers: "ethers"
Defined in src/typings.ts:562
WalletTypeIdentity#
Ƭ WalletTypeIdentity: "identity"
Defined in src/typings.ts:563
Functions#
isFeePayerValue#
â–¸ isFeePayerValue(feePayer: string): boolean
Defined in src/typings.ts:465
Parameters:#
| Name | Type |
|---|---|
feePayer | string |
Returns: boolean