Module: typings
Index#
Enumerations#
Interfaces#
- AccruedInterestsObject
- AccruedInterestsRaw
- Amount
- AmountInternal
- BlockchainEvent
- ClosePathObject
- ClosePathRaw
- CloseTxObject
- DecimalsMap
- DecimalsObject
- DecimalsOptions
- DelegationFeesInternal
- DelegationFeesObject
- DelegationFeesRaw
- DeployIdentityResponse
- ECSignature
- EarnedMediationFeesListObject
- EarnedMediationFeesListRaw
- EstimationResponse
- 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
- NetworkTrustlineUpdateRequestEvent
- NetworkTrustlineUpdateRequestEventRaw
- Order
- OrderOptions
- OrderRaw
- Orderbook
- OrderbookOptions
- OrderbookRaw
- OrdersQuery
- PaidDelegationFeesRaw
- PathObject
- PathRaw
- PaymentMessage
- PaymentOptions
- PaymentRequestDeclineMessage
- PaymentRequestMessage
- PaymentTxObject
- ProviderUrl
- RawTxObject
- SafeMetaTransaction
- SafeMultisigTxResponse
- SafeSignature
- SafeTransactionFees
- SafeWalletData
- Signature
- SignedOrder
- SignedOrderRaw
- SigningKey
- TLEvent
- TLNetworkConfig
- TLWalletData
- TLWalletDataMeta
- TokenAmountEvent
- TokenAmountEventRaw
- TokenEvent
- TransactionStatusObject
- TransferDetails
- TransferDetailsRaw
- TransferIdentifier
- TransferredSumObject
- TransferredSumRaw
- 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
- WalletTypeSafe
Functions#
Type aliases#
AmountEventRaw#
Ƭ AmountEventRaw: NetworkTransferEventRaw | TokenAmountEventRaw
Defined in src/typings.ts:307
AnyEvent#
Ƭ AnyEvent: AnyNetworkEvent | AnyTokenEvent | AnyExchangeEvent
Defined in src/typings.ts:302
AnyEventRaw#
Ƭ AnyEventRaw: AnyNetworkEventRaw | AnyTokenEventRaw | AnyExchangeEventRaw
Defined in src/typings.ts:303
AnyExchangeEvent#
Ƭ AnyExchangeEvent: ExchangeFillEvent | ExchangeCancelEvent
Defined in src/typings.ts:299
AnyExchangeEventRaw#
Ƭ AnyExchangeEventRaw: ExchangeFillEventRaw | ExchangeCancelEventRaw
Defined in src/typings.ts:300
AnyNetworkEvent#
Ƭ AnyNetworkEvent: NetworkTransferEvent | NetworkTrustlineUpdateEvent | NetworkTrustlineCancelEvent | NetworkTrustlineUpdateRequestEvent
Defined in src/typings.ts:200
AnyNetworkEventRaw#
Ƭ AnyNetworkEventRaw: NetworkTransferEventRaw | NetworkTrustlineUpdateEventRaw | NetworkTrustlineCancelEventRaw | NetworkTrustlineUpdateRequestEventRaw
Defined in src/typings.ts:205
AnyNetworkTrustlineEvent#
Ƭ AnyNetworkTrustlineEvent: NetworkTrustlineUpdateEvent | NetworkTrustlineCancelEvent | NetworkTrustlineBalanceUpdate | NetworkTrustlineUpdateRequestEvent
Defined in src/typings.ts:217
AnyNetworkTrustlineEventRaw#
Ƭ AnyNetworkTrustlineEventRaw: NetworkTrustlineUpdateEventRaw | NetworkTrustlineCancelEventRaw | NetworkTrustlineBalanceUpdateRaw | NetworkTrustlineUpdateRequestEventRaw
Defined in src/typings.ts:211
AnyOrder#
Ƭ AnyOrder: Order | OrderRaw | SignedOrder | SignedOrderRaw
Defined in src/typings.ts:874
AnyTokenEvent#
Ƭ AnyTokenEvent: TokenAmountEvent
Defined in src/typings.ts:235
AnyTokenEventRaw#
Ƭ AnyTokenEventRaw: TokenAmountEventRaw
Defined in src/typings.ts:236
Direction#
Ƭ Direction: "sent" | "received"
Defined in src/typings.ts:270
ExchangeTxOptions#
Ƭ ExchangeTxOptions: TxOptions & ExchangeOptions
Defined in src/typings.ts:900
NetworkTrustlineCancelEvent#
Ƭ NetworkTrustlineCancelEvent: NetworkEvent
Defined in src/typings.ts:190
NetworkTrustlineCancelEventRaw#
Ƭ NetworkTrustlineCancelEventRaw: NetworkEvent
Defined in src/typings.ts:189
ReconnectingWSOptions#
Ƭ ReconnectingWSOptions: ReconnectingOptions & { reconnectOnError?: boolean }
Defined in src/typings.ts:930
TLOptions#
Ƭ TLOptions: TxOptions & DecimalsOptions
Defined in src/typings.ts:90
UserAccruedInterestsObject#
Ƭ UserAccruedInterestsObject: TrustlineAccruedInterestsObject[]
Defined in src/typings.ts:728
UserAccruedInterestsRaw#
Ƭ UserAccruedInterestsRaw: TrustlineAccruedInterestsRaw[]
Defined in src/typings.ts:727
WalletType#
Ƭ WalletType: WalletTypeEthers | WalletTypeIdentity | WalletTypeSafe
Defined in src/typings.ts:597
WalletTypeEthers#
Ƭ WalletTypeEthers: "ethers"
Defined in src/typings.ts:594
WalletTypeIdentity#
Ƭ WalletTypeIdentity: "identity"
Defined in src/typings.ts:595
WalletTypeSafe#
Ƭ WalletTypeSafe: "safe"
Defined in src/typings.ts:596
Functions#
isFeePayerValue#
â–¸ isFeePayerValue(feePayer: string): boolean
Defined in src/typings.ts:497
Parameters:#
| Name | Type |
|---|---|
feePayer | string |
Returns: boolean