Documentation ¶
Overview ¶
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2022-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
Index ¶
- Constants
- type Account
- func (obj Account) GetApiTokens(requester *requester.Requester, first *int64, after *string) (*AccountToApiTokensConnection, error)
- func (obj Account) GetBlockchainBalance(requester *requester.Requester, bitcoinNetworks *[]BitcoinNetwork, ...) (*BlockchainBalance, error)
- func (obj Account) GetChannels(requester *requester.Requester, bitcoinNetwork BitcoinNetwork, ...) (*AccountToChannelsConnection, error)
- func (obj Account) GetConductivity(requester *requester.Requester, bitcoinNetworks *[]BitcoinNetwork, ...) (*int64, error)
- func (obj Account) GetCreatedAt() time.Time
- func (obj Account) GetId() string
- func (obj Account) GetLocalBalance(requester *requester.Requester, bitcoinNetworks *[]BitcoinNetwork, ...) (*CurrencyAmount, error)
- func (obj Account) GetNodes(requester *requester.Requester, first *int64, ...) (*AccountToNodesConnection, error)
- func (obj Account) GetPaymentRequests(requester *requester.Requester, first *int64, after *string, ...) (*AccountToPaymentRequestsConnection, error)
- func (obj Account) GetRemoteBalance(requester *requester.Requester, bitcoinNetworks *[]BitcoinNetwork, ...) (*CurrencyAmount, error)
- func (obj Account) GetTransactions(requester *requester.Requester, first *int64, after *string, ...) (*AccountToTransactionsConnection, error)
- func (obj Account) GetTypename() string
- func (obj Account) GetUpdatedAt() time.Time
- func (obj Account) GetUptimePercentage(requester *requester.Requester, afterDate *time.Time, beforeDate *time.Time, ...) (*int64, error)
- func (obj Account) GetWallets(requester *requester.Requester, first *int64, after *string, ...) (*AccountToWalletsConnection, error)
- func (obj Account) GetWithdrawalRequests(requester *requester.Requester, first *int64, after *string, ...) (*AccountToWithdrawalRequestsConnection, error)
- type AccountToApiTokensConnection
- type AccountToChannelsConnection
- type AccountToNodesConnection
- type AccountToNodesConnectionJSON
- type AccountToPaymentRequestsConnection
- type AccountToPaymentRequestsConnectionJSON
- type AccountToTransactionsConnection
- type AccountToTransactionsConnectionJSON
- type AccountToWalletsConnection
- type AccountToWithdrawalRequestsConnection
- type ApiToken
- type Balances
- type BitcoinNetwork
- type BlockchainBalance
- type CancelInvoiceInput
- type CancelInvoiceOutput
- type Channel
- func (obj Channel) GetCreatedAt() time.Time
- func (obj Channel) GetId() string
- func (obj Channel) GetTransactions(requester *requester.Requester, types *[]TransactionType, afterDate *time.Time, ...) (*ChannelToTransactionsConnection, error)
- func (obj Channel) GetTypename() string
- func (obj Channel) GetUpdatedAt() time.Time
- func (obj Channel) GetUptimePercentage(requester *requester.Requester, afterDate *time.Time, beforeDate *time.Time) (*int64, error)
- type ChannelClosingTransaction
- func (obj ChannelClosingTransaction) GetAmount() CurrencyAmount
- func (obj ChannelClosingTransaction) GetBlockHash() *string
- func (obj ChannelClosingTransaction) GetBlockHeight() int64
- func (obj ChannelClosingTransaction) GetCreatedAt() time.Time
- func (obj ChannelClosingTransaction) GetDestinationAddresses() []string
- func (obj ChannelClosingTransaction) GetFees() *CurrencyAmount
- func (obj ChannelClosingTransaction) GetId() string
- func (obj ChannelClosingTransaction) GetNumConfirmations() *int64
- func (obj ChannelClosingTransaction) GetResolvedAt() *time.Time
- func (obj ChannelClosingTransaction) GetStatus() TransactionStatus
- func (obj ChannelClosingTransaction) GetTransactionHash() *string
- func (obj ChannelClosingTransaction) GetTypename() string
- func (obj ChannelClosingTransaction) GetUpdatedAt() time.Time
- type ChannelFees
- type ChannelOpeningTransaction
- func (obj ChannelOpeningTransaction) GetAmount() CurrencyAmount
- func (obj ChannelOpeningTransaction) GetBlockHash() *string
- func (obj ChannelOpeningTransaction) GetBlockHeight() int64
- func (obj ChannelOpeningTransaction) GetCreatedAt() time.Time
- func (obj ChannelOpeningTransaction) GetDestinationAddresses() []string
- func (obj ChannelOpeningTransaction) GetFees() *CurrencyAmount
- func (obj ChannelOpeningTransaction) GetId() string
- func (obj ChannelOpeningTransaction) GetNumConfirmations() *int64
- func (obj ChannelOpeningTransaction) GetResolvedAt() *time.Time
- func (obj ChannelOpeningTransaction) GetStatus() TransactionStatus
- func (obj ChannelOpeningTransaction) GetTransactionHash() *string
- func (obj ChannelOpeningTransaction) GetTypename() string
- func (obj ChannelOpeningTransaction) GetUpdatedAt() time.Time
- type ChannelSnapshot
- type ChannelStatus
- type ChannelToTransactionsConnection
- type ClaimUmaInvitationInput
- type ClaimUmaInvitationOutput
- type ClaimUmaInvitationWithIncentivesInput
- type ClaimUmaInvitationWithIncentivesOutput
- type ComplianceProvider
- type Connection
- type CreateApiTokenInput
- type CreateApiTokenOutput
- type CreateInvitationWithIncentivesInput
- type CreateInvitationWithIncentivesOutput
- type CreateInvoiceInput
- type CreateInvoiceOutput
- type CreateLnurlInvoiceInput
- type CreateNodeWalletAddressInput
- type CreateNodeWalletAddressOutput
- type CreateTestModeInvoiceInput
- type CreateTestModeInvoiceOutput
- type CreateTestModePaymentInput
- type CreateTestModePaymentoutput
- type CreateUmaInvitationInput
- type CreateUmaInvitationOutput
- type CreateUmaInvoiceInput
- type CurrencyAmount
- type CurrencyUnit
- type DailyLiquidityForecast
- type DeclineToSignMessagesInput
- type DeclineToSignMessagesOutput
- type DeleteApiTokenInput
- type DeleteApiTokenOutput
- type Deposit
- func (obj Deposit) GetAmount() CurrencyAmount
- func (obj Deposit) GetBlockHash() *string
- func (obj Deposit) GetBlockHeight() int64
- func (obj Deposit) GetCreatedAt() time.Time
- func (obj Deposit) GetDestinationAddresses() []string
- func (obj Deposit) GetFees() *CurrencyAmount
- func (obj Deposit) GetId() string
- func (obj Deposit) GetNumConfirmations() *int64
- func (obj Deposit) GetResolvedAt() *time.Time
- func (obj Deposit) GetStatus() TransactionStatus
- func (obj Deposit) GetTransactionHash() *string
- func (obj Deposit) GetTypename() string
- func (obj Deposit) GetUpdatedAt() time.Time
- type Entity
- type FeeEstimate
- type FundNodeInput
- type FundNodeOutput
- type GraphNode
- func (obj GraphNode) GetAddresses(requester *requester.Requester, first *int64, types *[]NodeAddressType) (*NodeToAddressesConnection, error)
- func (obj GraphNode) GetAlias() *string
- func (obj GraphNode) GetBitcoinNetwork() BitcoinNetwork
- func (obj GraphNode) GetColor() *string
- func (obj GraphNode) GetConductivity() *int64
- func (obj GraphNode) GetCreatedAt() time.Time
- func (obj GraphNode) GetDisplayName() string
- func (obj GraphNode) GetId() string
- func (obj GraphNode) GetPublicKey() *string
- func (obj GraphNode) GetTypename() string
- func (obj GraphNode) GetUpdatedAt() time.Time
- type Hop
- type HtlcAttemptFailureCode
- type IdAndSignature
- type IncentivesIneligibilityReason
- type IncentivesStatus
- type IncomingPayment
- func (obj IncomingPayment) GetAmount() CurrencyAmount
- func (obj IncomingPayment) GetAttempts(requester *requester.Requester, first *int64, ...) (*IncomingPaymentToAttemptsConnection, error)
- func (obj IncomingPayment) GetCreatedAt() time.Time
- func (obj IncomingPayment) GetId() string
- func (obj IncomingPayment) GetResolvedAt() *time.Time
- func (obj IncomingPayment) GetStatus() TransactionStatus
- func (obj IncomingPayment) GetTransactionHash() *string
- func (obj IncomingPayment) GetTypename() string
- func (obj IncomingPayment) GetUpdatedAt() time.Time
- type IncomingPaymentAttempt
- type IncomingPaymentAttemptStatus
- type IncomingPaymentToAttemptsConnection
- type Invoice
- type InvoiceData
- type InvoiceDataJSON
- type InvoiceType
- type LightningFeeEstimateForInvoiceInput
- type LightningFeeEstimateForNodeInput
- type LightningFeeEstimateOutput
- type LightningPaymentDirection
- type LightningTransaction
- type LightsparkNode
- type LightsparkNodeOwner
- type LightsparkNodeStatus
- type LightsparkNodeToChannelsConnection
- type LightsparkNodeToDailyLiquidityForecastsConnection
- type LightsparkNodeWithOSK
- func (obj LightsparkNodeWithOSK) GetAddresses(requester *requester.Requester, first *int64, types *[]NodeAddressType) (*NodeToAddressesConnection, error)
- func (obj LightsparkNodeWithOSK) GetAlias() *string
- func (obj LightsparkNodeWithOSK) GetBalances() *Balances
- func (obj LightsparkNodeWithOSK) GetBitcoinNetwork() BitcoinNetwork
- func (obj LightsparkNodeWithOSK) GetBlockchainBalance() *BlockchainBalance
- func (obj LightsparkNodeWithOSK) GetChannels(requester *requester.Requester, first *int64, statuses *[]ChannelStatus, ...) (*LightsparkNodeToChannelsConnection, error)
- func (obj LightsparkNodeWithOSK) GetColor() *string
- func (obj LightsparkNodeWithOSK) GetConductivity() *int64
- func (obj LightsparkNodeWithOSK) GetCreatedAt() time.Time
- func (obj LightsparkNodeWithOSK) GetDailyLiquidityForecasts(requester *requester.Requester, fromDate types.Date, toDate types.Date, ...) (*LightsparkNodeToDailyLiquidityForecastsConnection, error)
- func (obj LightsparkNodeWithOSK) GetDisplayName() string
- func (obj LightsparkNodeWithOSK) GetId() string
- func (obj LightsparkNodeWithOSK) GetLocalBalance() *CurrencyAmount
- func (obj LightsparkNodeWithOSK) GetOwnerId() types.EntityWrapper
- func (obj LightsparkNodeWithOSK) GetPublicKey() *string
- func (obj LightsparkNodeWithOSK) GetRemoteBalance() *CurrencyAmount
- func (obj LightsparkNodeWithOSK) GetStatus() *LightsparkNodeStatus
- func (obj LightsparkNodeWithOSK) GetTotalBalance() *CurrencyAmount
- func (obj LightsparkNodeWithOSK) GetTotalLocalBalance() *CurrencyAmount
- func (obj LightsparkNodeWithOSK) GetTypename() string
- func (obj LightsparkNodeWithOSK) GetUmaPrescreeningUtxos() []string
- func (obj LightsparkNodeWithOSK) GetUpdatedAt() time.Time
- type LightsparkNodeWithRemoteSigning
- func (obj LightsparkNodeWithRemoteSigning) GetAddresses(requester *requester.Requester, first *int64, types *[]NodeAddressType) (*NodeToAddressesConnection, error)
- func (obj LightsparkNodeWithRemoteSigning) GetAlias() *string
- func (obj LightsparkNodeWithRemoteSigning) GetBalances() *Balances
- func (obj LightsparkNodeWithRemoteSigning) GetBitcoinNetwork() BitcoinNetwork
- func (obj LightsparkNodeWithRemoteSigning) GetBlockchainBalance() *BlockchainBalance
- func (obj LightsparkNodeWithRemoteSigning) GetChannels(requester *requester.Requester, first *int64, statuses *[]ChannelStatus, ...) (*LightsparkNodeToChannelsConnection, error)
- func (obj LightsparkNodeWithRemoteSigning) GetColor() *string
- func (obj LightsparkNodeWithRemoteSigning) GetConductivity() *int64
- func (obj LightsparkNodeWithRemoteSigning) GetCreatedAt() time.Time
- func (obj LightsparkNodeWithRemoteSigning) GetDailyLiquidityForecasts(requester *requester.Requester, fromDate types.Date, toDate types.Date, ...) (*LightsparkNodeToDailyLiquidityForecastsConnection, error)
- func (obj LightsparkNodeWithRemoteSigning) GetDisplayName() string
- func (obj LightsparkNodeWithRemoteSigning) GetId() string
- func (obj LightsparkNodeWithRemoteSigning) GetLocalBalance() *CurrencyAmount
- func (obj LightsparkNodeWithRemoteSigning) GetOwnerId() types.EntityWrapper
- func (obj LightsparkNodeWithRemoteSigning) GetPublicKey() *string
- func (obj LightsparkNodeWithRemoteSigning) GetRemoteBalance() *CurrencyAmount
- func (obj LightsparkNodeWithRemoteSigning) GetStatus() *LightsparkNodeStatus
- func (obj LightsparkNodeWithRemoteSigning) GetTotalBalance() *CurrencyAmount
- func (obj LightsparkNodeWithRemoteSigning) GetTotalLocalBalance() *CurrencyAmount
- func (obj LightsparkNodeWithRemoteSigning) GetTypename() string
- func (obj LightsparkNodeWithRemoteSigning) GetUmaPrescreeningUtxos() []string
- func (obj LightsparkNodeWithRemoteSigning) GetUpdatedAt() time.Time
- type Node
- type NodeAddress
- type NodeAddressType
- type NodeToAddressesConnection
- type OnChainTransaction
- type OutgoingPayment
- func (obj OutgoingPayment) GetAmount() CurrencyAmount
- func (obj OutgoingPayment) GetAttempts(requester *requester.Requester, first *int64, after *string) (*OutgoingPaymentToAttemptsConnection, error)
- func (obj OutgoingPayment) GetCreatedAt() time.Time
- func (obj OutgoingPayment) GetId() string
- func (obj OutgoingPayment) GetResolvedAt() *time.Time
- func (obj OutgoingPayment) GetStatus() TransactionStatus
- func (obj OutgoingPayment) GetTransactionHash() *string
- func (obj OutgoingPayment) GetTypename() string
- func (obj OutgoingPayment) GetUpdatedAt() time.Time
- func (data *OutgoingPayment) UnmarshalJSON(dataBytes []byte) error
- type OutgoingPaymentAttempt
- func (obj OutgoingPaymentAttempt) GetCreatedAt() time.Time
- func (obj OutgoingPaymentAttempt) GetHops(requester *requester.Requester, first *int64, after *string) (*OutgoingPaymentAttemptToHopsConnection, error)
- func (obj OutgoingPaymentAttempt) GetId() string
- func (obj OutgoingPaymentAttempt) GetTypename() string
- func (obj OutgoingPaymentAttempt) GetUpdatedAt() time.Time
- type OutgoingPaymentAttemptStatus
- type OutgoingPaymentAttemptToHopsConnection
- type OutgoingPaymentJSON
- type OutgoingPaymentToAttemptsConnection
- type OutgoingPaymentsForInvoiceQueryInput
- type OutgoingPaymentsForInvoiceQueryOutput
- type PageInfo
- type PayInvoiceInput
- type PayInvoiceOutput
- type PayUmaInvoiceInput
- type PaymentDirection
- type PaymentFailureReason
- type PaymentRequest
- type PaymentRequestData
- type PaymentRequestStatus
- type Permission
- type PostTransactionData
- type RegionCode
- type RegisterPaymentInput
- type RegisterPaymentOutput
- type ReleaseChannelPerCommitmentSecretInput
- type ReleaseChannelPerCommitmentSecretOutput
- type ReleasePaymentPreimageInput
- type ReleasePaymentPreimageOutput
- type RemoteSigningSubEventType
- type RequestWithdrawalInput
- type RequestWithdrawalOutput
- type RichText
- type RiskRating
- type RoutingTransaction
- func (obj RoutingTransaction) GetAmount() CurrencyAmount
- func (obj RoutingTransaction) GetCreatedAt() time.Time
- func (obj RoutingTransaction) GetId() string
- func (obj RoutingTransaction) GetResolvedAt() *time.Time
- func (obj RoutingTransaction) GetStatus() TransactionStatus
- func (obj RoutingTransaction) GetTransactionHash() *string
- func (obj RoutingTransaction) GetTypename() string
- func (obj RoutingTransaction) GetUpdatedAt() time.Time
- type RoutingTransactionFailureReason
- type ScreenNodeInput
- type ScreenNodeOutput
- type Secret
- type SendPaymentInput
- type SendPaymentOutput
- type SetInvoicePaymentHashInput
- type SetInvoicePaymentHashOutput
- type SignInvoiceInput
- type SignInvoiceOutput
- type SignMessagesInput
- type SignMessagesOutput
- type Signable
- type SignablePayload
- type SignablePayloadStatus
- type Transaction
- type TransactionFailures
- type TransactionStatus
- type TransactionType
- type UmaInvitation
- type UpdateChannelPerCommitmentPointInput
- type UpdateChannelPerCommitmentPointOutput
- type UpdateNodeSharedSecretInput
- type UpdateNodeSharedSecretOutput
- type Wallet
- func (obj Wallet) GetCreatedAt() time.Time
- func (obj Wallet) GetId() string
- func (obj Wallet) GetPaymentRequests(requester *requester.Requester, first *int64, after *string, ...) (*WalletToPaymentRequestsConnection, error)
- func (obj Wallet) GetTotalAmountReceived(requester *requester.Requester, createdAfterDate *time.Time, ...) (*CurrencyAmount, error)
- func (obj Wallet) GetTotalAmountSent(requester *requester.Requester, createdAfterDate *time.Time, ...) (*CurrencyAmount, error)
- func (obj Wallet) GetTransactions(requester *requester.Requester, first *int64, after *string, ...) (*WalletToTransactionsConnection, error)
- func (obj Wallet) GetTypename() string
- func (obj Wallet) GetUpdatedAt() time.Time
- func (obj Wallet) GetWithdrawalRequests(requester *requester.Requester, first *int64, after *string, ...) (*WalletToWithdrawalRequestsConnection, error)
- type WalletStatus
- type WalletToPaymentRequestsConnection
- type WalletToPaymentRequestsConnectionJSON
- type WalletToTransactionsConnection
- type WalletToTransactionsConnectionJSON
- type WalletToWithdrawalRequestsConnection
- type WebhookEventType
- type Withdrawal
- func (obj Withdrawal) GetAmount() CurrencyAmount
- func (obj Withdrawal) GetBlockHash() *string
- func (obj Withdrawal) GetBlockHeight() int64
- func (obj Withdrawal) GetCreatedAt() time.Time
- func (obj Withdrawal) GetDestinationAddresses() []string
- func (obj Withdrawal) GetFees() *CurrencyAmount
- func (obj Withdrawal) GetId() string
- func (obj Withdrawal) GetNumConfirmations() *int64
- func (obj Withdrawal) GetResolvedAt() *time.Time
- func (obj Withdrawal) GetStatus() TransactionStatus
- func (obj Withdrawal) GetTransactionHash() *string
- func (obj Withdrawal) GetTypename() string
- func (obj Withdrawal) GetUpdatedAt() time.Time
- type WithdrawalFeeEstimateInput
- type WithdrawalFeeEstimateOutput
- type WithdrawalMode
- type WithdrawalRequest
- func (obj WithdrawalRequest) GetChannelClosingTransactions(requester *requester.Requester, first *int64) (*WithdrawalRequestToChannelClosingTransactionsConnection, error)
- func (obj WithdrawalRequest) GetChannelOpeningTransactions(requester *requester.Requester, first *int64) (*WithdrawalRequestToChannelOpeningTransactionsConnection, error)
- func (obj WithdrawalRequest) GetCreatedAt() time.Time
- func (obj WithdrawalRequest) GetId() string
- func (obj WithdrawalRequest) GetTypename() string
- func (obj WithdrawalRequest) GetUpdatedAt() time.Time
- type WithdrawalRequestStatus
- type WithdrawalRequestToChannelClosingTransactionsConnection
- type WithdrawalRequestToChannelOpeningTransactionsConnection
Constants ¶
const (
AccountFragment = `` /* 168-byte string literal not displayed */
)
const (
AccountToApiTokensConnectionFragment = `` /* 496-byte string literal not displayed */
)
const (
AccountToChannelsConnectionFragment = `` /* 488-byte string literal not displayed */
)
const (
AccountToNodesConnectionFragment = `` /* 473-byte string literal not displayed */
)
const (
AccountToPaymentRequestsConnectionFragment = `` /* 526-byte string literal not displayed */
)
const (
AccountToTransactionsConnectionFragment = `` /* 1902-byte string literal not displayed */
)
const (
AccountToWalletsConnectionFragment = `` /* 483-byte string literal not displayed */
)
const (
AccountToWithdrawalRequestsConnectionFragment = `` /* 541-byte string literal not displayed */
)
const (
ApiTokenFragment = `` /* 252-byte string literal not displayed */
)
const (
BalancesFragment = `` /* 1404-byte string literal not displayed */
)
const (
BlockchainBalanceFragment = `` /* 2752-byte string literal not displayed */
)
const (
CancelInvoiceOutputFragment = `` /* 142-byte string literal not displayed */
)
const (
ChannelClosingTransactionFragment = `` /* 1606-byte string literal not displayed */
)
const (
ChannelFeesFragment = `` /* 540-byte string literal not displayed */
)
const (
ChannelFragment = `` /* 4518-byte string literal not displayed */
)
const (
ChannelOpeningTransactionFragment = `` /* 1606-byte string literal not displayed */
)
const (
ChannelSnapshotFragment = `` /* 2421-byte string literal not displayed */
)
const (
ChannelToTransactionsConnectionFragment = `` /* 1534-byte string literal not displayed */
)
const (
ClaimUmaInvitationOutputFragment = `` /* 164-byte string literal not displayed */
)
const (
ClaimUmaInvitationWithIncentivesOutputFragment = `` /* 208-byte string literal not displayed */
)
const (
CreateApiTokenOutputFragment = `` /* 433-byte string literal not displayed */
)
const (
CreateInvitationWithIncentivesOutputFragment = `` /* 201-byte string literal not displayed */
)
const (
CreateInvoiceOutputFragment = `` /* 142-byte string literal not displayed */
)
const (
CreateNodeWalletAddressOutputFragment = `` /* 237-byte string literal not displayed */
)
const (
CreateTestModeInvoiceOutputFragment = `` /* 181-byte string literal not displayed */
)
const (
CreateTestModePaymentoutputFragment = `` /* 256-byte string literal not displayed */
)
const (
CreateUmaInvitationOutputFragment = `` /* 167-byte string literal not displayed */
)
const (
CurrencyAmountFragment = `` /* 411-byte string literal not displayed */
)
const (
DailyLiquidityForecastFragment = `` /* 608-byte string literal not displayed */
)
const (
DeclineToSignMessagesOutputFragment = `` /* 188-byte string literal not displayed */
)
const (
DeleteApiTokenOutputFragment = `` /* 146-byte string literal not displayed */
)
const (
DepositFragment = `` /* 1318-byte string literal not displayed */
)
const (
FeeEstimateFragment = `` /* 910-byte string literal not displayed */
)
const (
FundNodeOutputFragment = `` /* 494-byte string literal not displayed */
)
const ( GetEntityQuery = `query GetEntity($id: ID!) { entity(id: $id) { ... on Account { ...AccountFragment } ... on ApiToken { ...ApiTokenFragment } ... on Channel { ...ChannelFragment } ... on ChannelClosingTransaction { ...ChannelClosingTransactionFragment } ... on ChannelOpeningTransaction { ...ChannelOpeningTransactionFragment } ... on Deposit { ...DepositFragment } ... on GraphNode { ...GraphNodeFragment } ... on Hop { ...HopFragment } ... on IncomingPayment { ...IncomingPaymentFragment } ... on IncomingPaymentAttempt { ...IncomingPaymentAttemptFragment } ... on Invoice { ...InvoiceFragment } ... on LightsparkNodeWithOSK { ...LightsparkNodeWithOSKFragment } ... on LightsparkNodeWithRemoteSigning { ...LightsparkNodeWithRemoteSigningFragment } ... on OutgoingPayment { ...OutgoingPaymentFragment } ... on OutgoingPaymentAttempt { ...OutgoingPaymentAttemptFragment } ... on RoutingTransaction { ...RoutingTransactionFragment } ... on Signable { ...SignableFragment } ... on SignablePayload { ...SignablePayloadFragment } ... on UmaInvitation { ...UmaInvitationFragment } ... on Wallet { ...WalletFragment } ... on Withdrawal { ...WithdrawalFragment } ... on WithdrawalRequest { ...WithdrawalRequestFragment } } }` + AccountFragment + ApiTokenFragment + ChannelFragment + ChannelClosingTransactionFragment + ChannelOpeningTransactionFragment + DepositFragment + GraphNodeFragment + HopFragment + IncomingPaymentFragment + IncomingPaymentAttemptFragment + InvoiceFragment + LightsparkNodeWithOSKFragment + LightsparkNodeWithRemoteSigningFragment + OutgoingPaymentFragment + OutgoingPaymentAttemptFragment + RoutingTransactionFragment + SignableFragment + SignablePayloadFragment + UmaInvitationFragment + WalletFragment + WithdrawalFragment + WithdrawalRequestFragment )
const (
GraphNodeFragment = `` /* 384-byte string literal not displayed */
)
const (
HopFragment = `` /* 1116-byte string literal not displayed */
)
const (
IncomingPaymentAttemptFragment = `` /* 821-byte string literal not displayed */
)
const (
IncomingPaymentFragment = `` /* 1491-byte string literal not displayed */
)
const (
IncomingPaymentToAttemptsConnectionFragment = `` /* 531-byte string literal not displayed */
)
const (
InvoiceDataFragment = `` /* 17704-byte string literal not displayed */
)
const (
InvoiceFragment = `` /* 19439-byte string literal not displayed */
)
const (
LightningFeeEstimateOutputFragment = `` /* 543-byte string literal not displayed */
)
const (
LightsparkNodeToChannelsConnectionFragment = `` /* 526-byte string literal not displayed */
)
const (
LightsparkNodeToDailyLiquidityForecastsConnectionFragment = `` /* 1047-byte string literal not displayed */
)
const (
LightsparkNodeWithOSKFragment = `` /* 7226-byte string literal not displayed */
)
const (
LightsparkNodeWithRemoteSigningFragment = `` /* 7211-byte string literal not displayed */
)
const (
NodeAddressFragment = `` /* 126-byte string literal not displayed */
)
const (
NodeToAddressesConnectionFragment = `` /* 287-byte string literal not displayed */
)
const (
OutgoingPaymentAttemptFragment = `` /* 4067-byte string literal not displayed */
)
const (
OutgoingPaymentAttemptToHopsConnectionFragment = `` /* 549-byte string literal not displayed */
)
const (
OutgoingPaymentFragment = `` /* 22208-byte string literal not displayed */
)
const (
OutgoingPaymentToAttemptsConnectionFragment = `` /* 531-byte string literal not displayed */
)
const (
OutgoingPaymentsForInvoiceQueryOutputFragment = `` /* 201-byte string literal not displayed */
)
const (
PageInfoFragment = `` /* 230-byte string literal not displayed */
)
const (
PayInvoiceOutputFragment = `` /* 133-byte string literal not displayed */
)
const (
PostTransactionDataFragment = `` /* 546-byte string literal not displayed */
)
const (
RegisterPaymentOutputFragment = `` /* 148-byte string literal not displayed */
)
const (
ReleaseChannelPerCommitmentSecretOutputFragment = `` /* 205-byte string literal not displayed */
)
const (
ReleasePaymentPreimageOutputFragment = `` /* 170-byte string literal not displayed */
)
const (
RequestWithdrawalOutputFragment = `` /* 154-byte string literal not displayed */
)
const (
RichTextFragment = `
fragment RichTextFragment on RichText {
__typename
rich_text_text: text
}
`
)
const (
RoutingTransactionFragment = `` /* 1524-byte string literal not displayed */
)
const (
ScreenNodeOutputFragment = `
fragment ScreenNodeOutputFragment on ScreenNodeOutput {
__typename
screen_node_output_rating: rating
}
`
)
const (
SecretFragment = `
fragment SecretFragment on Secret {
__typename
secret_encrypted_value: encrypted_value
secret_cipher: cipher
}
`
)
const (
SendPaymentOutputFragment = `` /* 136-byte string literal not displayed */
)
const (
SetInvoicePaymentHashOutputFragment = `` /* 168-byte string literal not displayed */
)
const (
SignInvoiceOutputFragment = `` /* 136-byte string literal not displayed */
)
const (
SignMessagesOutputFragment = `` /* 155-byte string literal not displayed */
)
const (
SignableFragment = `` /* 150-byte string literal not displayed */
)
const (
SignablePayloadFragment = `` /* 459-byte string literal not displayed */
)
const (
UmaInvitationFragment = `` /* 464-byte string literal not displayed */
)
const (
UpdateChannelPerCommitmentPointOutputFragment = `` /* 199-byte string literal not displayed */
)
const (
)const (
WalletFragment = `` /* 1810-byte string literal not displayed */
)
const (
WalletToPaymentRequestsConnectionFragment = `` /* 521-byte string literal not displayed */
)
const (
WalletToTransactionsConnectionFragment = `` /* 503-byte string literal not displayed */
)
const (
WalletToWithdrawalRequestsConnectionFragment = `` /* 536-byte string literal not displayed */
)
const (
WithdrawalFeeEstimateOutputFragment = `` /* 546-byte string literal not displayed */
)
const (
WithdrawalFragment = `` /* 1353-byte string literal not displayed */
)
const (
WithdrawalRequestFragment = `` /* 2227-byte string literal not displayed */
)
const (
WithdrawalRequestToChannelClosingTransactionsConnectionFragment = `` /* 637-byte string literal not displayed */
)
const (
WithdrawalRequestToChannelOpeningTransactionsConnectionFragment = `` /* 637-byte string literal not displayed */
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"account_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"account_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"account_updated_at"` // Name The name of this account. Name *string `json:"account_name"` // Typename The typename of the object Typename string `json:"__typename"` }
Account This is an object representing the connected Lightspark account. You can retrieve this object to see your account information and objects tied to your account.
func (Account) GetApiTokens ¶
func (Account) GetBlockchainBalance ¶
func (obj Account) GetBlockchainBalance(requester *requester.Requester, bitcoinNetworks *[]BitcoinNetwork, nodeIds *[]string) (*BlockchainBalance, error)
func (Account) GetChannels ¶
func (Account) GetConductivity ¶
func (Account) GetCreatedAt ¶
GetCreatedAt The date and time when the entity was first created.
func (Account) GetId ¶
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (Account) GetLocalBalance ¶
func (obj Account) GetLocalBalance(requester *requester.Requester, bitcoinNetworks *[]BitcoinNetwork, nodeIds *[]string) (*CurrencyAmount, error)
func (Account) GetNodes ¶
func (obj Account) GetNodes(requester *requester.Requester, first *int64, bitcoinNetworks *[]BitcoinNetwork, nodeIds *[]string, after *string) (*AccountToNodesConnection, error)
func (Account) GetPaymentRequests ¶
func (Account) GetRemoteBalance ¶
func (obj Account) GetRemoteBalance(requester *requester.Requester, bitcoinNetworks *[]BitcoinNetwork, nodeIds *[]string) (*CurrencyAmount, error)
func (Account) GetTransactions ¶
func (obj Account) GetTransactions(requester *requester.Requester, first *int64, after *string, types *[]TransactionType, afterDate *time.Time, beforeDate *time.Time, bitcoinNetwork *BitcoinNetwork, lightningNodeId *string, statuses *[]TransactionStatus, excludeFailures *TransactionFailures) (*AccountToTransactionsConnection, error)
func (Account) GetTypename ¶ added in v0.6.1
func (Account) GetUpdatedAt ¶
GetUpdatedAt The date and time when the entity was last updated.
func (Account) GetUptimePercentage ¶
func (Account) GetWallets ¶
func (Account) GetWithdrawalRequests ¶ added in v0.7.1
func (obj Account) GetWithdrawalRequests(requester *requester.Requester, first *int64, after *string, bitcoinNetworks *[]BitcoinNetwork, statuses *[]WithdrawalRequestStatus, nodeIds *[]string, afterDate *time.Time, beforeDate *time.Time) (*AccountToWithdrawalRequestsConnection, error)
type AccountToApiTokensConnection ¶
type AccountToApiTokensConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"account_to_api_tokens_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"account_to_api_tokens_connection_page_info"` // Entities The API tokens for the current page of this connection. Entities []ApiToken `json:"account_to_api_tokens_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
func (AccountToApiTokensConnection) GetCount ¶
func (obj AccountToApiTokensConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (AccountToApiTokensConnection) GetPageInfo ¶
func (obj AccountToApiTokensConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (AccountToApiTokensConnection) GetTypename ¶ added in v0.6.1
func (obj AccountToApiTokensConnection) GetTypename() string
type AccountToChannelsConnection ¶
type AccountToChannelsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"account_to_channels_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"account_to_channels_connection_page_info"` // Entities The channels for the current page of this connection. Entities []Channel `json:"account_to_channels_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
func (AccountToChannelsConnection) GetCount ¶ added in v0.7.4
func (obj AccountToChannelsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (AccountToChannelsConnection) GetPageInfo ¶ added in v0.7.4
func (obj AccountToChannelsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (AccountToChannelsConnection) GetTypename ¶ added in v0.7.4
func (obj AccountToChannelsConnection) GetTypename() string
type AccountToNodesConnection ¶
type AccountToNodesConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"account_to_nodes_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"account_to_nodes_connection_page_info"` // Entities The nodes for the current page of this connection. Entities []LightsparkNode `json:"account_to_nodes_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
AccountToNodesConnection A connection between an account and the nodes it manages.
func (AccountToNodesConnection) GetCount ¶
func (obj AccountToNodesConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (AccountToNodesConnection) GetPageInfo ¶
func (obj AccountToNodesConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (AccountToNodesConnection) GetTypename ¶ added in v0.6.1
func (obj AccountToNodesConnection) GetTypename() string
func (*AccountToNodesConnection) UnmarshalJSON ¶
func (data *AccountToNodesConnection) UnmarshalJSON(dataBytes []byte) error
type AccountToNodesConnectionJSON ¶
type AccountToNodesConnectionJSON struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"account_to_nodes_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"account_to_nodes_connection_page_info"` // Entities The nodes for the current page of this connection. Entities []map[string]interface{} `json:"account_to_nodes_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
type AccountToPaymentRequestsConnection ¶
type AccountToPaymentRequestsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"account_to_payment_requests_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"account_to_payment_requests_connection_page_info"` // Entities The payment requests for the current page of this connection. Entities []PaymentRequest `json:"account_to_payment_requests_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
func (AccountToPaymentRequestsConnection) GetCount ¶
func (obj AccountToPaymentRequestsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (AccountToPaymentRequestsConnection) GetPageInfo ¶
func (obj AccountToPaymentRequestsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (AccountToPaymentRequestsConnection) GetTypename ¶ added in v0.6.1
func (obj AccountToPaymentRequestsConnection) GetTypename() string
func (*AccountToPaymentRequestsConnection) UnmarshalJSON ¶
func (data *AccountToPaymentRequestsConnection) UnmarshalJSON(dataBytes []byte) error
type AccountToPaymentRequestsConnectionJSON ¶
type AccountToPaymentRequestsConnectionJSON struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"account_to_payment_requests_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"account_to_payment_requests_connection_page_info"` // Entities The payment requests for the current page of this connection. Entities []map[string]interface{} `json:"account_to_payment_requests_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
type AccountToTransactionsConnection ¶
type AccountToTransactionsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"account_to_transactions_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"account_to_transactions_connection_page_info"` // ProfitLoss Profit (or loss) generated by the transactions in this connection, with the set of filters and constraints provided. ProfitLoss *CurrencyAmount `json:"account_to_transactions_connection_profit_loss"` // AverageFeeEarned Average fee earned for the transactions in this connection, with the set of filters and constraints provided. AverageFeeEarned *CurrencyAmount `json:"account_to_transactions_connection_average_fee_earned"` // TotalAmountTransacted Total amount transacted by the transactions in this connection, with the set of filters and constraints provided. TotalAmountTransacted *CurrencyAmount `json:"account_to_transactions_connection_total_amount_transacted"` // Entities The transactions for the current page of this connection. Entities []Transaction `json:"account_to_transactions_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
func (AccountToTransactionsConnection) GetCount ¶
func (obj AccountToTransactionsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (AccountToTransactionsConnection) GetPageInfo ¶
func (obj AccountToTransactionsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (AccountToTransactionsConnection) GetTypename ¶ added in v0.6.1
func (obj AccountToTransactionsConnection) GetTypename() string
func (*AccountToTransactionsConnection) UnmarshalJSON ¶
func (data *AccountToTransactionsConnection) UnmarshalJSON(dataBytes []byte) error
type AccountToTransactionsConnectionJSON ¶
type AccountToTransactionsConnectionJSON struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"account_to_transactions_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"account_to_transactions_connection_page_info"` // ProfitLoss Profit (or loss) generated by the transactions in this connection, with the set of filters and constraints provided. ProfitLoss *CurrencyAmount `json:"account_to_transactions_connection_profit_loss"` // AverageFeeEarned Average fee earned for the transactions in this connection, with the set of filters and constraints provided. AverageFeeEarned *CurrencyAmount `json:"account_to_transactions_connection_average_fee_earned"` // TotalAmountTransacted Total amount transacted by the transactions in this connection, with the set of filters and constraints provided. TotalAmountTransacted *CurrencyAmount `json:"account_to_transactions_connection_total_amount_transacted"` // Entities The transactions for the current page of this connection. Entities []map[string]interface{} `json:"account_to_transactions_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
type AccountToWalletsConnection ¶
type AccountToWalletsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"account_to_wallets_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"account_to_wallets_connection_page_info"` // Entities The wallets for the current page of this connection. Entities []Wallet `json:"account_to_wallets_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
func (AccountToWalletsConnection) GetCount ¶
func (obj AccountToWalletsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (AccountToWalletsConnection) GetPageInfo ¶
func (obj AccountToWalletsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (AccountToWalletsConnection) GetTypename ¶ added in v0.6.1
func (obj AccountToWalletsConnection) GetTypename() string
type AccountToWithdrawalRequestsConnection ¶ added in v0.7.1
type AccountToWithdrawalRequestsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"account_to_withdrawal_requests_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"account_to_withdrawal_requests_connection_page_info"` // Entities The withdrawal requests for the current page of this connection. Entities []WithdrawalRequest `json:"account_to_withdrawal_requests_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
AccountToWithdrawalRequestsConnection A connection between an account and its past and present withdrawal requests.
func (AccountToWithdrawalRequestsConnection) GetCount ¶ added in v0.7.1
func (obj AccountToWithdrawalRequestsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (AccountToWithdrawalRequestsConnection) GetPageInfo ¶ added in v0.7.1
func (obj AccountToWithdrawalRequestsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (AccountToWithdrawalRequestsConnection) GetTypename ¶ added in v0.7.1
func (obj AccountToWithdrawalRequestsConnection) GetTypename() string
type ApiToken ¶
type ApiToken struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"api_token_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"api_token_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"api_token_updated_at"` // ClientId An opaque identifier that should be used as a client_id (or username) in the HTTP Basic Authentication scheme when issuing requests against the Lightspark API. ClientId string `json:"api_token_client_id"` // Name An arbitrary name chosen by the creator of the token to help identify the token in the list of tokens that have been created for the account. Name string `json:"api_token_name"` // Permissions A list of permissions granted to the token. Permissions []Permission `json:"api_token_permissions"` // Typename The typename of the object Typename string `json:"__typename"` }
ApiToken This is an object representing a Lightspark API token, that can be used to authenticate this account when making API calls or using our SDKs. See the “Authentication” section of our API docs for more details on its usage.
func (ApiToken) GetCreatedAt ¶
GetCreatedAt The date and time when the entity was first created.
func (ApiToken) GetId ¶
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (ApiToken) GetTypename ¶ added in v0.6.1
func (ApiToken) GetUpdatedAt ¶
GetUpdatedAt The date and time when the entity was last updated.
type Balances ¶
type Balances struct { // OwnedBalance This represents the balance that should be displayed when asked "how much do I own right now?". // // It represents the amount currently owned, including things that may not be owned soon (e.g. in-flight outgoing payments, in-flight withdrawals, commit fees, etc.). It really is a snapshot of what is officially owned at this instant. OwnedBalance CurrencyAmount `json:"balances_owned_balance"` // AvailableToSendBalance This represents the balance that should be displayed when asked "how much can I send on Lightning right now?". // // It represents the amount currently available to be sent on the Lightning network. We remove from the balance all the funds that are temporarily locked (e.g. channel reserves). AvailableToSendBalance CurrencyAmount `json:"balances_available_to_send_balance"` // AvailableToWithdrawBalance This represents the balance that should be displayed when asked "how much money can I withdraw on the Bitcoin network right now?". // // It represents the amount currently available to withdraw and is usually equal to the `owned_balance` but it does not include in-flight operations (which would likely succeed and therefore likely make your withdrawal fail). AvailableToWithdrawBalance CurrencyAmount `json:"balances_available_to_withdraw_balance"` }
Balances This is an object representing the balance associated with your Lightspark account. You can retrieve this object to see your balance, which can be broken down into several different categorizations.
type BitcoinNetwork ¶
type BitcoinNetwork int
BitcoinNetwork This is an enum identifying a particular Bitcoin Network.
const ( BitcoinNetworkUndefined BitcoinNetwork = iota // BitcoinNetworkMainnet The production version of the Bitcoin Blockchain. BitcoinNetworkMainnet // BitcoinNetworkRegtest A test version of the Bitcoin Blockchain, maintained by Lightspark. BitcoinNetworkRegtest // BitcoinNetworkSignet A test version of the Bitcoin Blockchain, maintained by a centralized organization. Not in use at Lightspark. BitcoinNetworkSignet // BitcoinNetworkTestnet A test version of the Bitcoin Blockchain, publicly available. BitcoinNetworkTestnet )
func (BitcoinNetwork) MarshalJSON ¶
func (a BitcoinNetwork) MarshalJSON() ([]byte, error)
func (BitcoinNetwork) StringValue ¶
func (a BitcoinNetwork) StringValue() string
func (*BitcoinNetwork) UnmarshalJSON ¶
func (a *BitcoinNetwork) UnmarshalJSON(b []byte) error
type BlockchainBalance ¶
type BlockchainBalance struct { // TotalBalance The total wallet balance, including unconfirmed UTXOs. TotalBalance *CurrencyAmount `json:"blockchain_balance_total_balance"` // ConfirmedBalance The balance of confirmed UTXOs in the wallet. ConfirmedBalance *CurrencyAmount `json:"blockchain_balance_confirmed_balance"` // UnconfirmedBalance The balance of unconfirmed UTXOs in the wallet. UnconfirmedBalance *CurrencyAmount `json:"blockchain_balance_unconfirmed_balance"` // LockedBalance The balance that's locked by an on-chain transaction. LockedBalance *CurrencyAmount `json:"blockchain_balance_locked_balance"` // RequiredReserve Funds required to be held in reserve for channel bumping. RequiredReserve *CurrencyAmount `json:"blockchain_balance_required_reserve"` // AvailableBalance Funds available for creating channels or withdrawing. AvailableBalance *CurrencyAmount `json:"blockchain_balance_available_balance"` }
BlockchainBalance This is an object representing a detailed breakdown of the balance for a Lightspark Node.
type CancelInvoiceInput ¶ added in v0.7.0
type CancelInvoiceInput struct {
InvoiceId string `json:"cancel_invoice_input_invoice_id"`
}
type CancelInvoiceOutput ¶ added in v0.7.0
type CancelInvoiceOutput struct {
Invoice types.EntityWrapper `json:"cancel_invoice_output_invoice"`
}
type Channel ¶
type Channel struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"channel_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"channel_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"channel_updated_at"` // FundingTransaction The transaction that funded the channel upon channel opening. FundingTransaction *types.EntityWrapper `json:"channel_funding_transaction"` // Capacity The total amount of funds in this channel, including the channel balance on the local node, the channel balance on the remote node and the on-chain fees to close the channel. Capacity *CurrencyAmount `json:"channel_capacity"` // LocalBalance The channel balance on the local node. LocalBalance *CurrencyAmount `json:"channel_local_balance"` // LocalUnsettledBalance The channel balance on the local node that is currently allocated to in-progress payments. LocalUnsettledBalance *CurrencyAmount `json:"channel_local_unsettled_balance"` // RemoteBalance The channel balance on the remote node. RemoteBalance *CurrencyAmount `json:"channel_remote_balance"` // RemoteUnsettledBalance The channel balance on the remote node that is currently allocated to in-progress payments. RemoteUnsettledBalance *CurrencyAmount `json:"channel_remote_unsettled_balance"` // UnsettledBalance The channel balance that is currently allocated to in-progress payments. UnsettledBalance *CurrencyAmount `json:"channel_unsettled_balance"` // TotalBalance The total balance in this channel, including the channel balance on both local and remote nodes. TotalBalance *CurrencyAmount `json:"channel_total_balance"` // Status The current status of this channel. Status *ChannelStatus `json:"channel_status"` // EstimatedForceClosureWaitMinutes The estimated time to wait for the channel's hash timelock contract to expire when force closing the channel. It is in unit of minutes. EstimatedForceClosureWaitMinutes *int64 `json:"channel_estimated_force_closure_wait_minutes"` // CommitFee The amount to be paid in fees for the current set of commitment transactions. CommitFee *CurrencyAmount `json:"channel_commit_fee"` // Fees The fees charged for routing payments through this channel. Fees *ChannelFees `json:"channel_fees"` // RemoteNode If known, the remote node of the channel. RemoteNode *types.EntityWrapper `json:"channel_remote_node"` // LocalNode The local Lightspark node of the channel. LocalNode types.EntityWrapper `json:"channel_local_node"` // ShortChannelId The unique identifier of the channel on Lightning Network, which is the location in the chain that the channel was confirmed. The format is <block-height>:<tx-index>:<tx-output>. ShortChannelId *string `json:"channel_short_channel_id"` // Typename The typename of the object Typename string `json:"__typename"` }
Channel This is an object representing a channel on the Lightning Network. You can retrieve this object to get detailed information on a specific Lightning Network channel.
func (Channel) GetCreatedAt ¶
GetCreatedAt The date and time when the entity was first created.
func (Channel) GetId ¶
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (Channel) GetTransactions ¶
func (obj Channel) GetTransactions(requester *requester.Requester, types *[]TransactionType, afterDate *time.Time, beforeDate *time.Time) (*ChannelToTransactionsConnection, error)
func (Channel) GetTypename ¶ added in v0.6.1
func (Channel) GetUpdatedAt ¶
GetUpdatedAt The date and time when the entity was last updated.
type ChannelClosingTransaction ¶
type ChannelClosingTransaction struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"channel_closing_transaction_id"` // CreatedAt The date and time when this transaction was initiated. CreatedAt time.Time `json:"channel_closing_transaction_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"channel_closing_transaction_updated_at"` // Status The current status of this transaction. Status TransactionStatus `json:"channel_closing_transaction_status"` // ResolvedAt The date and time when this transaction was completed or failed. ResolvedAt *time.Time `json:"channel_closing_transaction_resolved_at"` // Amount The amount of money involved in this transaction. Amount CurrencyAmount `json:"channel_closing_transaction_amount"` // TransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network. TransactionHash *string `json:"channel_closing_transaction_transaction_hash"` // Fees The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin blockchain. Fees *CurrencyAmount `json:"channel_closing_transaction_fees"` // BlockHash The hash of the block that included this transaction. This will be null for unconfirmed transactions. BlockHash *string `json:"channel_closing_transaction_block_hash"` // BlockHeight The height of the block that included this transaction. This will be zero for unconfirmed transactions. BlockHeight int64 `json:"channel_closing_transaction_block_height"` // DestinationAddresses The Bitcoin blockchain addresses this transaction was sent to. DestinationAddresses []string `json:"channel_closing_transaction_destination_addresses"` // NumConfirmations The number of blockchain confirmations for this transaction in real time. NumConfirmations *int64 `json:"channel_closing_transaction_num_confirmations"` // Channel If known, the channel this transaction is closing. Channel *types.EntityWrapper `json:"channel_closing_transaction_channel"` // Typename The typename of the object Typename string `json:"__typename"` }
ChannelClosingTransaction This is an object representing a transaction which closes a channel on the Lightning Network. This operation allocates balances back to the local and remote nodes.
func (ChannelClosingTransaction) GetAmount ¶
func (obj ChannelClosingTransaction) GetAmount() CurrencyAmount
GetAmount The amount of money involved in this transaction.
func (ChannelClosingTransaction) GetBlockHash ¶
func (obj ChannelClosingTransaction) GetBlockHash() *string
GetBlockHash The hash of the block that included this transaction. This will be null for unconfirmed transactions.
func (ChannelClosingTransaction) GetBlockHeight ¶
func (obj ChannelClosingTransaction) GetBlockHeight() int64
GetBlockHeight The height of the block that included this transaction. This will be zero for unconfirmed transactions.
func (ChannelClosingTransaction) GetCreatedAt ¶
func (obj ChannelClosingTransaction) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (ChannelClosingTransaction) GetDestinationAddresses ¶
func (obj ChannelClosingTransaction) GetDestinationAddresses() []string
GetDestinationAddresses The Bitcoin blockchain addresses this transaction was sent to.
func (ChannelClosingTransaction) GetFees ¶
func (obj ChannelClosingTransaction) GetFees() *CurrencyAmount
GetFees The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin blockchain.
func (ChannelClosingTransaction) GetId ¶
func (obj ChannelClosingTransaction) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (ChannelClosingTransaction) GetNumConfirmations ¶
func (obj ChannelClosingTransaction) GetNumConfirmations() *int64
GetNumConfirmations The number of blockchain confirmations for this transaction in real time.
func (ChannelClosingTransaction) GetResolvedAt ¶
func (obj ChannelClosingTransaction) GetResolvedAt() *time.Time
GetResolvedAt The date and time when this transaction was completed or failed.
func (ChannelClosingTransaction) GetStatus ¶
func (obj ChannelClosingTransaction) GetStatus() TransactionStatus
GetStatus The current status of this transaction.
func (ChannelClosingTransaction) GetTransactionHash ¶
func (obj ChannelClosingTransaction) GetTransactionHash() *string
GetTransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network.
func (ChannelClosingTransaction) GetTypename ¶ added in v0.6.1
func (obj ChannelClosingTransaction) GetTypename() string
func (ChannelClosingTransaction) GetUpdatedAt ¶
func (obj ChannelClosingTransaction) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type ChannelFees ¶
type ChannelFees struct { BaseFee *CurrencyAmount `json:"channel_fees_base_fee"` FeeRatePerMil *int64 `json:"channel_fees_fee_rate_per_mil"` }
ChannelFees This represents the fee policies set for a channel on the Lightning Network.
type ChannelOpeningTransaction ¶
type ChannelOpeningTransaction struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"channel_opening_transaction_id"` // CreatedAt The date and time when this transaction was initiated. CreatedAt time.Time `json:"channel_opening_transaction_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"channel_opening_transaction_updated_at"` // Status The current status of this transaction. Status TransactionStatus `json:"channel_opening_transaction_status"` // ResolvedAt The date and time when this transaction was completed or failed. ResolvedAt *time.Time `json:"channel_opening_transaction_resolved_at"` // Amount The amount of money involved in this transaction. Amount CurrencyAmount `json:"channel_opening_transaction_amount"` // TransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network. TransactionHash *string `json:"channel_opening_transaction_transaction_hash"` // Fees The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin blockchain. Fees *CurrencyAmount `json:"channel_opening_transaction_fees"` // BlockHash The hash of the block that included this transaction. This will be null for unconfirmed transactions. BlockHash *string `json:"channel_opening_transaction_block_hash"` // BlockHeight The height of the block that included this transaction. This will be zero for unconfirmed transactions. BlockHeight int64 `json:"channel_opening_transaction_block_height"` // DestinationAddresses The Bitcoin blockchain addresses this transaction was sent to. DestinationAddresses []string `json:"channel_opening_transaction_destination_addresses"` // NumConfirmations The number of blockchain confirmations for this transaction in real time. NumConfirmations *int64 `json:"channel_opening_transaction_num_confirmations"` // Channel If known, the channel this transaction is opening. Channel *types.EntityWrapper `json:"channel_opening_transaction_channel"` // Typename The typename of the object Typename string `json:"__typename"` }
ChannelOpeningTransaction This is an object representing a transaction which opens a channel on the Lightning Network. This object occurs only for channels funded by the local Lightspark node.
func (ChannelOpeningTransaction) GetAmount ¶
func (obj ChannelOpeningTransaction) GetAmount() CurrencyAmount
GetAmount The amount of money involved in this transaction.
func (ChannelOpeningTransaction) GetBlockHash ¶
func (obj ChannelOpeningTransaction) GetBlockHash() *string
GetBlockHash The hash of the block that included this transaction. This will be null for unconfirmed transactions.
func (ChannelOpeningTransaction) GetBlockHeight ¶
func (obj ChannelOpeningTransaction) GetBlockHeight() int64
GetBlockHeight The height of the block that included this transaction. This will be zero for unconfirmed transactions.
func (ChannelOpeningTransaction) GetCreatedAt ¶
func (obj ChannelOpeningTransaction) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (ChannelOpeningTransaction) GetDestinationAddresses ¶
func (obj ChannelOpeningTransaction) GetDestinationAddresses() []string
GetDestinationAddresses The Bitcoin blockchain addresses this transaction was sent to.
func (ChannelOpeningTransaction) GetFees ¶
func (obj ChannelOpeningTransaction) GetFees() *CurrencyAmount
GetFees The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin blockchain.
func (ChannelOpeningTransaction) GetId ¶
func (obj ChannelOpeningTransaction) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (ChannelOpeningTransaction) GetNumConfirmations ¶
func (obj ChannelOpeningTransaction) GetNumConfirmations() *int64
GetNumConfirmations The number of blockchain confirmations for this transaction in real time.
func (ChannelOpeningTransaction) GetResolvedAt ¶
func (obj ChannelOpeningTransaction) GetResolvedAt() *time.Time
GetResolvedAt The date and time when this transaction was completed or failed.
func (ChannelOpeningTransaction) GetStatus ¶
func (obj ChannelOpeningTransaction) GetStatus() TransactionStatus
GetStatus The current status of this transaction.
func (ChannelOpeningTransaction) GetTransactionHash ¶
func (obj ChannelOpeningTransaction) GetTransactionHash() *string
GetTransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network.
func (ChannelOpeningTransaction) GetTypename ¶ added in v0.6.1
func (obj ChannelOpeningTransaction) GetTypename() string
func (ChannelOpeningTransaction) GetUpdatedAt ¶
func (obj ChannelOpeningTransaction) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type ChannelSnapshot ¶ added in v0.6.0
type ChannelSnapshot struct { Channel types.EntityWrapper `json:"channel_snapshot_channel"` Timestamp time.Time `json:"channel_snapshot_timestamp"` LocalBalance *CurrencyAmount `json:"channel_snapshot_local_balance"` LocalUnsettledBalance *CurrencyAmount `json:"channel_snapshot_local_unsettled_balance"` LocalChannelReserve *CurrencyAmount `json:"channel_snapshot_local_channel_reserve"` RemoteBalance *CurrencyAmount `json:"channel_snapshot_remote_balance"` RemoteUnsettledBalance *CurrencyAmount `json:"channel_snapshot_remote_unsettled_balance"` }
type ChannelStatus ¶
type ChannelStatus int
ChannelStatus This is an enum representing the status of a channel on the Lightning Network.
const ( ChannelStatusUndefined ChannelStatus = iota // ChannelStatusOk The channel is online and ready to send and receive funds. ChannelStatusOk // ChannelStatusPending The channel has been created, but the Bitcoin transaction that initiates it still needs to be confirmed on the Bitcoin blockchain. ChannelStatusPending // ChannelStatusOffline The channel is not available, likely because the peer is not online. ChannelStatusOffline // ChannelStatusUnbalancedForSend The channel is behaving properly, but its remote balance is much higher than its local balance so it is not balanced properly for sending funds out. ChannelStatusUnbalancedForSend // ChannelStatusUnbalancedForReceive The channel is behaving properly, but its remote balance is much lower than its local balance so it is not balanced properly for receiving funds. ChannelStatusUnbalancedForReceive // ChannelStatusClosed The channel has been closed. Information about the channel is still available for historical purposes but the channel cannot be used anymore. ChannelStatusClosed // ChannelStatusError Something unexpected happened and we cannot determine the status of this channel. Please try again later or contact the support. ChannelStatusError )
func (ChannelStatus) MarshalJSON ¶
func (a ChannelStatus) MarshalJSON() ([]byte, error)
func (ChannelStatus) StringValue ¶
func (a ChannelStatus) StringValue() string
func (*ChannelStatus) UnmarshalJSON ¶
func (a *ChannelStatus) UnmarshalJSON(b []byte) error
type ChannelToTransactionsConnection ¶
type ChannelToTransactionsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"channel_to_transactions_connection_count"` // AverageFee The average fee for the transactions that transited through this channel, according to the filters and constraints of the connection. AverageFee *CurrencyAmount `json:"channel_to_transactions_connection_average_fee"` // TotalAmountTransacted The total amount transacted for the transactions that transited through this channel, according to the filters and constraints of the connection. TotalAmountTransacted *CurrencyAmount `json:"channel_to_transactions_connection_total_amount_transacted"` // TotalFees The total amount of fees for the transactions that transited through this channel, according to the filters and constraints of the connection. TotalFees *CurrencyAmount `json:"channel_to_transactions_connection_total_fees"` }
type ClaimUmaInvitationInput ¶ added in v0.7.0
type ClaimUmaInvitationOutput ¶ added in v0.7.0
type ClaimUmaInvitationOutput struct {
Invitation types.EntityWrapper `json:"claim_uma_invitation_output_invitation"`
}
type ClaimUmaInvitationWithIncentivesInput ¶ added in v0.7.0
type ClaimUmaInvitationWithIncentivesInput struct { InvitationCode string `json:"claim_uma_invitation_with_incentives_input_invitation_code"` InviteeUma string `json:"claim_uma_invitation_with_incentives_input_invitee_uma"` InviteePhoneHash string `json:"claim_uma_invitation_with_incentives_input_invitee_phone_hash"` InviteeRegion RegionCode `json:"claim_uma_invitation_with_incentives_input_invitee_region"` }
type ClaimUmaInvitationWithIncentivesOutput ¶ added in v0.7.0
type ClaimUmaInvitationWithIncentivesOutput struct {
Invitation types.EntityWrapper `json:"claim_uma_invitation_with_incentives_output_invitation"`
}
type ComplianceProvider ¶
type ComplianceProvider int
ComplianceProvider This is an enum identifying a type of compliance provider.
const ( ComplianceProviderUndefined ComplianceProvider = iota ComplianceProviderChainalysis )
func (ComplianceProvider) MarshalJSON ¶
func (a ComplianceProvider) MarshalJSON() ([]byte, error)
func (ComplianceProvider) StringValue ¶
func (a ComplianceProvider) StringValue() string
func (*ComplianceProvider) UnmarshalJSON ¶
func (a *ComplianceProvider) UnmarshalJSON(b []byte) error
type Connection ¶
type Connection interface { // GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). GetCount() int64 // GetPageInfo An object that holds pagination information about the objects in this connection. GetPageInfo() PageInfo // GetTypename The typename of the object GetTypename() string }
func ConnectionUnmarshal ¶
func ConnectionUnmarshal(data map[string]interface{}) (Connection, error)
type CreateApiTokenInput ¶
type CreateApiTokenInput struct { // Name An arbitrary name that the user can choose to identify the API token in a list. Name string `json:"create_api_token_input_name"` // Permissions List of permissions to grant to the API token Permissions []Permission `json:"create_api_token_input_permissions"` }
type CreateApiTokenOutput ¶
type CreateApiTokenOutput struct { // ApiToken The API Token that has been created. ApiToken ApiToken `json:"create_api_token_output_api_token"` // ClientSecret The secret that should be used to authenticate against our API. // This secret is not stored and will never be available again after this. You must keep this secret secure as it grants access to your account. ClientSecret string `json:"create_api_token_output_client_secret"` }
type CreateInvitationWithIncentivesInput ¶ added in v0.7.0
type CreateInvitationWithIncentivesInput struct { InviterUma string `json:"create_invitation_with_incentives_input_inviter_uma"` InviterPhoneHash string `json:"create_invitation_with_incentives_input_inviter_phone_hash"` InviterRegion RegionCode `json:"create_invitation_with_incentives_input_inviter_region"` }
type CreateInvitationWithIncentivesOutput ¶ added in v0.7.0
type CreateInvitationWithIncentivesOutput struct {
Invitation types.EntityWrapper `json:"create_invitation_with_incentives_output_invitation"`
}
type CreateInvoiceInput ¶
type CreateInvoiceInput struct { // NodeId The node from which to create the invoice. NodeId string `json:"create_invoice_input_node_id"` // AmountMsats The amount for which the invoice should be created, in millisatoshis. AmountMsats int64 `json:"create_invoice_input_amount_msats"` Memo *string `json:"create_invoice_input_memo"` InvoiceType *InvoiceType `json:"create_invoice_input_invoice_type"` // ExpirySecs The expiry of the invoice in seconds. Default value is 86400 (1 day). ExpirySecs *int64 `json:"create_invoice_input_expiry_secs"` }
type CreateInvoiceOutput ¶
type CreateInvoiceOutput struct {
Invoice types.EntityWrapper `json:"create_invoice_output_invoice"`
}
type CreateLnurlInvoiceInput ¶
type CreateLnurlInvoiceInput struct { // NodeId The node from which to create the invoice. NodeId string `json:"create_lnurl_invoice_input_node_id"` // AmountMsats The amount for which the invoice should be created, in millisatoshis. AmountMsats int64 `json:"create_lnurl_invoice_input_amount_msats"` // MetadataHash The SHA256 hash of the LNURL metadata payload. This will be present in the h-tag (SHA256 purpose of payment) of the resulting Bolt 11 invoice. MetadataHash string `json:"create_lnurl_invoice_input_metadata_hash"` // ExpirySecs The expiry of the invoice in seconds. Default value is 86400 (1 day). ExpirySecs *int64 `json:"create_lnurl_invoice_input_expiry_secs"` }
type CreateNodeWalletAddressInput ¶
type CreateNodeWalletAddressInput struct {
NodeId string `json:"create_node_wallet_address_input_node_id"`
}
type CreateNodeWalletAddressOutput ¶
type CreateNodeWalletAddressOutput struct { Node types.EntityWrapper `json:"create_node_wallet_address_output_node"` WalletAddress string `json:"create_node_wallet_address_output_wallet_address"` }
type CreateTestModeInvoiceInput ¶
type CreateTestModeInvoiceInput struct { LocalNodeId string `json:"create_test_mode_invoice_input_local_node_id"` AmountMsats int64 `json:"create_test_mode_invoice_input_amount_msats"` Memo *string `json:"create_test_mode_invoice_input_memo"` InvoiceType *InvoiceType `json:"create_test_mode_invoice_input_invoice_type"` }
type CreateTestModeInvoiceOutput ¶
type CreateTestModeInvoiceOutput struct {
EncodedPaymentRequest string `json:"create_test_mode_invoice_output_encoded_payment_request"`
}
type CreateTestModePaymentInput ¶
type CreateTestModePaymentInput struct { // LocalNodeId The node to where you want to send the payment. LocalNodeId string `json:"create_test_mode_payment_input_local_node_id"` // EncodedInvoice The invoice you want to be paid (as defined by the BOLT11 standard). EncodedInvoice string `json:"create_test_mode_payment_input_encoded_invoice"` // AmountMsats The amount you will be paid for this invoice, expressed in msats. It should ONLY be set when the invoice amount is zero. AmountMsats *int64 `json:"create_test_mode_payment_input_amount_msats"` }
type CreateTestModePaymentoutput ¶
type CreateTestModePaymentoutput struct { // Payment The payment that has been sent. // Deprecated: Use incoming_payment instead. Payment types.EntityWrapper `json:"create_test_mode_paymentoutput_payment"` // IncomingPayment The payment that has been received. IncomingPayment types.EntityWrapper `json:"create_test_mode_paymentoutput_incoming_payment"` }
CreateTestModePaymentoutput This is an object identifying the output of a test mode payment. This object can be used to retrieve the associated payment made from a Test Mode Payment call.
type CreateUmaInvitationInput ¶ added in v0.7.0
type CreateUmaInvitationInput struct {
InviterUma string `json:"create_uma_invitation_input_inviter_uma"`
}
type CreateUmaInvitationOutput ¶ added in v0.7.0
type CreateUmaInvitationOutput struct {
Invitation types.EntityWrapper `json:"create_uma_invitation_output_invitation"`
}
type CreateUmaInvoiceInput ¶
type CurrencyAmount ¶
type CurrencyAmount struct { // OriginalValue The original numeric value for this CurrencyAmount. OriginalValue int64 `json:"currency_amount_original_value"` // OriginalUnit The original unit of currency for this CurrencyAmount. OriginalUnit CurrencyUnit `json:"currency_amount_original_unit"` // PreferredCurrencyUnit The unit of user's preferred currency. PreferredCurrencyUnit CurrencyUnit `json:"currency_amount_preferred_currency_unit"` // PreferredCurrencyValueRounded The rounded numeric value for this CurrencyAmount in the very base level of user's preferred currency. For example, for USD, the value will be in cents. PreferredCurrencyValueRounded int64 `json:"currency_amount_preferred_currency_value_rounded"` // PreferredCurrencyValueApprox The approximate float value for this CurrencyAmount in the very base level of user's preferred currency. For example, for USD, the value will be in cents. PreferredCurrencyValueApprox float64 `json:"currency_amount_preferred_currency_value_approx"` }
CurrencyAmount This object represents the value and unit for an amount of currency.
type CurrencyUnit ¶
type CurrencyUnit int
CurrencyUnit This enum identifies the unit of currency associated with a CurrencyAmount.
const ( CurrencyUnitUndefined CurrencyUnit = iota // CurrencyUnitBitcoin Bitcoin is the cryptocurrency native to the Bitcoin network. It is used as the native medium for value transfer for the Lightning Network. CurrencyUnitBitcoin // CurrencyUnitSatoshi 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin. This is the unit most commonly used in Lightning transactions. CurrencyUnitSatoshi // CurrencyUnitMillisatoshi 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible. CurrencyUnitMillisatoshi // CurrencyUnitUsd United States Dollar. CurrencyUnitUsd // CurrencyUnitNanobitcoin 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. CurrencyUnitNanobitcoin // CurrencyUnitMicrobitcoin 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. CurrencyUnitMicrobitcoin // CurrencyUnitMillibitcoin 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin. We recommend using the Satoshi unit instead when possible. CurrencyUnitMillibitcoin )
func (CurrencyUnit) MarshalJSON ¶
func (a CurrencyUnit) MarshalJSON() ([]byte, error)
func (CurrencyUnit) StringValue ¶
func (a CurrencyUnit) StringValue() string
func (*CurrencyUnit) UnmarshalJSON ¶
func (a *CurrencyUnit) UnmarshalJSON(b []byte) error
type DailyLiquidityForecast ¶ added in v0.7.4
type DailyLiquidityForecast struct { // Date The date for which this forecast was generated. Date types.Date `json:"daily_liquidity_forecast_date"` // Direction The direction for which this forecast was generated. Direction LightningPaymentDirection `json:"daily_liquidity_forecast_direction"` // Amount The value of the forecast. It represents the amount of msats that we think will be moved for that specified direction, for that node, on that date. Amount CurrencyAmount `json:"daily_liquidity_forecast_amount"` }
type DeclineToSignMessagesInput ¶
type DeclineToSignMessagesInput struct { // PayloadIds List of payload ids to decline to sign because validation failed. PayloadIds []string `json:"decline_to_sign_messages_input_payload_ids"` }
type DeclineToSignMessagesOutput ¶
type DeclineToSignMessagesOutput struct {
DeclinedPayloads []SignablePayload `json:"decline_to_sign_messages_output_declined_payloads"`
}
type DeleteApiTokenInput ¶
type DeleteApiTokenInput struct {
ApiTokenId string `json:"delete_api_token_input_api_token_id"`
}
type DeleteApiTokenOutput ¶
type DeleteApiTokenOutput struct {
Account types.EntityWrapper `json:"delete_api_token_output_account"`
}
type Deposit ¶
type Deposit struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"deposit_id"` // CreatedAt The date and time when this transaction was initiated. CreatedAt time.Time `json:"deposit_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"deposit_updated_at"` // Status The current status of this transaction. Status TransactionStatus `json:"deposit_status"` // ResolvedAt The date and time when this transaction was completed or failed. ResolvedAt *time.Time `json:"deposit_resolved_at"` // Amount The amount of money involved in this transaction. Amount CurrencyAmount `json:"deposit_amount"` // TransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network. TransactionHash *string `json:"deposit_transaction_hash"` // Fees The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin blockchain. Fees *CurrencyAmount `json:"deposit_fees"` // BlockHash The hash of the block that included this transaction. This will be null for unconfirmed transactions. BlockHash *string `json:"deposit_block_hash"` // BlockHeight The height of the block that included this transaction. This will be zero for unconfirmed transactions. BlockHeight int64 `json:"deposit_block_height"` // DestinationAddresses The Bitcoin blockchain addresses this transaction was sent to. DestinationAddresses []string `json:"deposit_destination_addresses"` // NumConfirmations The number of blockchain confirmations for this transaction in real time. NumConfirmations *int64 `json:"deposit_num_confirmations"` // Destination The recipient Lightspark node this deposit was sent to. Destination types.EntityWrapper `json:"deposit_destination"` // Typename The typename of the object Typename string `json:"__typename"` }
Deposit This object represents a Deposit made to a Lightspark node wallet. This operation occurs for any L1 funding transaction to the wallet. You can retrieve this object to receive detailed information about the deposit.
func (Deposit) GetAmount ¶
func (obj Deposit) GetAmount() CurrencyAmount
GetAmount The amount of money involved in this transaction.
func (Deposit) GetBlockHash ¶
GetBlockHash The hash of the block that included this transaction. This will be null for unconfirmed transactions.
func (Deposit) GetBlockHeight ¶
GetBlockHeight The height of the block that included this transaction. This will be zero for unconfirmed transactions.
func (Deposit) GetCreatedAt ¶
GetCreatedAt The date and time when the entity was first created.
func (Deposit) GetDestinationAddresses ¶
GetDestinationAddresses The Bitcoin blockchain addresses this transaction was sent to.
func (Deposit) GetFees ¶
func (obj Deposit) GetFees() *CurrencyAmount
GetFees The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin blockchain.
func (Deposit) GetId ¶
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (Deposit) GetNumConfirmations ¶
GetNumConfirmations The number of blockchain confirmations for this transaction in real time.
func (Deposit) GetResolvedAt ¶
GetResolvedAt The date and time when this transaction was completed or failed.
func (Deposit) GetStatus ¶
func (obj Deposit) GetStatus() TransactionStatus
GetStatus The current status of this transaction.
func (Deposit) GetTransactionHash ¶
GetTransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network.
func (Deposit) GetTypename ¶ added in v0.6.1
func (Deposit) GetUpdatedAt ¶
GetUpdatedAt The date and time when the entity was last updated.
type Entity ¶
type Entity interface { // GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. GetId() string // GetCreatedAt The date and time when the entity was first created. GetCreatedAt() time.Time // GetUpdatedAt The date and time when the entity was last updated. GetUpdatedAt() time.Time // GetTypename The typename of the object GetTypename() string }
Entity This interface is used by all the entities in the Lightspark system. It defines a few core fields that are available everywhere. Any object that implements this interface can be queried using the `entity` query and its ID.
func EntityUnmarshal ¶
type FeeEstimate ¶
type FeeEstimate struct { FeeFast CurrencyAmount `json:"fee_estimate_fee_fast"` FeeMin CurrencyAmount `json:"fee_estimate_fee_min"` }
FeeEstimate This object represents the estimated L1 transaction fees for the Bitcoin network. Fee estimates are separated by potential confirmation speeds for settlement.
type FundNodeInput ¶
type FundNodeOutput ¶
type FundNodeOutput struct {
Amount CurrencyAmount `json:"fund_node_output_amount"`
}
type GraphNode ¶
type GraphNode struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"graph_node_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"graph_node_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"graph_node_updated_at"` // Alias A name that identifies the node. It has no importance in terms of operating the node, it is just a way to identify and search for commercial services or popular nodes. This alias can be changed at any time by the node operator. Alias *string `json:"graph_node_alias"` // BitcoinNetwork The Bitcoin Network this node is deployed in. BitcoinNetwork BitcoinNetwork `json:"graph_node_bitcoin_network"` // Color A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It has no importance in terms of operating the node, it is just a way to visually differentiate nodes. That color can be changed at any time by the node operator. Color *string `json:"graph_node_color"` // Conductivity A summary metric used to capture how well positioned a node is to send, receive, or route transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be capital efficient. The value is an integer ranging between 0 and 10 (bounds included). Conductivity *int64 `json:"graph_node_conductivity"` // DisplayName The name of this node in the network. It will be the most human-readable option possible, depending on the data available for this node. DisplayName string `json:"graph_node_display_name"` // PublicKey The public key of this node. It acts as a unique identifier of this node in the Lightning Network. PublicKey *string `json:"graph_node_public_key"` // Typename The typename of the object Typename string `json:"__typename"` }
GraphNode This object represents a node that exists on the Lightning Network, including nodes not managed by Lightspark. You can retrieve this object to get publicly available information about any node on the Lightning Network.
func (GraphNode) GetAddresses ¶
func (obj GraphNode) GetAddresses(requester *requester.Requester, first *int64, types *[]NodeAddressType) (*NodeToAddressesConnection, error)
func (GraphNode) GetAlias ¶
GetAlias A name that identifies the node. It has no importance in terms of operating the node, it is just a way to identify and search for commercial services or popular nodes. This alias can be changed at any time by the node operator.
func (GraphNode) GetBitcoinNetwork ¶
func (obj GraphNode) GetBitcoinNetwork() BitcoinNetwork
GetBitcoinNetwork The Bitcoin Network this node is deployed in.
func (GraphNode) GetColor ¶
GetColor A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It has no importance in terms of operating the node, it is just a way to visually differentiate nodes. That color can be changed at any time by the node operator.
func (GraphNode) GetConductivity ¶
GetConductivity A summary metric used to capture how well positioned a node is to send, receive, or route transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
func (GraphNode) GetCreatedAt ¶
GetCreatedAt The date and time when the entity was first created.
func (GraphNode) GetDisplayName ¶
GetDisplayName The name of this node in the network. It will be the most human-readable option possible, depending on the data available for this node.
func (GraphNode) GetId ¶
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (GraphNode) GetPublicKey ¶
GetPublicKey The public key of this node. It acts as a unique identifier of this node in the Lightning Network.
func (GraphNode) GetTypename ¶ added in v0.6.1
func (GraphNode) GetUpdatedAt ¶
GetUpdatedAt The date and time when the entity was last updated.
type Hop ¶
type Hop struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"hop_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"hop_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"hop_updated_at"` // Destination The destination node of the hop. Destination *types.EntityWrapper `json:"hop_destination"` // Index The zero-based index position of this hop in the path Index int64 `json:"hop_index"` // PublicKey The public key of the node to which the hop is bound. PublicKey *string `json:"hop_public_key"` // AmountToForward The amount that is to be forwarded to the destination node. AmountToForward *CurrencyAmount `json:"hop_amount_to_forward"` // Fee The fees to be collected by the source node for forwarding the payment over the hop. Fee *CurrencyAmount `json:"hop_fee"` // ExpiryBlockHeight The block height at which an unsettled HTLC is considered expired. ExpiryBlockHeight *int64 `json:"hop_expiry_block_height"` // Typename The typename of the object Typename string `json:"__typename"` }
Hop This object represents a specific node that existed on a particular payment route. You can retrieve this object to get information about a node on a particular payment path and all payment-relevant information for that node.
func (Hop) GetCreatedAt ¶
GetCreatedAt The date and time when the entity was first created.
func (Hop) GetId ¶
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (Hop) GetTypename ¶ added in v0.6.1
func (Hop) GetUpdatedAt ¶
GetUpdatedAt The date and time when the entity was last updated.
type HtlcAttemptFailureCode ¶
type HtlcAttemptFailureCode int
HtlcAttemptFailureCode This is an enum representing a particular reason why an htlc sent over the Lightning Network may have failed.
const ( HtlcAttemptFailureCodeUndefined HtlcAttemptFailureCode = iota HtlcAttemptFailureCodeIncorrectOrUnknownPaymentDetails HtlcAttemptFailureCodeIncorrectPaymentAmount HtlcAttemptFailureCodeFinalIncorrectCltvExpiry HtlcAttemptFailureCodeFinalIncorrectHtlcAmount HtlcAttemptFailureCodeFinalExpiryTooSoon HtlcAttemptFailureCodeInvalidRealm HtlcAttemptFailureCodeExpiryTooSoon HtlcAttemptFailureCodeInvalidOnionVersion HtlcAttemptFailureCodeInvalidOnionHmac HtlcAttemptFailureCodeInvalidOnionKey HtlcAttemptFailureCodeAmountBelowMinimum HtlcAttemptFailureCodeFeeInsufficient HtlcAttemptFailureCodeIncorrectCltvExpiry HtlcAttemptFailureCodeChannelDisabled HtlcAttemptFailureCodeTemporaryChannelFailure HtlcAttemptFailureCodeRequiredNodeFeatureMissing HtlcAttemptFailureCodeRequiredChannelFeatureMissing HtlcAttemptFailureCodeUnknownNextPeer HtlcAttemptFailureCodeTemporaryNodeFailure HtlcAttemptFailureCodePermanentNodeFailure HtlcAttemptFailureCodePermanentChannelFailure HtlcAttemptFailureCodeExpiryTooFar HtlcAttemptFailureCodeMppTimeout HtlcAttemptFailureCodeInvalidOnionPayload HtlcAttemptFailureCodeInvalidOnionBlinding HtlcAttemptFailureCodeInternalFailure HtlcAttemptFailureCodeUnknownFailure HtlcAttemptFailureCodeUnreadableFailure )
func (HtlcAttemptFailureCode) MarshalJSON ¶
func (a HtlcAttemptFailureCode) MarshalJSON() ([]byte, error)
func (HtlcAttemptFailureCode) StringValue ¶
func (a HtlcAttemptFailureCode) StringValue() string
func (*HtlcAttemptFailureCode) UnmarshalJSON ¶
func (a *HtlcAttemptFailureCode) UnmarshalJSON(b []byte) error
type IdAndSignature ¶
type IncentivesIneligibilityReason ¶ added in v0.7.0
type IncentivesIneligibilityReason int
IncentivesIneligibilityReason Describes the reason for an invitation to not be eligible for incentives.
const ( IncentivesIneligibilityReasonUndefined IncentivesIneligibilityReason = iota // IncentivesIneligibilityReasonDisabled This invitation is not eligible for incentives because it has been created outside of the incentives flow. IncentivesIneligibilityReasonDisabled // IncentivesIneligibilityReasonSenderNotEligible This invitation is not eligible for incentives because the sender is not eligible. IncentivesIneligibilityReasonSenderNotEligible // IncentivesIneligibilityReasonReceiverNotEligible This invitation is not eligible for incentives because the receiver is not eligible. IncentivesIneligibilityReasonReceiverNotEligible // IncentivesIneligibilityReasonSendingVaspNotEligible This invitation is not eligible for incentives because the sending VASP is not part of the incentives program. IncentivesIneligibilityReasonSendingVaspNotEligible // IncentivesIneligibilityReasonReceivingVaspNotEligible This invitation is not eligible for incentives because the receiving VASP is not part of the incentives program. IncentivesIneligibilityReasonReceivingVaspNotEligible // IncentivesIneligibilityReasonNotCrossBorder This invitation is not eligible for incentives because the sender and receiver are in the same region. IncentivesIneligibilityReasonNotCrossBorder )
func (IncentivesIneligibilityReason) MarshalJSON ¶ added in v0.7.0
func (a IncentivesIneligibilityReason) MarshalJSON() ([]byte, error)
func (IncentivesIneligibilityReason) StringValue ¶ added in v0.7.0
func (a IncentivesIneligibilityReason) StringValue() string
func (*IncentivesIneligibilityReason) UnmarshalJSON ¶ added in v0.7.0
func (a *IncentivesIneligibilityReason) UnmarshalJSON(b []byte) error
type IncentivesStatus ¶ added in v0.7.0
type IncentivesStatus int
IncentivesStatus Describes the status of the incentives for this invitation.
const ( IncentivesStatusUndefined IncentivesStatus = iota // IncentivesStatusPending The invitation is eligible for incentives in its current state. When it is claimed, we will reassess. IncentivesStatusPending // IncentivesStatusValidated The incentives have been validated. IncentivesStatusValidated // IncentivesStatusIneligible This invitation is not eligible for incentives. A more detailed reason can be found in the `incentives_ineligibility_reason` field. IncentivesStatusIneligible )
func (IncentivesStatus) MarshalJSON ¶ added in v0.7.0
func (a IncentivesStatus) MarshalJSON() ([]byte, error)
func (IncentivesStatus) StringValue ¶ added in v0.7.0
func (a IncentivesStatus) StringValue() string
func (*IncentivesStatus) UnmarshalJSON ¶ added in v0.7.0
func (a *IncentivesStatus) UnmarshalJSON(b []byte) error
type IncomingPayment ¶
type IncomingPayment struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"incoming_payment_id"` // CreatedAt The date and time when this transaction was initiated. CreatedAt time.Time `json:"incoming_payment_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"incoming_payment_updated_at"` // Status The current status of this transaction. Status TransactionStatus `json:"incoming_payment_status"` // ResolvedAt The date and time when this transaction was completed or failed. ResolvedAt *time.Time `json:"incoming_payment_resolved_at"` // Amount The amount of money involved in this transaction. Amount CurrencyAmount `json:"incoming_payment_amount"` // TransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network. TransactionHash *string `json:"incoming_payment_transaction_hash"` // Destination The recipient Lightspark node this payment was sent to. Destination types.EntityWrapper `json:"incoming_payment_destination"` // PaymentRequest The optional payment request for this incoming payment, which will be null if the payment is sent through keysend. PaymentRequest *types.EntityWrapper `json:"incoming_payment_payment_request"` // UmaPostTransactionData The post transaction data which can be used in KYT payment registration. UmaPostTransactionData *[]PostTransactionData `json:"incoming_payment_uma_post_transaction_data"` // Typename The typename of the object Typename string `json:"__typename"` }
IncomingPayment This object represents any payment sent to a Lightspark node on the Lightning Network. You can retrieve this object to receive payment related information about a specific payment received by a Lightspark node.
func (IncomingPayment) GetAmount ¶
func (obj IncomingPayment) GetAmount() CurrencyAmount
GetAmount The amount of money involved in this transaction.
func (IncomingPayment) GetAttempts ¶
func (obj IncomingPayment) GetAttempts(requester *requester.Requester, first *int64, statuses *[]IncomingPaymentAttemptStatus, after *string) (*IncomingPaymentToAttemptsConnection, error)
func (IncomingPayment) GetCreatedAt ¶
func (obj IncomingPayment) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (IncomingPayment) GetId ¶
func (obj IncomingPayment) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (IncomingPayment) GetResolvedAt ¶
func (obj IncomingPayment) GetResolvedAt() *time.Time
GetResolvedAt The date and time when this transaction was completed or failed.
func (IncomingPayment) GetStatus ¶
func (obj IncomingPayment) GetStatus() TransactionStatus
GetStatus The current status of this transaction.
func (IncomingPayment) GetTransactionHash ¶
func (obj IncomingPayment) GetTransactionHash() *string
GetTransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network.
func (IncomingPayment) GetTypename ¶ added in v0.6.1
func (obj IncomingPayment) GetTypename() string
func (IncomingPayment) GetUpdatedAt ¶
func (obj IncomingPayment) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type IncomingPaymentAttempt ¶
type IncomingPaymentAttempt struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"incoming_payment_attempt_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"incoming_payment_attempt_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"incoming_payment_attempt_updated_at"` // Status The status of the incoming payment attempt. Status IncomingPaymentAttemptStatus `json:"incoming_payment_attempt_status"` // ResolvedAt The time the incoming payment attempt failed or succeeded. ResolvedAt *time.Time `json:"incoming_payment_attempt_resolved_at"` // Amount The total amount of that was attempted to send. Amount CurrencyAmount `json:"incoming_payment_attempt_amount"` // Channel The channel this attempt was made on. Channel types.EntityWrapper `json:"incoming_payment_attempt_channel"` // Typename The typename of the object Typename string `json:"__typename"` }
IncomingPaymentAttempt This object represents any attempted payment sent to a Lightspark node on the Lightning Network. You can retrieve this object to receive payment related information about a specific incoming payment attempt.
func (IncomingPaymentAttempt) GetCreatedAt ¶
func (obj IncomingPaymentAttempt) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (IncomingPaymentAttempt) GetId ¶
func (obj IncomingPaymentAttempt) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (IncomingPaymentAttempt) GetTypename ¶ added in v0.6.1
func (obj IncomingPaymentAttempt) GetTypename() string
func (IncomingPaymentAttempt) GetUpdatedAt ¶
func (obj IncomingPaymentAttempt) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type IncomingPaymentAttemptStatus ¶
type IncomingPaymentAttemptStatus int
IncomingPaymentAttemptStatus This is an enum that enumerates all potential statuses for an incoming payment attempt.
const ( IncomingPaymentAttemptStatusUndefined IncomingPaymentAttemptStatus = iota IncomingPaymentAttemptStatusAccepted IncomingPaymentAttemptStatusSettled IncomingPaymentAttemptStatusCanceled IncomingPaymentAttemptStatusUnknown )
func (IncomingPaymentAttemptStatus) MarshalJSON ¶
func (a IncomingPaymentAttemptStatus) MarshalJSON() ([]byte, error)
func (IncomingPaymentAttemptStatus) StringValue ¶
func (a IncomingPaymentAttemptStatus) StringValue() string
func (*IncomingPaymentAttemptStatus) UnmarshalJSON ¶
func (a *IncomingPaymentAttemptStatus) UnmarshalJSON(b []byte) error
type IncomingPaymentToAttemptsConnection ¶
type IncomingPaymentToAttemptsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"incoming_payment_to_attempts_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"incoming_payment_to_attempts_connection_page_info"` // Entities The incoming payment attempts for the current page of this connection. Entities []IncomingPaymentAttempt `json:"incoming_payment_to_attempts_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
IncomingPaymentToAttemptsConnection The connection from incoming payment to all attempts.
func (IncomingPaymentToAttemptsConnection) GetCount ¶
func (obj IncomingPaymentToAttemptsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (IncomingPaymentToAttemptsConnection) GetPageInfo ¶
func (obj IncomingPaymentToAttemptsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (IncomingPaymentToAttemptsConnection) GetTypename ¶ added in v0.6.1
func (obj IncomingPaymentToAttemptsConnection) GetTypename() string
type Invoice ¶
type Invoice struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"invoice_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"invoice_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"invoice_updated_at"` // Data The details of the invoice. Data InvoiceData `json:"invoice_data"` // Status The status of the payment request. Status PaymentRequestStatus `json:"invoice_status"` // AmountPaid The total amount that has been paid to this invoice. AmountPaid *CurrencyAmount `json:"invoice_amount_paid"` // Typename The typename of the object Typename string `json:"__typename"` }
Invoice This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) created by a Lightspark Node. You can retrieve this object to receive relevant payment information for a specific invoice generated by a Lightspark node.
func (Invoice) GetCreatedAt ¶
GetCreatedAt The date and time when the entity was first created.
func (Invoice) GetData ¶
func (obj Invoice) GetData() PaymentRequestData
GetData The details of the payment request.
func (Invoice) GetId ¶
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (Invoice) GetStatus ¶
func (obj Invoice) GetStatus() PaymentRequestStatus
GetStatus The status of the payment request.
func (Invoice) GetTypename ¶ added in v0.6.1
func (Invoice) GetUpdatedAt ¶
GetUpdatedAt The date and time when the entity was last updated.
type InvoiceData ¶
type InvoiceData struct { EncodedPaymentRequest string `json:"invoice_data_encoded_payment_request"` BitcoinNetwork BitcoinNetwork `json:"invoice_data_bitcoin_network"` // PaymentHash The payment hash of this invoice. PaymentHash string `json:"invoice_data_payment_hash"` // Amount The requested amount in this invoice. If it is equal to 0, the sender should choose the amount to send. Amount CurrencyAmount `json:"invoice_data_amount"` // CreatedAt The date and time when this invoice was created. CreatedAt time.Time `json:"invoice_data_created_at"` // ExpiresAt The date and time when this invoice will expire. ExpiresAt time.Time `json:"invoice_data_expires_at"` // Memo A short, UTF-8 encoded, description of the purpose of this invoice. Memo *string `json:"invoice_data_memo"` // Destination The lightning node that will be paid when fulfilling this invoice. Destination Node `json:"invoice_data_destination"` // Typename The typename of the object Typename string `json:"__typename"` }
InvoiceData This object represents the data associated with a BOLT #11 invoice. You can retrieve this object to receive the relevant data associated with a specific invoice.
func (InvoiceData) GetBitcoinNetwork ¶
func (obj InvoiceData) GetBitcoinNetwork() BitcoinNetwork
func (InvoiceData) GetEncodedPaymentRequest ¶
func (obj InvoiceData) GetEncodedPaymentRequest() string
func (InvoiceData) GetTypename ¶ added in v0.6.1
func (obj InvoiceData) GetTypename() string
func (*InvoiceData) UnmarshalJSON ¶
func (data *InvoiceData) UnmarshalJSON(dataBytes []byte) error
type InvoiceDataJSON ¶
type InvoiceDataJSON struct { EncodedPaymentRequest string `json:"invoice_data_encoded_payment_request"` BitcoinNetwork BitcoinNetwork `json:"invoice_data_bitcoin_network"` // PaymentHash The payment hash of this invoice. PaymentHash string `json:"invoice_data_payment_hash"` // Amount The requested amount in this invoice. If it is equal to 0, the sender should choose the amount to send. Amount CurrencyAmount `json:"invoice_data_amount"` // CreatedAt The date and time when this invoice was created. CreatedAt time.Time `json:"invoice_data_created_at"` // ExpiresAt The date and time when this invoice will expire. ExpiresAt time.Time `json:"invoice_data_expires_at"` // Memo A short, UTF-8 encoded, description of the purpose of this invoice. Memo *string `json:"invoice_data_memo"` // Destination The lightning node that will be paid when fulfilling this invoice. Destination map[string]interface{} `json:"invoice_data_destination"` // Typename The typename of the object Typename string `json:"__typename"` }
type InvoiceType ¶
type InvoiceType int
InvoiceType This is an enum for potential invoice types.
const ( InvoiceTypeUndefined InvoiceType = iota // InvoiceTypeStandard A standard Bolt 11 invoice. InvoiceTypeStandard // InvoiceTypeAmp An AMP (Atomic Multi-path Payment) invoice. InvoiceTypeAmp )
func (InvoiceType) MarshalJSON ¶
func (a InvoiceType) MarshalJSON() ([]byte, error)
func (InvoiceType) StringValue ¶
func (a InvoiceType) StringValue() string
func (*InvoiceType) UnmarshalJSON ¶
func (a *InvoiceType) UnmarshalJSON(b []byte) error
type LightningFeeEstimateForInvoiceInput ¶
type LightningFeeEstimateForInvoiceInput struct { // NodeId The node from where you want to send the payment. NodeId string `json:"lightning_fee_estimate_for_invoice_input_node_id"` // EncodedPaymentRequest The invoice you want to pay (as defined by the BOLT11 standard). EncodedPaymentRequest string `json:"lightning_fee_estimate_for_invoice_input_encoded_payment_request"` // AmountMsats If the invoice does not specify a payment amount, then the amount that you wish to pay, expressed in msats. AmountMsats *int64 `json:"lightning_fee_estimate_for_invoice_input_amount_msats"` }
type LightningFeeEstimateForNodeInput ¶
type LightningFeeEstimateForNodeInput struct { // NodeId The node from where you want to send the payment. NodeId string `json:"lightning_fee_estimate_for_node_input_node_id"` // DestinationNodePublicKey The public key of the node that you want to pay. DestinationNodePublicKey string `json:"lightning_fee_estimate_for_node_input_destination_node_public_key"` // AmountMsats The payment amount expressed in msats. AmountMsats int64 `json:"lightning_fee_estimate_for_node_input_amount_msats"` }
type LightningFeeEstimateOutput ¶
type LightningFeeEstimateOutput struct { // FeeEstimate The estimated fees for the payment. FeeEstimate CurrencyAmount `json:"lightning_fee_estimate_output_fee_estimate"` }
type LightningPaymentDirection ¶ added in v0.7.4
type LightningPaymentDirection int
LightningPaymentDirection This is an enum identifying the payment direction.
const ( LightningPaymentDirectionUndefined LightningPaymentDirection = iota // LightningPaymentDirectionIncoming A payment that is received by the node. LightningPaymentDirectionIncoming // LightningPaymentDirectionOutgoing A payment that is sent by the node. LightningPaymentDirectionOutgoing )
func (LightningPaymentDirection) MarshalJSON ¶ added in v0.7.4
func (a LightningPaymentDirection) MarshalJSON() ([]byte, error)
func (LightningPaymentDirection) StringValue ¶ added in v0.7.4
func (a LightningPaymentDirection) StringValue() string
func (*LightningPaymentDirection) UnmarshalJSON ¶ added in v0.7.4
func (a *LightningPaymentDirection) UnmarshalJSON(b []byte) error
type LightningTransaction ¶
type LightningTransaction interface { Transaction Entity }
LightningTransaction This is an object representing a transaction made over the Lightning Network. You can retrieve this object to receive information about a specific transaction made over Lightning for a Lightspark node.
func LightningTransactionUnmarshal ¶
func LightningTransactionUnmarshal(data map[string]interface{}) (LightningTransaction, error)
type LightsparkNode ¶
type LightsparkNode interface { Node Entity // GetOwnerId The owner of this LightsparkNode. GetOwnerId() types.EntityWrapper // GetStatus The current status of this node. GetStatus() *LightsparkNodeStatus // GetTotalBalance The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node. // Deprecated: Use `balances` instead. GetTotalBalance() *CurrencyAmount // GetTotalLocalBalance The total sum of the channel balances (online and offline) on this node. // Deprecated: Use `balances` instead. GetTotalLocalBalance() *CurrencyAmount // GetLocalBalance The sum of the channel balances (online only) that are available to send on this node. // Deprecated: Use `balances` instead. GetLocalBalance() *CurrencyAmount // GetRemoteBalance The sum of the channel balances that are available to receive on this node. // Deprecated: Use `balances` instead. GetRemoteBalance() *CurrencyAmount // GetBlockchainBalance The details of the balance of this node on the Bitcoin Network. // Deprecated: Use `balances` instead. GetBlockchainBalance() *BlockchainBalance // GetUmaPrescreeningUtxos The utxos of the channels that are connected to this node. This is used in uma flow for pre-screening. GetUmaPrescreeningUtxos() []string // GetBalances The balances that describe the funds in this node. GetBalances() *Balances }
LightsparkNode This is an object representing a node managed by Lightspark and owned by the current connected account. This object contains information about the node’s configuration, state, and metadata.
func LightsparkNodeUnmarshal ¶
func LightsparkNodeUnmarshal(data map[string]interface{}) (LightsparkNode, error)
type LightsparkNodeOwner ¶
type LightsparkNodeOwner interface { Entity }
LightsparkNodeOwner This is an object representing the owner of a LightsparkNode.
func LightsparkNodeOwnerUnmarshal ¶
func LightsparkNodeOwnerUnmarshal(data map[string]interface{}) (LightsparkNodeOwner, error)
type LightsparkNodeStatus ¶
type LightsparkNodeStatus int
const ( LightsparkNodeStatusUndefined LightsparkNodeStatus = iota LightsparkNodeStatusCreated LightsparkNodeStatusDeployed LightsparkNodeStatusStarted LightsparkNodeStatusSyncing LightsparkNodeStatusReady LightsparkNodeStatusStopped LightsparkNodeStatusTerminated LightsparkNodeStatusTerminating LightsparkNodeStatusWalletLocked LightsparkNodeStatusFailedToDeploy )
func (LightsparkNodeStatus) MarshalJSON ¶
func (a LightsparkNodeStatus) MarshalJSON() ([]byte, error)
func (LightsparkNodeStatus) StringValue ¶
func (a LightsparkNodeStatus) StringValue() string
func (*LightsparkNodeStatus) UnmarshalJSON ¶
func (a *LightsparkNodeStatus) UnmarshalJSON(b []byte) error
type LightsparkNodeToChannelsConnection ¶
type LightsparkNodeToChannelsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"lightspark_node_to_channels_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"lightspark_node_to_channels_connection_page_info"` // Entities The channels for the current page of this connection. Entities []Channel `json:"lightspark_node_to_channels_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
func (LightsparkNodeToChannelsConnection) GetCount ¶
func (obj LightsparkNodeToChannelsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (LightsparkNodeToChannelsConnection) GetPageInfo ¶
func (obj LightsparkNodeToChannelsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (LightsparkNodeToChannelsConnection) GetTypename ¶ added in v0.6.1
func (obj LightsparkNodeToChannelsConnection) GetTypename() string
type LightsparkNodeToDailyLiquidityForecastsConnection ¶ added in v0.7.4
type LightsparkNodeToDailyLiquidityForecastsConnection struct { FromDate types.Date `json:"lightspark_node_to_daily_liquidity_forecasts_connection_from_date"` ToDate types.Date `json:"lightspark_node_to_daily_liquidity_forecasts_connection_to_date"` Direction LightningPaymentDirection `json:"lightspark_node_to_daily_liquidity_forecasts_connection_direction"` // Entities The daily liquidity forecasts for the current page of this connection. Entities []DailyLiquidityForecast `json:"lightspark_node_to_daily_liquidity_forecasts_connection_entities"` }
type LightsparkNodeWithOSK ¶
type LightsparkNodeWithOSK struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"lightspark_node_with_o_s_k_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"lightspark_node_with_o_s_k_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"lightspark_node_with_o_s_k_updated_at"` // Alias A name that identifies the node. It has no importance in terms of operating the node, it is just a way to identify and search for commercial services or popular nodes. This alias can be changed at any time by the node operator. Alias *string `json:"lightspark_node_with_o_s_k_alias"` // BitcoinNetwork The Bitcoin Network this node is deployed in. BitcoinNetwork BitcoinNetwork `json:"lightspark_node_with_o_s_k_bitcoin_network"` // Color A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It has no importance in terms of operating the node, it is just a way to visually differentiate nodes. That color can be changed at any time by the node operator. Color *string `json:"lightspark_node_with_o_s_k_color"` // Conductivity A summary metric used to capture how well positioned a node is to send, receive, or route transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be capital efficient. The value is an integer ranging between 0 and 10 (bounds included). Conductivity *int64 `json:"lightspark_node_with_o_s_k_conductivity"` // DisplayName The name of this node in the network. It will be the most human-readable option possible, depending on the data available for this node. DisplayName string `json:"lightspark_node_with_o_s_k_display_name"` // PublicKey The public key of this node. It acts as a unique identifier of this node in the Lightning Network. PublicKey *string `json:"lightspark_node_with_o_s_k_public_key"` // Owner The owner of this LightsparkNode. Owner types.EntityWrapper `json:"lightspark_node_with_o_s_k_owner"` // Status The current status of this node. Status *LightsparkNodeStatus `json:"lightspark_node_with_o_s_k_status"` // TotalBalance The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node. // Deprecated: Use `balances` instead. TotalBalance *CurrencyAmount `json:"lightspark_node_with_o_s_k_total_balance"` // TotalLocalBalance The total sum of the channel balances (online and offline) on this node. // Deprecated: Use `balances` instead. TotalLocalBalance *CurrencyAmount `json:"lightspark_node_with_o_s_k_total_local_balance"` // LocalBalance The sum of the channel balances (online only) that are available to send on this node. // Deprecated: Use `balances` instead. LocalBalance *CurrencyAmount `json:"lightspark_node_with_o_s_k_local_balance"` // RemoteBalance The sum of the channel balances that are available to receive on this node. // Deprecated: Use `balances` instead. RemoteBalance *CurrencyAmount `json:"lightspark_node_with_o_s_k_remote_balance"` // BlockchainBalance The details of the balance of this node on the Bitcoin Network. // Deprecated: Use `balances` instead. BlockchainBalance *BlockchainBalance `json:"lightspark_node_with_o_s_k_blockchain_balance"` // UmaPrescreeningUtxos The utxos of the channels that are connected to this node. This is used in uma flow for pre-screening. UmaPrescreeningUtxos []string `json:"lightspark_node_with_o_s_k_uma_prescreening_utxos"` // Balances The balances that describe the funds in this node. Balances *Balances `json:"lightspark_node_with_o_s_k_balances"` // EncryptedSigningPrivateKey The private key client is using to sign a GraphQL request which will be verified at server side. EncryptedSigningPrivateKey *Secret `json:"lightspark_node_with_o_s_k_encrypted_signing_private_key"` // Typename The typename of the object Typename string `json:"__typename"` }
LightsparkNodeWithOSK This is a Lightspark node with OSK.
func (LightsparkNodeWithOSK) GetAddresses ¶
func (obj LightsparkNodeWithOSK) GetAddresses(requester *requester.Requester, first *int64, types *[]NodeAddressType) (*NodeToAddressesConnection, error)
func (LightsparkNodeWithOSK) GetAlias ¶
func (obj LightsparkNodeWithOSK) GetAlias() *string
GetAlias A name that identifies the node. It has no importance in terms of operating the node, it is just a way to identify and search for commercial services or popular nodes. This alias can be changed at any time by the node operator.
func (LightsparkNodeWithOSK) GetBalances ¶ added in v0.6.0
func (obj LightsparkNodeWithOSK) GetBalances() *Balances
GetBalances The balances that describe the funds in this node.
func (LightsparkNodeWithOSK) GetBitcoinNetwork ¶
func (obj LightsparkNodeWithOSK) GetBitcoinNetwork() BitcoinNetwork
GetBitcoinNetwork The Bitcoin Network this node is deployed in.
func (LightsparkNodeWithOSK) GetBlockchainBalance ¶
func (obj LightsparkNodeWithOSK) GetBlockchainBalance() *BlockchainBalance
GetBlockchainBalance The details of the balance of this node on the Bitcoin Network. Deprecated: Use `balances` instead.
func (LightsparkNodeWithOSK) GetChannels ¶
func (obj LightsparkNodeWithOSK) GetChannels(requester *requester.Requester, first *int64, statuses *[]ChannelStatus, after *string) (*LightsparkNodeToChannelsConnection, error)
func (LightsparkNodeWithOSK) GetColor ¶
func (obj LightsparkNodeWithOSK) GetColor() *string
GetColor A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It has no importance in terms of operating the node, it is just a way to visually differentiate nodes. That color can be changed at any time by the node operator.
func (LightsparkNodeWithOSK) GetConductivity ¶
func (obj LightsparkNodeWithOSK) GetConductivity() *int64
GetConductivity A summary metric used to capture how well positioned a node is to send, receive, or route transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
func (LightsparkNodeWithOSK) GetCreatedAt ¶
func (obj LightsparkNodeWithOSK) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (LightsparkNodeWithOSK) GetDailyLiquidityForecasts ¶ added in v0.7.4
func (obj LightsparkNodeWithOSK) GetDailyLiquidityForecasts(requester *requester.Requester, fromDate types.Date, toDate types.Date, direction LightningPaymentDirection) (*LightsparkNodeToDailyLiquidityForecastsConnection, error)
func (LightsparkNodeWithOSK) GetDisplayName ¶
func (obj LightsparkNodeWithOSK) GetDisplayName() string
GetDisplayName The name of this node in the network. It will be the most human-readable option possible, depending on the data available for this node.
func (LightsparkNodeWithOSK) GetId ¶
func (obj LightsparkNodeWithOSK) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (LightsparkNodeWithOSK) GetLocalBalance ¶
func (obj LightsparkNodeWithOSK) GetLocalBalance() *CurrencyAmount
GetLocalBalance The sum of the channel balances (online only) that are available to send on this node. Deprecated: Use `balances` instead.
func (LightsparkNodeWithOSK) GetOwnerId ¶
func (obj LightsparkNodeWithOSK) GetOwnerId() types.EntityWrapper
GetOwnerId The owner of this LightsparkNode.
func (LightsparkNodeWithOSK) GetPublicKey ¶
func (obj LightsparkNodeWithOSK) GetPublicKey() *string
GetPublicKey The public key of this node. It acts as a unique identifier of this node in the Lightning Network.
func (LightsparkNodeWithOSK) GetRemoteBalance ¶
func (obj LightsparkNodeWithOSK) GetRemoteBalance() *CurrencyAmount
GetRemoteBalance The sum of the channel balances that are available to receive on this node. Deprecated: Use `balances` instead.
func (LightsparkNodeWithOSK) GetStatus ¶
func (obj LightsparkNodeWithOSK) GetStatus() *LightsparkNodeStatus
GetStatus The current status of this node.
func (LightsparkNodeWithOSK) GetTotalBalance ¶
func (obj LightsparkNodeWithOSK) GetTotalBalance() *CurrencyAmount
GetTotalBalance The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node. Deprecated: Use `balances` instead.
func (LightsparkNodeWithOSK) GetTotalLocalBalance ¶
func (obj LightsparkNodeWithOSK) GetTotalLocalBalance() *CurrencyAmount
GetTotalLocalBalance The total sum of the channel balances (online and offline) on this node. Deprecated: Use `balances` instead.
func (LightsparkNodeWithOSK) GetTypename ¶ added in v0.6.1
func (obj LightsparkNodeWithOSK) GetTypename() string
func (LightsparkNodeWithOSK) GetUmaPrescreeningUtxos ¶
func (obj LightsparkNodeWithOSK) GetUmaPrescreeningUtxos() []string
GetUmaPrescreeningUtxos The utxos of the channels that are connected to this node. This is used in uma flow for pre-screening.
func (LightsparkNodeWithOSK) GetUpdatedAt ¶
func (obj LightsparkNodeWithOSK) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type LightsparkNodeWithRemoteSigning ¶
type LightsparkNodeWithRemoteSigning struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"lightspark_node_with_remote_signing_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"lightspark_node_with_remote_signing_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"lightspark_node_with_remote_signing_updated_at"` // Alias A name that identifies the node. It has no importance in terms of operating the node, it is just a way to identify and search for commercial services or popular nodes. This alias can be changed at any time by the node operator. Alias *string `json:"lightspark_node_with_remote_signing_alias"` // BitcoinNetwork The Bitcoin Network this node is deployed in. BitcoinNetwork BitcoinNetwork `json:"lightspark_node_with_remote_signing_bitcoin_network"` // Color A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It has no importance in terms of operating the node, it is just a way to visually differentiate nodes. That color can be changed at any time by the node operator. Color *string `json:"lightspark_node_with_remote_signing_color"` // Conductivity A summary metric used to capture how well positioned a node is to send, receive, or route transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be capital efficient. The value is an integer ranging between 0 and 10 (bounds included). Conductivity *int64 `json:"lightspark_node_with_remote_signing_conductivity"` // DisplayName The name of this node in the network. It will be the most human-readable option possible, depending on the data available for this node. DisplayName string `json:"lightspark_node_with_remote_signing_display_name"` // PublicKey The public key of this node. It acts as a unique identifier of this node in the Lightning Network. PublicKey *string `json:"lightspark_node_with_remote_signing_public_key"` // Owner The owner of this LightsparkNode. Owner types.EntityWrapper `json:"lightspark_node_with_remote_signing_owner"` // Status The current status of this node. Status *LightsparkNodeStatus `json:"lightspark_node_with_remote_signing_status"` // TotalBalance The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node. // Deprecated: Use `balances` instead. TotalBalance *CurrencyAmount `json:"lightspark_node_with_remote_signing_total_balance"` // TotalLocalBalance The total sum of the channel balances (online and offline) on this node. // Deprecated: Use `balances` instead. TotalLocalBalance *CurrencyAmount `json:"lightspark_node_with_remote_signing_total_local_balance"` // LocalBalance The sum of the channel balances (online only) that are available to send on this node. // Deprecated: Use `balances` instead. LocalBalance *CurrencyAmount `json:"lightspark_node_with_remote_signing_local_balance"` // RemoteBalance The sum of the channel balances that are available to receive on this node. // Deprecated: Use `balances` instead. RemoteBalance *CurrencyAmount `json:"lightspark_node_with_remote_signing_remote_balance"` // BlockchainBalance The details of the balance of this node on the Bitcoin Network. // Deprecated: Use `balances` instead. BlockchainBalance *BlockchainBalance `json:"lightspark_node_with_remote_signing_blockchain_balance"` // UmaPrescreeningUtxos The utxos of the channels that are connected to this node. This is used in uma flow for pre-screening. UmaPrescreeningUtxos []string `json:"lightspark_node_with_remote_signing_uma_prescreening_utxos"` // Balances The balances that describe the funds in this node. Balances *Balances `json:"lightspark_node_with_remote_signing_balances"` // Typename The typename of the object Typename string `json:"__typename"` }
LightsparkNodeWithRemoteSigning This is a Lightspark node with remote signing.
func (LightsparkNodeWithRemoteSigning) GetAddresses ¶
func (obj LightsparkNodeWithRemoteSigning) GetAddresses(requester *requester.Requester, first *int64, types *[]NodeAddressType) (*NodeToAddressesConnection, error)
func (LightsparkNodeWithRemoteSigning) GetAlias ¶
func (obj LightsparkNodeWithRemoteSigning) GetAlias() *string
GetAlias A name that identifies the node. It has no importance in terms of operating the node, it is just a way to identify and search for commercial services or popular nodes. This alias can be changed at any time by the node operator.
func (LightsparkNodeWithRemoteSigning) GetBalances ¶ added in v0.6.0
func (obj LightsparkNodeWithRemoteSigning) GetBalances() *Balances
GetBalances The balances that describe the funds in this node.
func (LightsparkNodeWithRemoteSigning) GetBitcoinNetwork ¶
func (obj LightsparkNodeWithRemoteSigning) GetBitcoinNetwork() BitcoinNetwork
GetBitcoinNetwork The Bitcoin Network this node is deployed in.
func (LightsparkNodeWithRemoteSigning) GetBlockchainBalance ¶
func (obj LightsparkNodeWithRemoteSigning) GetBlockchainBalance() *BlockchainBalance
GetBlockchainBalance The details of the balance of this node on the Bitcoin Network. Deprecated: Use `balances` instead.
func (LightsparkNodeWithRemoteSigning) GetChannels ¶
func (obj LightsparkNodeWithRemoteSigning) GetChannels(requester *requester.Requester, first *int64, statuses *[]ChannelStatus, after *string) (*LightsparkNodeToChannelsConnection, error)
func (LightsparkNodeWithRemoteSigning) GetColor ¶
func (obj LightsparkNodeWithRemoteSigning) GetColor() *string
GetColor A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It has no importance in terms of operating the node, it is just a way to visually differentiate nodes. That color can be changed at any time by the node operator.
func (LightsparkNodeWithRemoteSigning) GetConductivity ¶
func (obj LightsparkNodeWithRemoteSigning) GetConductivity() *int64
GetConductivity A summary metric used to capture how well positioned a node is to send, receive, or route transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
func (LightsparkNodeWithRemoteSigning) GetCreatedAt ¶
func (obj LightsparkNodeWithRemoteSigning) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (LightsparkNodeWithRemoteSigning) GetDailyLiquidityForecasts ¶ added in v0.7.4
func (obj LightsparkNodeWithRemoteSigning) GetDailyLiquidityForecasts(requester *requester.Requester, fromDate types.Date, toDate types.Date, direction LightningPaymentDirection) (*LightsparkNodeToDailyLiquidityForecastsConnection, error)
func (LightsparkNodeWithRemoteSigning) GetDisplayName ¶
func (obj LightsparkNodeWithRemoteSigning) GetDisplayName() string
GetDisplayName The name of this node in the network. It will be the most human-readable option possible, depending on the data available for this node.
func (LightsparkNodeWithRemoteSigning) GetId ¶
func (obj LightsparkNodeWithRemoteSigning) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (LightsparkNodeWithRemoteSigning) GetLocalBalance ¶
func (obj LightsparkNodeWithRemoteSigning) GetLocalBalance() *CurrencyAmount
GetLocalBalance The sum of the channel balances (online only) that are available to send on this node. Deprecated: Use `balances` instead.
func (LightsparkNodeWithRemoteSigning) GetOwnerId ¶
func (obj LightsparkNodeWithRemoteSigning) GetOwnerId() types.EntityWrapper
GetOwnerId The owner of this LightsparkNode.
func (LightsparkNodeWithRemoteSigning) GetPublicKey ¶
func (obj LightsparkNodeWithRemoteSigning) GetPublicKey() *string
GetPublicKey The public key of this node. It acts as a unique identifier of this node in the Lightning Network.
func (LightsparkNodeWithRemoteSigning) GetRemoteBalance ¶
func (obj LightsparkNodeWithRemoteSigning) GetRemoteBalance() *CurrencyAmount
GetRemoteBalance The sum of the channel balances that are available to receive on this node. Deprecated: Use `balances` instead.
func (LightsparkNodeWithRemoteSigning) GetStatus ¶
func (obj LightsparkNodeWithRemoteSigning) GetStatus() *LightsparkNodeStatus
GetStatus The current status of this node.
func (LightsparkNodeWithRemoteSigning) GetTotalBalance ¶
func (obj LightsparkNodeWithRemoteSigning) GetTotalBalance() *CurrencyAmount
GetTotalBalance The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node. Deprecated: Use `balances` instead.
func (LightsparkNodeWithRemoteSigning) GetTotalLocalBalance ¶
func (obj LightsparkNodeWithRemoteSigning) GetTotalLocalBalance() *CurrencyAmount
GetTotalLocalBalance The total sum of the channel balances (online and offline) on this node. Deprecated: Use `balances` instead.
func (LightsparkNodeWithRemoteSigning) GetTypename ¶ added in v0.6.1
func (obj LightsparkNodeWithRemoteSigning) GetTypename() string
func (LightsparkNodeWithRemoteSigning) GetUmaPrescreeningUtxos ¶
func (obj LightsparkNodeWithRemoteSigning) GetUmaPrescreeningUtxos() []string
GetUmaPrescreeningUtxos The utxos of the channels that are connected to this node. This is used in uma flow for pre-screening.
func (LightsparkNodeWithRemoteSigning) GetUpdatedAt ¶
func (obj LightsparkNodeWithRemoteSigning) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type Node ¶
type Node interface { Entity // GetAlias A name that identifies the node. It has no importance in terms of operating the node, it is just a way to identify and search for commercial services or popular nodes. This alias can be changed at any time by the node operator. GetAlias() *string // GetBitcoinNetwork The Bitcoin Network this node is deployed in. GetBitcoinNetwork() BitcoinNetwork // GetColor A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It has no importance in terms of operating the node, it is just a way to visually differentiate nodes. That color can be changed at any time by the node operator. GetColor() *string // GetConductivity A summary metric used to capture how well positioned a node is to send, receive, or route transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be capital efficient. The value is an integer ranging between 0 and 10 (bounds included). GetConductivity() *int64 // GetDisplayName The name of this node in the network. It will be the most human-readable option possible, depending on the data available for this node. GetDisplayName() string // GetPublicKey The public key of this node. It acts as a unique identifier of this node in the Lightning Network. GetPublicKey() *string }
Node This object is an interface representing a Lightning Node on the Lightning Network, and could either be a Lightspark node or a node managed by a third party.
func NodeUnmarshal ¶
type NodeAddress ¶
type NodeAddress struct { // Address The string representation of the address. Address string `json:"node_address_address"` // Typex The type, or protocol, of this address. Typex NodeAddressType `json:"node_address_type"` }
NodeAddress This object represents the address of a node on the Lightning Network.
type NodeAddressType ¶
type NodeAddressType int
NodeAddressType This is an enum of the potential types of addresses that a node on the Lightning Network can have.
const ( NodeAddressTypeUndefined NodeAddressType = iota NodeAddressTypeIpv4 NodeAddressTypeIpv6 NodeAddressTypeTor )
func (NodeAddressType) MarshalJSON ¶
func (a NodeAddressType) MarshalJSON() ([]byte, error)
func (NodeAddressType) StringValue ¶
func (a NodeAddressType) StringValue() string
func (*NodeAddressType) UnmarshalJSON ¶
func (a *NodeAddressType) UnmarshalJSON(b []byte) error
type NodeToAddressesConnection ¶
type NodeToAddressesConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"node_to_addresses_connection_count"` // Entities The addresses for the current page of this connection. Entities []NodeAddress `json:"node_to_addresses_connection_entities"` }
NodeToAddressesConnection A connection between a node and the addresses it has announced for itself on Lightning Network.
type OnChainTransaction ¶
type OnChainTransaction interface { Transaction Entity // GetFees The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin blockchain. GetFees() *CurrencyAmount // GetBlockHash The hash of the block that included this transaction. This will be null for unconfirmed transactions. GetBlockHash() *string // GetBlockHeight The height of the block that included this transaction. This will be zero for unconfirmed transactions. GetBlockHeight() int64 // GetDestinationAddresses The Bitcoin blockchain addresses this transaction was sent to. GetDestinationAddresses() []string // GetNumConfirmations The number of blockchain confirmations for this transaction in real time. GetNumConfirmations() *int64 }
OnChainTransaction This object represents an L1 transaction that occurred on the Bitcoin Network. You can retrieve this object to receive information about a specific on-chain transaction made on the Lightning Network associated with your Lightspark Node.
func OnChainTransactionUnmarshal ¶
func OnChainTransactionUnmarshal(data map[string]interface{}) (OnChainTransaction, error)
type OutgoingPayment ¶
type OutgoingPayment struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"outgoing_payment_id"` // CreatedAt The date and time when this transaction was initiated. CreatedAt time.Time `json:"outgoing_payment_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"outgoing_payment_updated_at"` // Status The current status of this transaction. Status TransactionStatus `json:"outgoing_payment_status"` // ResolvedAt The date and time when this transaction was completed or failed. ResolvedAt *time.Time `json:"outgoing_payment_resolved_at"` // Amount The amount of money involved in this transaction. Amount CurrencyAmount `json:"outgoing_payment_amount"` // TransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network. TransactionHash *string `json:"outgoing_payment_transaction_hash"` // Origin The Lightspark node this payment originated from. Origin types.EntityWrapper `json:"outgoing_payment_origin"` // Destination If known, the final recipient node this payment was sent to. Destination *types.EntityWrapper `json:"outgoing_payment_destination"` // Fees The fees paid by the sender node to send the payment. Fees *CurrencyAmount `json:"outgoing_payment_fees"` // PaymentRequestData The data of the payment request that was paid by this transaction, if known. PaymentRequestData *PaymentRequestData `json:"outgoing_payment_payment_request_data"` // FailureReason If applicable, the reason why the payment failed. FailureReason *PaymentFailureReason `json:"outgoing_payment_failure_reason"` // FailureMessage If applicable, user-facing error message describing why the payment failed. FailureMessage *RichText `json:"outgoing_payment_failure_message"` // UmaPostTransactionData The post transaction data which can be used in KYT payment registration. UmaPostTransactionData *[]PostTransactionData `json:"outgoing_payment_uma_post_transaction_data"` // PaymentPreimage The preimage of the payment. PaymentPreimage *string `json:"outgoing_payment_payment_preimage"` // Typename The typename of the object Typename string `json:"__typename"` }
OutgoingPayment This object represents a Lightning Network payment sent from a Lightspark Node. You can retrieve this object to receive payment related information about any payment sent from your Lightspark Node on the Lightning Network.
func (OutgoingPayment) GetAmount ¶
func (obj OutgoingPayment) GetAmount() CurrencyAmount
GetAmount The amount of money involved in this transaction.
func (OutgoingPayment) GetAttempts ¶
func (obj OutgoingPayment) GetAttempts(requester *requester.Requester, first *int64, after *string) (*OutgoingPaymentToAttemptsConnection, error)
func (OutgoingPayment) GetCreatedAt ¶
func (obj OutgoingPayment) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (OutgoingPayment) GetId ¶
func (obj OutgoingPayment) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (OutgoingPayment) GetResolvedAt ¶
func (obj OutgoingPayment) GetResolvedAt() *time.Time
GetResolvedAt The date and time when this transaction was completed or failed.
func (OutgoingPayment) GetStatus ¶
func (obj OutgoingPayment) GetStatus() TransactionStatus
GetStatus The current status of this transaction.
func (OutgoingPayment) GetTransactionHash ¶
func (obj OutgoingPayment) GetTransactionHash() *string
GetTransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network.
func (OutgoingPayment) GetTypename ¶ added in v0.6.1
func (obj OutgoingPayment) GetTypename() string
func (OutgoingPayment) GetUpdatedAt ¶
func (obj OutgoingPayment) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
func (*OutgoingPayment) UnmarshalJSON ¶
func (data *OutgoingPayment) UnmarshalJSON(dataBytes []byte) error
type OutgoingPaymentAttempt ¶
type OutgoingPaymentAttempt struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"outgoing_payment_attempt_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"outgoing_payment_attempt_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"outgoing_payment_attempt_updated_at"` // Status The status of an outgoing payment attempt. Status OutgoingPaymentAttemptStatus `json:"outgoing_payment_attempt_status"` // FailureCode If the payment attempt failed, then this contains the Bolt #4 failure code. FailureCode *HtlcAttemptFailureCode `json:"outgoing_payment_attempt_failure_code"` // FailureSourceIndex If the payment attempt failed, then this contains the index of the hop at which the problem occurred. FailureSourceIndex *int64 `json:"outgoing_payment_attempt_failure_source_index"` // AttemptedAt The date and time when the attempt was initiated. AttemptedAt time.Time `json:"outgoing_payment_attempt_attempted_at"` // ResolvedAt The time the outgoing payment attempt failed or succeeded. ResolvedAt *time.Time `json:"outgoing_payment_attempt_resolved_at"` // Amount The total amount of funds required to complete a payment over this route. This value includes the cumulative fees for each hop. As a result, the attempt extended to the first-hop in the route will need to have at least this much value, otherwise the route will fail at an intermediate node due to an insufficient amount. Amount *CurrencyAmount `json:"outgoing_payment_attempt_amount"` // Fees The sum of the fees paid at each hop within the route of this attempt. In the case of a one-hop payment, this value will be zero as we don't need to pay a fee to ourselves. Fees *CurrencyAmount `json:"outgoing_payment_attempt_fees"` // OutgoingPayment The outgoing payment for this attempt. OutgoingPayment types.EntityWrapper `json:"outgoing_payment_attempt_outgoing_payment"` // ChannelSnapshot The channel snapshot at the time the outgoing payment attempt was made. ChannelSnapshot *ChannelSnapshot `json:"outgoing_payment_attempt_channel_snapshot"` // Typename The typename of the object Typename string `json:"__typename"` }
OutgoingPaymentAttempt This object represents an attempted Lightning Network payment sent from a Lightspark Node. You can retrieve this object to receive payment related information about any payment attempt sent from your Lightspark Node on the Lightning Network, including any potential reasons the payment may have failed.
func (OutgoingPaymentAttempt) GetCreatedAt ¶
func (obj OutgoingPaymentAttempt) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (OutgoingPaymentAttempt) GetHops ¶
func (obj OutgoingPaymentAttempt) GetHops(requester *requester.Requester, first *int64, after *string) (*OutgoingPaymentAttemptToHopsConnection, error)
func (OutgoingPaymentAttempt) GetId ¶
func (obj OutgoingPaymentAttempt) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (OutgoingPaymentAttempt) GetTypename ¶ added in v0.6.1
func (obj OutgoingPaymentAttempt) GetTypename() string
func (OutgoingPaymentAttempt) GetUpdatedAt ¶
func (obj OutgoingPaymentAttempt) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type OutgoingPaymentAttemptStatus ¶
type OutgoingPaymentAttemptStatus int
OutgoingPaymentAttemptStatus This is an enum of all potential statuses of a payment attempt made from a Lightspark Node.
const ( OutgoingPaymentAttemptStatusUndefined OutgoingPaymentAttemptStatus = iota OutgoingPaymentAttemptStatusInFlight OutgoingPaymentAttemptStatusSucceeded OutgoingPaymentAttemptStatusFailed )
func (OutgoingPaymentAttemptStatus) MarshalJSON ¶
func (a OutgoingPaymentAttemptStatus) MarshalJSON() ([]byte, error)
func (OutgoingPaymentAttemptStatus) StringValue ¶
func (a OutgoingPaymentAttemptStatus) StringValue() string
func (*OutgoingPaymentAttemptStatus) UnmarshalJSON ¶
func (a *OutgoingPaymentAttemptStatus) UnmarshalJSON(b []byte) error
type OutgoingPaymentAttemptToHopsConnection ¶
type OutgoingPaymentAttemptToHopsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"outgoing_payment_attempt_to_hops_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"outgoing_payment_attempt_to_hops_connection_page_info"` // Entities The hops for the current page of this connection. Entities []Hop `json:"outgoing_payment_attempt_to_hops_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
OutgoingPaymentAttemptToHopsConnection The connection from an outgoing payment attempt to the list of sequential hops that define the path from sender node to recipient node.
func (OutgoingPaymentAttemptToHopsConnection) GetCount ¶
func (obj OutgoingPaymentAttemptToHopsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (OutgoingPaymentAttemptToHopsConnection) GetPageInfo ¶
func (obj OutgoingPaymentAttemptToHopsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (OutgoingPaymentAttemptToHopsConnection) GetTypename ¶ added in v0.6.1
func (obj OutgoingPaymentAttemptToHopsConnection) GetTypename() string
type OutgoingPaymentJSON ¶
type OutgoingPaymentJSON struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"outgoing_payment_id"` // CreatedAt The date and time when this transaction was initiated. CreatedAt time.Time `json:"outgoing_payment_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"outgoing_payment_updated_at"` // Status The current status of this transaction. Status TransactionStatus `json:"outgoing_payment_status"` // ResolvedAt The date and time when this transaction was completed or failed. ResolvedAt *time.Time `json:"outgoing_payment_resolved_at"` // Amount The amount of money involved in this transaction. Amount CurrencyAmount `json:"outgoing_payment_amount"` // TransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network. TransactionHash *string `json:"outgoing_payment_transaction_hash"` // Origin The Lightspark node this payment originated from. Origin types.EntityWrapper `json:"outgoing_payment_origin"` // Destination If known, the final recipient node this payment was sent to. Destination *types.EntityWrapper `json:"outgoing_payment_destination"` // Fees The fees paid by the sender node to send the payment. Fees *CurrencyAmount `json:"outgoing_payment_fees"` // PaymentRequestData The data of the payment request that was paid by this transaction, if known. PaymentRequestData map[string]interface{} `json:"outgoing_payment_payment_request_data"` // FailureReason If applicable, the reason why the payment failed. FailureReason *PaymentFailureReason `json:"outgoing_payment_failure_reason"` // FailureMessage If applicable, user-facing error message describing why the payment failed. FailureMessage *RichText `json:"outgoing_payment_failure_message"` // UmaPostTransactionData The post transaction data which can be used in KYT payment registration. UmaPostTransactionData *[]PostTransactionData `json:"outgoing_payment_uma_post_transaction_data"` // PaymentPreimage The preimage of the payment. PaymentPreimage *string `json:"outgoing_payment_payment_preimage"` // Typename The typename of the object Typename string `json:"__typename"` }
type OutgoingPaymentToAttemptsConnection ¶
type OutgoingPaymentToAttemptsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"outgoing_payment_to_attempts_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"outgoing_payment_to_attempts_connection_page_info"` // Entities The attempts for the current page of this connection. Entities []OutgoingPaymentAttempt `json:"outgoing_payment_to_attempts_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
OutgoingPaymentToAttemptsConnection The connection from outgoing payment to all attempts.
func (OutgoingPaymentToAttemptsConnection) GetCount ¶
func (obj OutgoingPaymentToAttemptsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (OutgoingPaymentToAttemptsConnection) GetPageInfo ¶
func (obj OutgoingPaymentToAttemptsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (OutgoingPaymentToAttemptsConnection) GetTypename ¶ added in v0.6.1
func (obj OutgoingPaymentToAttemptsConnection) GetTypename() string
type OutgoingPaymentsForInvoiceQueryInput ¶
type OutgoingPaymentsForInvoiceQueryInput struct { // EncodedInvoice The encoded invoice that the outgoing payments paid to. EncodedInvoice string `json:"outgoing_payments_for_invoice_query_input_encoded_invoice"` // Statuses An optional filter to only query outgoing payments of given statuses. Statuses *[]TransactionStatus `json:"outgoing_payments_for_invoice_query_input_statuses"` }
type OutgoingPaymentsForInvoiceQueryOutput ¶
type OutgoingPaymentsForInvoiceQueryOutput struct {
Payments []OutgoingPayment `json:"outgoing_payments_for_invoice_query_output_payments"`
}
type PageInfo ¶
type PageInfo struct { HasNextPage *bool `json:"page_info_has_next_page"` HasPreviousPage *bool `json:"page_info_has_previous_page"` StartCursor *string `json:"page_info_start_cursor"` EndCursor *string `json:"page_info_end_cursor"` }
PageInfo This is an object representing information about a page returned by the Lightspark API. For more information, please see the “Pagination” section of our API docs for more information about its usage.
type PayInvoiceInput ¶
type PayInvoiceInput struct { // NodeId The node from where you want to send the payment. NodeId string `json:"pay_invoice_input_node_id"` // EncodedInvoice The invoice you want to pay (as defined by the BOLT11 standard). EncodedInvoice string `json:"pay_invoice_input_encoded_invoice"` // TimeoutSecs The timeout in seconds that we will try to make the payment. TimeoutSecs int64 `json:"pay_invoice_input_timeout_secs"` // MaximumFeesMsats The maximum amount of fees that you want to pay for this payment to be sent, expressed in msats. MaximumFeesMsats int64 `json:"pay_invoice_input_maximum_fees_msats"` // AmountMsats The amount you will pay for this invoice, expressed in msats. It should ONLY be set when the invoice amount is zero. AmountMsats *int64 `json:"pay_invoice_input_amount_msats"` }
type PayInvoiceOutput ¶
type PayInvoiceOutput struct { // Payment The payment that has been sent. Payment types.EntityWrapper `json:"pay_invoice_output_payment"` }
type PayUmaInvoiceInput ¶
type PayUmaInvoiceInput struct { NodeId string `json:"pay_uma_invoice_input_node_id"` EncodedInvoice string `json:"pay_uma_invoice_input_encoded_invoice"` TimeoutSecs int64 `json:"pay_uma_invoice_input_timeout_secs"` MaximumFeesMsats int64 `json:"pay_uma_invoice_input_maximum_fees_msats"` AmountMsats *int64 `json:"pay_uma_invoice_input_amount_msats"` }
type PaymentDirection ¶
type PaymentDirection int
PaymentDirection This is an enum indicating the direction of the payment.
const ( PaymentDirectionUndefined PaymentDirection = iota PaymentDirectionSent PaymentDirectionReceived )
func (PaymentDirection) MarshalJSON ¶
func (a PaymentDirection) MarshalJSON() ([]byte, error)
func (PaymentDirection) StringValue ¶
func (a PaymentDirection) StringValue() string
func (*PaymentDirection) UnmarshalJSON ¶
func (a *PaymentDirection) UnmarshalJSON(b []byte) error
type PaymentFailureReason ¶
type PaymentFailureReason int
PaymentFailureReason This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may have failed.
const ( PaymentFailureReasonUndefined PaymentFailureReason = iota PaymentFailureReasonNone PaymentFailureReasonTimeout PaymentFailureReasonNoRoute PaymentFailureReasonError PaymentFailureReasonIncorrectPaymentDetails PaymentFailureReasonInsufficientBalance PaymentFailureReasonInvoiceAlreadyPaid PaymentFailureReasonSelfPayment PaymentFailureReasonInvoiceExpired PaymentFailureReasonRiskScreeningFailed )
func (PaymentFailureReason) MarshalJSON ¶
func (a PaymentFailureReason) MarshalJSON() ([]byte, error)
func (PaymentFailureReason) StringValue ¶
func (a PaymentFailureReason) StringValue() string
func (*PaymentFailureReason) UnmarshalJSON ¶
func (a *PaymentFailureReason) UnmarshalJSON(b []byte) error
type PaymentRequest ¶
type PaymentRequest interface { Entity // GetData The details of the payment request. GetData() PaymentRequestData // GetStatus The status of the payment request. GetStatus() PaymentRequestStatus }
PaymentRequest This object contains information related to a payment request generated or received by a LightsparkNode. You can retrieve this object to receive payment information about a specific invoice.
func PaymentRequestUnmarshal ¶
func PaymentRequestUnmarshal(data map[string]interface{}) (PaymentRequest, error)
type PaymentRequestData ¶
type PaymentRequestData interface { GetEncodedPaymentRequest() string GetBitcoinNetwork() BitcoinNetwork // GetTypename The typename of the object GetTypename() string }
PaymentRequestData This object is an interface of a payment request on the Lightning Network (i.e., a Lightning Invoice). It contains data related to parsing the payment details of a Lightning Invoice.
func PaymentRequestDataUnmarshal ¶
func PaymentRequestDataUnmarshal(data map[string]interface{}) (PaymentRequestData, error)
type PaymentRequestStatus ¶
type PaymentRequestStatus int
PaymentRequestStatus This is an enum of the potential states that a payment request on the Lightning Network can take.
const ( PaymentRequestStatusUndefined PaymentRequestStatus = iota PaymentRequestStatusOpen PaymentRequestStatusClosed )
func (PaymentRequestStatus) MarshalJSON ¶
func (a PaymentRequestStatus) MarshalJSON() ([]byte, error)
func (PaymentRequestStatus) StringValue ¶
func (a PaymentRequestStatus) StringValue() string
func (*PaymentRequestStatus) UnmarshalJSON ¶
func (a *PaymentRequestStatus) UnmarshalJSON(b []byte) error
type Permission ¶
type Permission int
Permission This is an enum of the potential permissions that a Lightspark user can have in regards to account management.
const ( PermissionUndefined Permission = iota PermissionAll PermissionMainnetView PermissionMainnetTransact PermissionMainnetManage PermissionTestnetView PermissionTestnetTransact PermissionTestnetManage PermissionRegtestView PermissionRegtestTransact PermissionRegtestManage PermissionUserView PermissionUserManage PermissionAccountView PermissionAccountManage )
func (Permission) MarshalJSON ¶
func (a Permission) MarshalJSON() ([]byte, error)
func (Permission) StringValue ¶
func (a Permission) StringValue() string
func (*Permission) UnmarshalJSON ¶
func (a *Permission) UnmarshalJSON(b []byte) error
type PostTransactionData ¶
type PostTransactionData struct { // Utxo The utxo of the channel over which the payment went through in the format of <transaction_hash>:<output_index>. Utxo string `json:"post_transaction_data_utxo"` // Amount The amount of funds transferred in the payment. Amount CurrencyAmount `json:"post_transaction_data_amount"` }
PostTransactionData This object represents post-transaction data that could be used to register payment for KYT.
type RegionCode ¶ added in v0.7.0
type RegionCode int
RegionCode The alpha-2 representation of a country, as defined by the ISO 3166-1 standard.
const ( RegionCodeUndefined RegionCode = iota // RegionCodeAf The code representing the country of Afghanistan. RegionCodeAf // RegionCodeAx The code representing the country of Åland Islands. RegionCodeAx // RegionCodeAl The code representing the country of Albania. RegionCodeAl // RegionCodeDz The code representing the country of Algeria. RegionCodeDz // RegionCodeAs The code representing the country of American Samoa. RegionCodeAs // RegionCodeAd The code representing the country of Andorra. RegionCodeAd // RegionCodeAo The code representing the country of Angola. RegionCodeAo // RegionCodeAi The code representing the country of Anguilla. RegionCodeAi // RegionCodeAq The code representing the country of Antarctica. RegionCodeAq // RegionCodeAg The code representing the country of Antigua and Barbuda. RegionCodeAg // RegionCodeAr The code representing the country of Argentina. RegionCodeAr // RegionCodeAm The code representing the country of Armenia. RegionCodeAm // RegionCodeAw The code representing the country of Aruba. RegionCodeAw // RegionCodeAu The code representing the country of Australia. RegionCodeAu // RegionCodeAt The code representing the country of Austria. RegionCodeAt // RegionCodeAz The code representing the country of Azerbaijan. RegionCodeAz // RegionCodeBs The code representing the country of Bahamas. RegionCodeBs // RegionCodeBh The code representing the country of Bahrain. RegionCodeBh // RegionCodeBd The code representing the country of Bangladesh. RegionCodeBd // RegionCodeBb The code representing the country of Barbados. RegionCodeBb // RegionCodeBy The code representing the country of Belarus. RegionCodeBy // RegionCodeBe The code representing the country of Belgium. RegionCodeBe // RegionCodeBz The code representing the country of Belize. RegionCodeBz // RegionCodeBj The code representing the country of Benin. RegionCodeBj // RegionCodeBm The code representing the country of Bermuda. RegionCodeBm // RegionCodeBt The code representing the country of Bhutan. RegionCodeBt // RegionCodeBo The code representing the country of The Plurinational State of Bolivia. RegionCodeBo // RegionCodeBq The code representing the country of Bonaire, Sint Eustatius, and Saba. RegionCodeBq // RegionCodeBa The code representing the country of Bosnia and Herzegovina. RegionCodeBa // RegionCodeBw The code representing the country of Botswana. RegionCodeBw // RegionCodeBv The code representing the country of Bouvet Island. RegionCodeBv // RegionCodeBr The code representing the country of Brazil. RegionCodeBr // RegionCodeIo The code representing the country of British Indian Ocean Territory. RegionCodeIo // RegionCodeBn The code representing the country of Brunei Darussalam. RegionCodeBn // RegionCodeBg The code representing the country of Bulgaria. RegionCodeBg // RegionCodeBf The code representing the country of Burkina Faso. RegionCodeBf // RegionCodeBi The code representing the country of Burundi. RegionCodeBi // RegionCodeKh The code representing the country of Cambodia. RegionCodeKh // RegionCodeCm The code representing the country of Cameroon. RegionCodeCm // RegionCodeCa The code representing the country of Canada. RegionCodeCa // RegionCodeCv The code representing the country of Cape Verde. RegionCodeCv // RegionCodeKy The code representing the country of Cayman Islands. RegionCodeKy // RegionCodeCf The code representing the country of Central African Republic. RegionCodeCf // RegionCodeTd The code representing the country of Chad. RegionCodeTd // RegionCodeCl The code representing the country of Chile. RegionCodeCl // RegionCodeCn The code representing the country of China. RegionCodeCn // RegionCodeCx The code representing the country of Christmas Island. RegionCodeCx // RegionCodeCc The code representing the country of Cocos (Keeling) Islands. RegionCodeCc // RegionCodeCo The code representing the country of Colombia. RegionCodeCo // RegionCodeKm The code representing the country of Comoros. RegionCodeKm // RegionCodeCg The code representing the country of Congo. RegionCodeCg // RegionCodeCd The code representing the country of The Democratic Republic of the Congo. RegionCodeCd // RegionCodeCk The code representing the country of Cook Islands. RegionCodeCk // RegionCodeCr The code representing the country of Costa Rica. RegionCodeCr // RegionCodeCi The code representing the country of Côte d'Ivoire. RegionCodeCi // RegionCodeHr The code representing the country of Croatia. RegionCodeHr // RegionCodeCu The code representing the country of Cuba. RegionCodeCu // RegionCodeCw The code representing the country of Curaçao. RegionCodeCw // RegionCodeCy The code representing the country of Cyprus. RegionCodeCy // RegionCodeCz The code representing the country of Czech Republic. RegionCodeCz // RegionCodeDk The code representing the country of Denmark. RegionCodeDk // RegionCodeDj The code representing the country of Djibouti. RegionCodeDj // RegionCodeDm The code representing the country of Dominica. RegionCodeDm // RegionCodeDo The code representing the country of Dominican Republic. RegionCodeDo // RegionCodeEc The code representing the country of Ecuador. RegionCodeEc // RegionCodeEg The code representing the country of Egypt. RegionCodeEg // RegionCodeSv The code representing the country of El Salvador. RegionCodeSv // RegionCodeGq The code representing the country of Equatorial Guinea. RegionCodeGq // RegionCodeEr The code representing the country of Eritrea. RegionCodeEr // RegionCodeEe The code representing the country of Estonia. RegionCodeEe // RegionCodeEt The code representing the country of Ethiopia. RegionCodeEt // RegionCodeFk The code representing the country of Falkland Islands (Malvinas). RegionCodeFk // RegionCodeFo The code representing the country of Faroe Islands. RegionCodeFo // RegionCodeFj The code representing the country of Fiji. RegionCodeFj // RegionCodeFi The code representing the country of Finland. RegionCodeFi // RegionCodeFr The code representing the country of France. RegionCodeFr // RegionCodeGf The code representing the country of French Guiana. RegionCodeGf // RegionCodePf The code representing the country of French Polynesia. RegionCodePf // RegionCodeTf The code representing the country of French Southern Territories. RegionCodeTf // RegionCodeGa The code representing the country of Gabon. RegionCodeGa // RegionCodeGm The code representing the country of Gambia. RegionCodeGm // RegionCodeGe The code representing the country of Georgia. RegionCodeGe // RegionCodeDe The code representing the country of Germany. RegionCodeDe // RegionCodeGh The code representing the country of Ghana. RegionCodeGh // RegionCodeGi The code representing the country of Gibraltar. RegionCodeGi // RegionCodeGr The code representing the country of Greece. RegionCodeGr // RegionCodeGl The code representing the country of Greenland. RegionCodeGl // RegionCodeGd The code representing the country of Grenada. RegionCodeGd // RegionCodeGp The code representing the country of Guadeloupe. RegionCodeGp // RegionCodeGu The code representing the country of Guam. RegionCodeGu // RegionCodeGt The code representing the country of Guatemala. RegionCodeGt // RegionCodeGg The code representing the country of Guernsey. RegionCodeGg // RegionCodeGn The code representing the country of Guinea. RegionCodeGn // RegionCodeGw The code representing the country of Guinea-Bissau. RegionCodeGw // RegionCodeGy The code representing the country of Guyana. RegionCodeGy // RegionCodeHt The code representing the country of Haiti. RegionCodeHt // RegionCodeHm The code representing the country of Heard Island and McDonald Islands. RegionCodeHm // RegionCodeVa The code representing the country of Holy See (Vatican City State). RegionCodeVa // RegionCodeHn The code representing the country of Honduras. RegionCodeHn // RegionCodeHk The code representing the country of Hong Kong. RegionCodeHk // RegionCodeHu The code representing the country of Hungary. RegionCodeHu // RegionCodeIs The code representing the country of Iceland. RegionCodeIs // RegionCodeIn The code representing the country of India. RegionCodeIn // RegionCodeId The code representing the country of Indonesia. RegionCodeId // RegionCodeIr The code representing the country of Islamic Republic of Iran. RegionCodeIr // RegionCodeIq The code representing the country of Iraq. RegionCodeIq // RegionCodeIe The code representing the country of Ireland. RegionCodeIe // RegionCodeIm The code representing the country of Isle of Man. RegionCodeIm // RegionCodeIl The code representing the country of Israel. RegionCodeIl // RegionCodeIt The code representing the country of Italy. RegionCodeIt // RegionCodeJm The code representing the country of Jamaica. RegionCodeJm // RegionCodeJp The code representing the country of Japan. RegionCodeJp // RegionCodeJe The code representing the country of Jersey. RegionCodeJe // RegionCodeJo The code representing the country of Jordan. RegionCodeJo // RegionCodeKz The code representing the country of Kazakhstan. RegionCodeKz // RegionCodeKe The code representing the country of Kenya. RegionCodeKe // RegionCodeKi The code representing the country of Kiribati. RegionCodeKi // RegionCodeKp The code representing the country of Democratic People's Republic ofKorea. RegionCodeKp // RegionCodeKr The code representing the country of Republic of Korea. RegionCodeKr // RegionCodeKw The code representing the country of Kuwait. RegionCodeKw // RegionCodeKg The code representing the country of Kyrgyzstan. RegionCodeKg // RegionCodeLa The code representing the country of Lao People's Democratic Republic. RegionCodeLa // RegionCodeLv The code representing the country of Latvia. RegionCodeLv // RegionCodeLb The code representing the country of Lebanon. RegionCodeLb // RegionCodeLs The code representing the country of Lesotho. RegionCodeLs // RegionCodeLr The code representing the country of Liberia. RegionCodeLr // RegionCodeLy The code representing the country of Libya. RegionCodeLy // RegionCodeLi The code representing the country of Liechtenstein. RegionCodeLi // RegionCodeLt The code representing the country of Lithuania. RegionCodeLt // RegionCodeLu The code representing the country of Luxembourg. RegionCodeLu // RegionCodeMo The code representing the country of Macao. RegionCodeMo // RegionCodeMk The code representing the country of The Former Yugoslav Republic of Macedonia. RegionCodeMk // RegionCodeMg The code representing the country of Madagascar. RegionCodeMg // RegionCodeMw The code representing the country of Malawi. RegionCodeMw // RegionCodeMy The code representing the country of Malaysia. RegionCodeMy // RegionCodeMv The code representing the country of Maldives. RegionCodeMv // RegionCodeMl The code representing the country of Mali. RegionCodeMl // RegionCodeMt The code representing the country of Malta. RegionCodeMt // RegionCodeMh The code representing the country of Marshall Islands. RegionCodeMh // RegionCodeMq The code representing the country of Martinique. RegionCodeMq // RegionCodeMr The code representing the country of Mauritania. RegionCodeMr // RegionCodeMu The code representing the country of Mauritius. RegionCodeMu // RegionCodeYt The code representing the country of Mayotte. RegionCodeYt // RegionCodeMx The code representing the country of Mexico. RegionCodeMx // RegionCodeFm The code representing the country of Federated States ofMicronesia. RegionCodeFm // RegionCodeMd The code representing the country of Republic of Moldova. RegionCodeMd // RegionCodeMc The code representing the country of Monaco. RegionCodeMc // RegionCodeMn The code representing the country of Mongolia. RegionCodeMn // RegionCodeMe The code representing the country of Montenegro. RegionCodeMe // RegionCodeMs The code representing the country of Montserrat. RegionCodeMs // RegionCodeMa The code representing the country of Morocco. RegionCodeMa // RegionCodeMz The code representing the country of Mozambique. RegionCodeMz // RegionCodeMm The code representing the country of Myanmar. RegionCodeMm // RegionCodeNa The code representing the country of Namibia. RegionCodeNa // RegionCodeNr The code representing the country of Nauru. RegionCodeNr // RegionCodeNp The code representing the country of Nepal. RegionCodeNp // RegionCodeNl The code representing the country of Netherlands. RegionCodeNl // RegionCodeNc The code representing the country of New Caledonia. RegionCodeNc // RegionCodeNz The code representing the country of New Zealand. RegionCodeNz // RegionCodeNi The code representing the country of Nicaragua. RegionCodeNi // RegionCodeNe The code representing the country of Niger. RegionCodeNe // RegionCodeNg The code representing the country of Nigeria. RegionCodeNg // RegionCodeNu The code representing the country of Niue. RegionCodeNu // RegionCodeNf The code representing the country of Norfolk Island. RegionCodeNf // RegionCodeMp The code representing the country of Northern Mariana Islands. RegionCodeMp // RegionCodeNo The code representing the country of Norway. RegionCodeNo // RegionCodeOm The code representing the country of Oman. RegionCodeOm // RegionCodePk The code representing the country of Pakistan. RegionCodePk // RegionCodePw The code representing the country of Palau. RegionCodePw // RegionCodePs The code representing the country of State of Palestine. RegionCodePs // RegionCodePa The code representing the country of Panama. RegionCodePa // RegionCodePg The code representing the country of Papua New Guinea. RegionCodePg // RegionCodePy The code representing the country of Paraguay. RegionCodePy // RegionCodePe The code representing the country of Peru. RegionCodePe // RegionCodePh The code representing the country of Philippines. RegionCodePh // RegionCodePn The code representing the country of Pitcairn. RegionCodePn // RegionCodePl The code representing the country of Poland. RegionCodePl // RegionCodePt The code representing the country of Portugal. RegionCodePt // RegionCodePr The code representing the country of Puerto Rico. RegionCodePr // RegionCodeQa The code representing the country of Qatar. RegionCodeQa // RegionCodeRe The code representing the country of Réunion. RegionCodeRe // RegionCodeRo The code representing the country of Romania. RegionCodeRo // RegionCodeRu The code representing the country of Russian Federation. RegionCodeRu // RegionCodeRw The code representing the country of Rwanda. RegionCodeRw // RegionCodeBl The code representing the country of Saint Barthélemy. RegionCodeBl // RegionCodeSh The code representing the country of Saint Helena Ascension and Tristan da Cunha. RegionCodeSh // RegionCodeKn The code representing the country of Saint Kitts and Nevis. RegionCodeKn // RegionCodeLc The code representing the country of Saint Lucia. RegionCodeLc // RegionCodeMf The code representing the country of Saint Martin (French part). RegionCodeMf // RegionCodePm The code representing the country of Saint Pierre and Miquelon. RegionCodePm // RegionCodeVc The code representing the country of Saint Vincent and the Grenadines. RegionCodeVc // RegionCodeWs The code representing the country of Samoa. RegionCodeWs // RegionCodeSm The code representing the country of San Marino. RegionCodeSm // RegionCodeSt The code representing the country of Sao Tome and Principe. RegionCodeSt // RegionCodeSa The code representing the country of Saudi Arabia. RegionCodeSa // RegionCodeSn The code representing the country of Senegal. RegionCodeSn // RegionCodeRs The code representing the country of Serbia. RegionCodeRs // RegionCodeSc The code representing the country of Seychelles. RegionCodeSc // RegionCodeSl The code representing the country of Sierra Leone. RegionCodeSl // RegionCodeSg The code representing the country of Singapore. RegionCodeSg // RegionCodeSx The code representing the country of Sint Maarten (Dutch part). RegionCodeSx // RegionCodeSk The code representing the country of Slovakia. RegionCodeSk // RegionCodeSi The code representing the country of Slovenia. RegionCodeSi // RegionCodeSb The code representing the country of Solomon Islands. RegionCodeSb // RegionCodeSo The code representing the country of Somalia. RegionCodeSo // RegionCodeZa The code representing the country of South Africa. RegionCodeZa // RegionCodeGs The code representing the country of South Georgia and the South Sandwich Islands. RegionCodeGs // RegionCodeSs The code representing the country of South Sudan. RegionCodeSs // RegionCodeEs The code representing the country of Spain. RegionCodeEs // RegionCodeLk The code representing the country of Sri Lanka. RegionCodeLk // RegionCodeSd The code representing the country of Sudan. RegionCodeSd // RegionCodeSr The code representing the country of Suriname. RegionCodeSr // RegionCodeSj The code representing the country of Svalbard and Jan Mayen. RegionCodeSj // RegionCodeSz The code representing the country of Swaziland. RegionCodeSz // RegionCodeSe The code representing the country of Sweden. RegionCodeSe // RegionCodeCh The code representing the country of Switzerland. RegionCodeCh // RegionCodeSy The code representing the country of Syrian Arab Republic. RegionCodeSy // RegionCodeTw The code representing the country of Taiwan, Province of China. RegionCodeTw // RegionCodeTj The code representing the country of Tajikistan. RegionCodeTj // RegionCodeTz The code representing the country of United Republic of Tanzania. RegionCodeTz // RegionCodeTh The code representing the country of Thailand. RegionCodeTh // RegionCodeTl The code representing the country of Timor-Leste. RegionCodeTl // RegionCodeTg The code representing the country of Togo. RegionCodeTg // RegionCodeTk The code representing the country of Tokelau. RegionCodeTk // RegionCodeTo The code representing the country of Tonga. RegionCodeTo // RegionCodeTt The code representing the country of Trinidad and Tobago. RegionCodeTt // RegionCodeTn The code representing the country of Tunisia. RegionCodeTn // RegionCodeTr The code representing the country of Turkey. RegionCodeTr // RegionCodeTm The code representing the country of Turkmenistan. RegionCodeTm // RegionCodeTc The code representing the country of Turks and Caicos Islands. RegionCodeTc // RegionCodeTv The code representing the country of Tuvalu. RegionCodeTv // RegionCodeUg The code representing the country of Uganda. RegionCodeUg // RegionCodeUa The code representing the country of Ukraine. RegionCodeUa // RegionCodeAe The code representing the country of United Arab Emirates. RegionCodeAe // RegionCodeGb The code representing the country of United Kingdom. RegionCodeGb // RegionCodeUs The code representing the country of United States. RegionCodeUs // RegionCodeUm The code representing the country of United States Minor Outlying Islands. RegionCodeUm // RegionCodeUy The code representing the country of Uruguay. RegionCodeUy // RegionCodeUz The code representing the country of Uzbekistan. RegionCodeUz // RegionCodeVu The code representing the country of Vanuatu. RegionCodeVu // RegionCodeVe The code representing the country of Bolivarian Republic of Venezuela. RegionCodeVe // RegionCodeVn The code representing the country of Viet Nam. RegionCodeVn // RegionCodeVg The code representing the country of British Virgin Islands. RegionCodeVg // RegionCodeVi The code representing the country of U.S. Virgin Islands. RegionCodeVi // RegionCodeWf The code representing the country of Wallis and Futuna. RegionCodeWf // RegionCodeEh The code representing the country of Western Sahara. RegionCodeEh // RegionCodeYe The code representing the country of Yemen. RegionCodeYe // RegionCodeZm The code representing the country of Zambia. RegionCodeZm // RegionCodeZw The code representing the country of Zimbabwe. RegionCodeZw )
func (RegionCode) MarshalJSON ¶ added in v0.7.0
func (a RegionCode) MarshalJSON() ([]byte, error)
func (RegionCode) StringValue ¶ added in v0.7.0
func (a RegionCode) StringValue() string
func (*RegionCode) UnmarshalJSON ¶ added in v0.7.0
func (a *RegionCode) UnmarshalJSON(b []byte) error
type RegisterPaymentInput ¶
type RegisterPaymentInput struct { // Provider The compliance provider that is going to screen the node. You need to be a customer of the selected provider and store the API key on the Lightspark account setting page. Provider ComplianceProvider `json:"register_payment_input_provider"` // PaymentId The Lightspark ID of the lightning payment you want to register. It can be the id of either an OutgoingPayment or an IncomingPayment. PaymentId string `json:"register_payment_input_payment_id"` // NodePubkey The public key of the counterparty lightning node, which would be the public key of the recipient node if it is to register an outgoing payment, or the public key of the sender node if it is to register an incoming payment. NodePubkey string `json:"register_payment_input_node_pubkey"` // Direction Indicates whether this payment is an OutgoingPayment or an IncomingPayment. Direction PaymentDirection `json:"register_payment_input_direction"` }
type RegisterPaymentOutput ¶
type RegisterPaymentOutput struct {
Payment types.EntityWrapper `json:"register_payment_output_payment"`
}
type ReleaseChannelPerCommitmentSecretInput ¶
type ReleaseChannelPerCommitmentSecretInput struct { // ChannelId The unique identifier of the channel. ChannelId string `json:"release_channel_per_commitment_secret_input_channel_id"` // PerCommitmentSecret The per-commitment secret to be released. PerCommitmentSecret string `json:"release_channel_per_commitment_secret_input_per_commitment_secret"` // PerCommitmentIndex The index associated with the per-commitment secret. PerCommitmentIndex int64 `json:"release_channel_per_commitment_secret_input_per_commitment_index"` }
type ReleaseChannelPerCommitmentSecretOutput ¶
type ReleaseChannelPerCommitmentSecretOutput struct { // Channel The channel object after the per-commitment secret release operation. Channel types.EntityWrapper `json:"release_channel_per_commitment_secret_output_channel"` }
type ReleasePaymentPreimageOutput ¶
type ReleasePaymentPreimageOutput struct { // Invoice The invoice of the transaction. Invoice types.EntityWrapper `json:"release_payment_preimage_output_invoice"` }
type RemoteSigningSubEventType ¶
type RemoteSigningSubEventType int
RemoteSigningSubEventType This is an enum of the potential sub-event types for Remote Signing webook events.
const ( RemoteSigningSubEventTypeUndefined RemoteSigningSubEventType = iota RemoteSigningSubEventTypeEcdh RemoteSigningSubEventTypeGetPerCommitmentPoint RemoteSigningSubEventTypeReleasePerCommitmentSecret RemoteSigningSubEventTypeSignInvoice RemoteSigningSubEventTypeDeriveKeyAndSign RemoteSigningSubEventTypeReleasePaymentPreimage RemoteSigningSubEventTypeRequestInvoicePaymentHash RemoteSigningSubEventTypeRevealCounterpartyPerCommitmentSecret )
func (RemoteSigningSubEventType) MarshalJSON ¶
func (a RemoteSigningSubEventType) MarshalJSON() ([]byte, error)
func (RemoteSigningSubEventType) StringValue ¶
func (a RemoteSigningSubEventType) StringValue() string
func (*RemoteSigningSubEventType) UnmarshalJSON ¶
func (a *RemoteSigningSubEventType) UnmarshalJSON(b []byte) error
type RequestWithdrawalInput ¶
type RequestWithdrawalInput struct { // NodeId The node from which you'd like to make the withdrawal. NodeId string `json:"request_withdrawal_input_node_id"` // BitcoinAddress The bitcoin address where the withdrawal should be sent. BitcoinAddress string `json:"request_withdrawal_input_bitcoin_address"` // AmountSats The amount you want to withdraw from this node in Satoshis. Use the special value -1 to withdrawal all funds from this node. AmountSats int64 `json:"request_withdrawal_input_amount_sats"` // WithdrawalMode The strategy that should be used to withdraw the funds from this node. WithdrawalMode WithdrawalMode `json:"request_withdrawal_input_withdrawal_mode"` }
type RequestWithdrawalOutput ¶
type RequestWithdrawalOutput struct { // Request The request that is created for this withdrawal. Request types.EntityWrapper `json:"request_withdrawal_output_request"` }
type RiskRating ¶
type RiskRating int
RiskRating This is an enum of the potential risk ratings related to a transaction made over the Lightning Network. These risk ratings are returned from the CryptoSanctionScreeningProvider.
const ( RiskRatingUndefined RiskRating = iota RiskRatingHighRisk RiskRatingLowRisk RiskRatingUnknown )
func (RiskRating) MarshalJSON ¶
func (a RiskRating) MarshalJSON() ([]byte, error)
func (RiskRating) StringValue ¶
func (a RiskRating) StringValue() string
func (*RiskRating) UnmarshalJSON ¶
func (a *RiskRating) UnmarshalJSON(b []byte) error
type RoutingTransaction ¶
type RoutingTransaction struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"routing_transaction_id"` // CreatedAt The date and time when this transaction was initiated. CreatedAt time.Time `json:"routing_transaction_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"routing_transaction_updated_at"` // Status The current status of this transaction. Status TransactionStatus `json:"routing_transaction_status"` // ResolvedAt The date and time when this transaction was completed or failed. ResolvedAt *time.Time `json:"routing_transaction_resolved_at"` // Amount The amount of money involved in this transaction. Amount CurrencyAmount `json:"routing_transaction_amount"` // TransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network. TransactionHash *string `json:"routing_transaction_transaction_hash"` // IncomingChannel If known, the channel this transaction was received from. IncomingChannel *types.EntityWrapper `json:"routing_transaction_incoming_channel"` // OutgoingChannel If known, the channel this transaction was forwarded to. OutgoingChannel *types.EntityWrapper `json:"routing_transaction_outgoing_channel"` // Fees The fees collected by the node when routing this transaction. We subtract the outgoing amount to the incoming amount to determine how much fees were collected. Fees *CurrencyAmount `json:"routing_transaction_fees"` // FailureMessage If applicable, user-facing error message describing why the routing failed. FailureMessage *RichText `json:"routing_transaction_failure_message"` // FailureReason If applicable, the reason why the routing failed. FailureReason *RoutingTransactionFailureReason `json:"routing_transaction_failure_reason"` // Typename The typename of the object Typename string `json:"__typename"` }
RoutingTransaction This object represents a transaction that was forwarded through a Lightspark node on the Lightning Network, i.e., a routed transaction. You can retrieve this object to receive information about any transaction routed through your Lightspark Node.
func (RoutingTransaction) GetAmount ¶
func (obj RoutingTransaction) GetAmount() CurrencyAmount
GetAmount The amount of money involved in this transaction.
func (RoutingTransaction) GetCreatedAt ¶
func (obj RoutingTransaction) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (RoutingTransaction) GetId ¶
func (obj RoutingTransaction) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (RoutingTransaction) GetResolvedAt ¶
func (obj RoutingTransaction) GetResolvedAt() *time.Time
GetResolvedAt The date and time when this transaction was completed or failed.
func (RoutingTransaction) GetStatus ¶
func (obj RoutingTransaction) GetStatus() TransactionStatus
GetStatus The current status of this transaction.
func (RoutingTransaction) GetTransactionHash ¶
func (obj RoutingTransaction) GetTransactionHash() *string
GetTransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network.
func (RoutingTransaction) GetTypename ¶ added in v0.6.1
func (obj RoutingTransaction) GetTypename() string
func (RoutingTransaction) GetUpdatedAt ¶
func (obj RoutingTransaction) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type RoutingTransactionFailureReason ¶
type RoutingTransactionFailureReason int
RoutingTransactionFailureReason This is an enum of the potential reasons that an attempted routed transaction through a Lightspark node may have failed.
const ( RoutingTransactionFailureReasonUndefined RoutingTransactionFailureReason = iota RoutingTransactionFailureReasonIncomingLinkFailure RoutingTransactionFailureReasonOutgoingLinkFailure RoutingTransactionFailureReasonForwardingFailure )
func (RoutingTransactionFailureReason) MarshalJSON ¶
func (a RoutingTransactionFailureReason) MarshalJSON() ([]byte, error)
func (RoutingTransactionFailureReason) StringValue ¶
func (a RoutingTransactionFailureReason) StringValue() string
func (*RoutingTransactionFailureReason) UnmarshalJSON ¶
func (a *RoutingTransactionFailureReason) UnmarshalJSON(b []byte) error
type ScreenNodeInput ¶
type ScreenNodeInput struct { // Provider The compliance provider that is going to screen the node. You need to be a customer of the selected provider and store the API key on the Lightspark account setting page. Provider ComplianceProvider `json:"screen_node_input_provider"` // NodePubkey The public key of the lightning node that needs to be screened. NodePubkey string `json:"screen_node_input_node_pubkey"` }
type ScreenNodeOutput ¶
type ScreenNodeOutput struct {
Rating RiskRating `json:"screen_node_output_rating"`
}
type SendPaymentInput ¶
type SendPaymentInput struct { // NodeId The node from where you want to send the payment. NodeId string `json:"send_payment_input_node_id"` // DestinationPublicKey The public key of the destination node. DestinationPublicKey string `json:"send_payment_input_destination_public_key"` // TimeoutSecs The timeout in seconds that we will try to make the payment. TimeoutSecs int64 `json:"send_payment_input_timeout_secs"` // AmountMsats The amount you will send to the destination node, expressed in msats. AmountMsats int64 `json:"send_payment_input_amount_msats"` // MaximumFeesMsats The maximum amount of fees that you want to pay for this payment to be sent, expressed in msats. MaximumFeesMsats int64 `json:"send_payment_input_maximum_fees_msats"` }
type SendPaymentOutput ¶
type SendPaymentOutput struct { // Payment The payment that has been sent. Payment types.EntityWrapper `json:"send_payment_output_payment"` }
type SetInvoicePaymentHashInput ¶
type SetInvoicePaymentHashInput struct { // InvoiceId The invoice that needs to be updated. InvoiceId string `json:"set_invoice_payment_hash_input_invoice_id"` // PaymentHash The 32-byte hash of the payment preimage. PaymentHash string `json:"set_invoice_payment_hash_input_payment_hash"` // PreimageNonce The 32-byte nonce used to generate the invoice preimage if applicable. It will later be included in RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw preimage. PreimageNonce *string `json:"set_invoice_payment_hash_input_preimage_nonce"` }
type SetInvoicePaymentHashOutput ¶
type SetInvoicePaymentHashOutput struct {
Invoice types.EntityWrapper `json:"set_invoice_payment_hash_output_invoice"`
}
type SignInvoiceInput ¶
type SignInvoiceInput struct { // InvoiceId The unique identifier of the invoice to be signed. InvoiceId string `json:"sign_invoice_input_invoice_id"` // Signature The cryptographic signature for the invoice. Signature string `json:"sign_invoice_input_signature"` // RecoveryId The recovery identifier for the signature. RecoveryId int64 `json:"sign_invoice_input_recovery_id"` }
type SignInvoiceOutput ¶
type SignInvoiceOutput struct { // Invoice The signed invoice object. Invoice types.EntityWrapper `json:"sign_invoice_output_invoice"` }
type SignMessagesInput ¶
type SignMessagesInput struct { // Signatures The list of the message ids and signatures. Signatures []IdAndSignature `json:"sign_messages_input_signatures"` }
type SignMessagesOutput ¶
type SignMessagesOutput struct { // SignedPayloads The list of signed payloads. SignedPayloads []SignablePayload `json:"sign_messages_output_signed_payloads"` }
type Signable ¶
type Signable struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"signable_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"signable_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"signable_updated_at"` // Typename The typename of the object Typename string `json:"__typename"` }
func (Signable) GetCreatedAt ¶
GetCreatedAt The date and time when the entity was first created.
func (Signable) GetId ¶
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (Signable) GetTypename ¶ added in v0.6.1
func (Signable) GetUpdatedAt ¶
GetUpdatedAt The date and time when the entity was last updated.
type SignablePayload ¶
type SignablePayload struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"signable_payload_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"signable_payload_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"signable_payload_updated_at"` // Payload The payload that needs to be signed. Payload string `json:"signable_payload_payload"` // DerivationPath The consistent method for generating the same set of accounts and wallets for a given private key DerivationPath string `json:"signable_payload_derivation_path"` // Status The status of the payload. Status SignablePayloadStatus `json:"signable_payload_status"` // AddTweak The tweak value to add. AddTweak *string `json:"signable_payload_add_tweak"` // MulTweak The tweak value to multiply. MulTweak *string `json:"signable_payload_mul_tweak"` // Signable The signable this payload belongs to. Signable types.EntityWrapper `json:"signable_payload_signable"` // Typename The typename of the object Typename string `json:"__typename"` }
func (SignablePayload) GetCreatedAt ¶
func (obj SignablePayload) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (SignablePayload) GetId ¶
func (obj SignablePayload) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (SignablePayload) GetTypename ¶ added in v0.6.1
func (obj SignablePayload) GetTypename() string
func (SignablePayload) GetUpdatedAt ¶
func (obj SignablePayload) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type SignablePayloadStatus ¶
type SignablePayloadStatus int
const ( SignablePayloadStatusUndefined SignablePayloadStatus = iota SignablePayloadStatusCreated SignablePayloadStatusSigned SignablePayloadStatusValidationFailed SignablePayloadStatusInvalidSignature )
func (SignablePayloadStatus) MarshalJSON ¶
func (a SignablePayloadStatus) MarshalJSON() ([]byte, error)
func (SignablePayloadStatus) StringValue ¶
func (a SignablePayloadStatus) StringValue() string
func (*SignablePayloadStatus) UnmarshalJSON ¶
func (a *SignablePayloadStatus) UnmarshalJSON(b []byte) error
type Transaction ¶
type Transaction interface { Entity // GetStatus The current status of this transaction. GetStatus() TransactionStatus // GetResolvedAt The date and time when this transaction was completed or failed. GetResolvedAt() *time.Time // GetAmount The amount of money involved in this transaction. GetAmount() CurrencyAmount // GetTransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network. GetTransactionHash() *string }
Transaction This object represents a payment transaction. The transaction can occur either on a Bitcoin Network, or over the Lightning Network. You can retrieve this object to receive specific information about a particular transaction tied to your Lightspark Node.
func TransactionUnmarshal ¶
func TransactionUnmarshal(data map[string]interface{}) (Transaction, error)
type TransactionFailures ¶
type TransactionFailures struct { PaymentFailures *[]PaymentFailureReason `json:"transaction_failures_payment_failures"` RoutingTransactionFailures *[]RoutingTransactionFailureReason `json:"transaction_failures_routing_transaction_failures"` }
TransactionFailures This object represents payment failures associated with your Lightspark Node.
type TransactionStatus ¶
type TransactionStatus int
TransactionStatus This is an enum of the potential statuses a transaction associated with your Lightspark Node can take.
const ( TransactionStatusUndefined TransactionStatus = iota // TransactionStatusSuccess Transaction succeeded.. TransactionStatusSuccess // TransactionStatusFailed Transaction failed. TransactionStatusFailed // TransactionStatusPending Transaction has been initiated and is currently in-flight. TransactionStatusPending // TransactionStatusNotStarted For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request. TransactionStatusNotStarted // TransactionStatusExpired For transaction type PAYMENT_REQUEST only. A payment request has expired. TransactionStatusExpired // TransactionStatusCancelled For transaction type PAYMENT_REQUEST only. TransactionStatusCancelled )
func (TransactionStatus) MarshalJSON ¶
func (a TransactionStatus) MarshalJSON() ([]byte, error)
func (TransactionStatus) StringValue ¶
func (a TransactionStatus) StringValue() string
func (*TransactionStatus) UnmarshalJSON ¶
func (a *TransactionStatus) UnmarshalJSON(b []byte) error
type TransactionType ¶
type TransactionType int
TransactionType This is an enum of the potential types of transactions that can be associated with your Lightspark Node.
const ( TransactionTypeUndefined TransactionType = iota // TransactionTypeOutgoingPayment Transactions initiated from a Lightspark node on Lightning Network. TransactionTypeOutgoingPayment // TransactionTypeIncomingPayment Transactions received by a Lightspark node on Lightning Network. TransactionTypeIncomingPayment // TransactionTypeRouted Transactions that forwarded payments through Lightspark nodes on Lightning Network. TransactionTypeRouted // TransactionTypeL1Withdraw Transactions on the Bitcoin blockchain to withdraw funds from a Lightspark node to a Bitcoin wallet. TransactionTypeL1Withdraw // TransactionTypeL1Deposit Transactions on Bitcoin blockchain to fund a Lightspark node's wallet. TransactionTypeL1Deposit // TransactionTypeChannelOpen Transactions on Bitcoin blockchain to open a channel on Lightning Network funded by the local Lightspark node. TransactionTypeChannelOpen // TransactionTypeChannelClose Transactions on Bitcoin blockchain to close a channel on Lightning Network where the balances are allocated back to local and remote nodes. TransactionTypeChannelClose // TransactionTypePayment Transactions initiated from a Lightspark node on Lightning Network. TransactionTypePayment // TransactionTypePaymentRequest Payment requests from a Lightspark node on Lightning Network TransactionTypePaymentRequest // TransactionTypeRoute Transactions that forwarded payments through Lightspark nodes on Lightning Network. TransactionTypeRoute )
func (TransactionType) MarshalJSON ¶
func (a TransactionType) MarshalJSON() ([]byte, error)
func (TransactionType) StringValue ¶
func (a TransactionType) StringValue() string
func (*TransactionType) UnmarshalJSON ¶
func (a *TransactionType) UnmarshalJSON(b []byte) error
type UmaInvitation ¶ added in v0.7.0
type UmaInvitation struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"uma_invitation_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"uma_invitation_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"uma_invitation_updated_at"` // Code The code that uniquely identifies this invitation. Code string `json:"uma_invitation_code"` // Url The URL where this invitation can be claimed. Url string `json:"uma_invitation_url"` // InviterUma The UMA of the user who created the invitation. InviterUma string `json:"uma_invitation_inviter_uma"` // InviteeUma The UMA of the user who claimed the invitation. InviteeUma *string `json:"uma_invitation_invitee_uma"` // IncentivesStatus The current status of the incentives that may be tied to this invitation. IncentivesStatus IncentivesStatus `json:"uma_invitation_incentives_status"` // IncentivesIneligibilityReason The reason why the invitation is not eligible for incentives, if applicable. IncentivesIneligibilityReason *IncentivesIneligibilityReason `json:"uma_invitation_incentives_ineligibility_reason"` // Typename The typename of the object Typename string `json:"__typename"` }
UmaInvitation This is an object representing an UMA.ME invitation.
func (UmaInvitation) GetCreatedAt ¶ added in v0.7.0
func (obj UmaInvitation) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (UmaInvitation) GetId ¶ added in v0.7.0
func (obj UmaInvitation) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (UmaInvitation) GetTypename ¶ added in v0.7.0
func (obj UmaInvitation) GetTypename() string
func (UmaInvitation) GetUpdatedAt ¶ added in v0.7.0
func (obj UmaInvitation) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type UpdateChannelPerCommitmentPointInput ¶
type UpdateChannelPerCommitmentPointInput struct { ChannelId string `json:"update_channel_per_commitment_point_input_channel_id"` PerCommitmentPoint string `json:"update_channel_per_commitment_point_input_per_commitment_point"` PerCommitmentPointIndex int64 `json:"update_channel_per_commitment_point_input_per_commitment_point_index"` }
type UpdateChannelPerCommitmentPointOutput ¶
type UpdateChannelPerCommitmentPointOutput struct {
Channel types.EntityWrapper `json:"update_channel_per_commitment_point_output_channel"`
}
type UpdateNodeSharedSecretInput ¶
type UpdateNodeSharedSecretInput struct {}
type UpdateNodeSharedSecretOutput ¶
type UpdateNodeSharedSecretOutput struct {
}type Wallet ¶
type Wallet struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"wallet_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"wallet_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"wallet_updated_at"` // LastLoginAt The date and time when the wallet user last logged in. LastLoginAt *time.Time `json:"wallet_last_login_at"` // Balances The balances that describe the funds in this wallet. Balances *Balances `json:"wallet_balances"` // ThirdPartyIdentifier The unique identifier of this wallet, as provided by the Lightspark Customer during login. ThirdPartyIdentifier string `json:"wallet_third_party_identifier"` // Account The account this wallet belongs to. Account *types.EntityWrapper `json:"wallet_account"` // Status The status of this wallet. Status WalletStatus `json:"wallet_status"` // Typename The typename of the object Typename string `json:"__typename"` }
Wallet This object represents a Lightspark Wallet, tied to your Lightspark account. Wallets can be used to send or receive funds over the Lightning Network. You can retrieve this object to receive information about a specific wallet tied to your Lightspark account.
func (Wallet) GetCreatedAt ¶
GetCreatedAt The date and time when the entity was first created.
func (Wallet) GetId ¶
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (Wallet) GetPaymentRequests ¶
func (Wallet) GetTotalAmountReceived ¶
func (Wallet) GetTotalAmountSent ¶
func (Wallet) GetTransactions ¶
func (obj Wallet) GetTransactions(requester *requester.Requester, first *int64, after *string, createdAfterDate *time.Time, createdBeforeDate *time.Time, statuses *[]TransactionStatus, types *[]TransactionType) (*WalletToTransactionsConnection, error)
func (Wallet) GetTypename ¶ added in v0.6.1
func (Wallet) GetUpdatedAt ¶
GetUpdatedAt The date and time when the entity was last updated.
func (Wallet) GetWithdrawalRequests ¶ added in v0.7.1
type WalletStatus ¶
type WalletStatus int
WalletStatus This is an enum of the potential statuses that your Lightspark wallet can take.
const ( WalletStatusUndefined WalletStatus = iota // WalletStatusNotSetup The wallet has not been set up yet and is ready to be deployed. This is the default status after the first login. WalletStatusNotSetup // WalletStatusDeploying The wallet is currently being deployed in the Lightspark infrastructure. WalletStatusDeploying // WalletStatusDeployed The wallet has been deployed in the Lightspark infrastructure and is ready to be initialized. WalletStatusDeployed // WalletStatusInitializing The wallet is currently being initialized. WalletStatusInitializing // WalletStatusReady The wallet is available and ready to be used. WalletStatusReady WalletStatusUnavailable // WalletStatusFailed The wallet had an unrecoverable failure. This status is not expected to happend and will be investigated by the Lightspark team. WalletStatusFailed // WalletStatusTerminating The wallet is being terminated. WalletStatusTerminating // WalletStatusTerminated The wallet has been terminated and is not available in the Lightspark infrastructure anymore. It is not connected to the Lightning network and its funds can only be accessed using the Funds Recovery flow. WalletStatusTerminated )
func (WalletStatus) MarshalJSON ¶
func (a WalletStatus) MarshalJSON() ([]byte, error)
func (WalletStatus) StringValue ¶
func (a WalletStatus) StringValue() string
func (*WalletStatus) UnmarshalJSON ¶
func (a *WalletStatus) UnmarshalJSON(b []byte) error
type WalletToPaymentRequestsConnection ¶
type WalletToPaymentRequestsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"wallet_to_payment_requests_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"wallet_to_payment_requests_connection_page_info"` // Entities The payment requests for the current page of this connection. Entities []PaymentRequest `json:"wallet_to_payment_requests_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
func (WalletToPaymentRequestsConnection) GetCount ¶
func (obj WalletToPaymentRequestsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (WalletToPaymentRequestsConnection) GetPageInfo ¶
func (obj WalletToPaymentRequestsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (WalletToPaymentRequestsConnection) GetTypename ¶ added in v0.6.1
func (obj WalletToPaymentRequestsConnection) GetTypename() string
func (*WalletToPaymentRequestsConnection) UnmarshalJSON ¶
func (data *WalletToPaymentRequestsConnection) UnmarshalJSON(dataBytes []byte) error
type WalletToPaymentRequestsConnectionJSON ¶
type WalletToPaymentRequestsConnectionJSON struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"wallet_to_payment_requests_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"wallet_to_payment_requests_connection_page_info"` // Entities The payment requests for the current page of this connection. Entities []map[string]interface{} `json:"wallet_to_payment_requests_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
type WalletToTransactionsConnection ¶
type WalletToTransactionsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"wallet_to_transactions_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"wallet_to_transactions_connection_page_info"` // Entities The transactions for the current page of this connection. Entities []Transaction `json:"wallet_to_transactions_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
func (WalletToTransactionsConnection) GetCount ¶
func (obj WalletToTransactionsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (WalletToTransactionsConnection) GetPageInfo ¶
func (obj WalletToTransactionsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (WalletToTransactionsConnection) GetTypename ¶ added in v0.6.1
func (obj WalletToTransactionsConnection) GetTypename() string
func (*WalletToTransactionsConnection) UnmarshalJSON ¶
func (data *WalletToTransactionsConnection) UnmarshalJSON(dataBytes []byte) error
type WalletToTransactionsConnectionJSON ¶
type WalletToTransactionsConnectionJSON struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"wallet_to_transactions_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"wallet_to_transactions_connection_page_info"` // Entities The transactions for the current page of this connection. Entities []map[string]interface{} `json:"wallet_to_transactions_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
type WalletToWithdrawalRequestsConnection ¶ added in v0.7.1
type WalletToWithdrawalRequestsConnection struct { // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"wallet_to_withdrawal_requests_connection_count"` // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"wallet_to_withdrawal_requests_connection_page_info"` // Entities The withdrawal requests for the current page of this connection. Entities []WithdrawalRequest `json:"wallet_to_withdrawal_requests_connection_entities"` // Typename The typename of the object Typename string `json:"__typename"` }
func (WalletToWithdrawalRequestsConnection) GetCount ¶ added in v0.7.1
func (obj WalletToWithdrawalRequestsConnection) GetCount() int64
GetCount The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field).
func (WalletToWithdrawalRequestsConnection) GetPageInfo ¶ added in v0.7.1
func (obj WalletToWithdrawalRequestsConnection) GetPageInfo() PageInfo
GetPageInfo An object that holds pagination information about the objects in this connection.
func (WalletToWithdrawalRequestsConnection) GetTypename ¶ added in v0.7.1
func (obj WalletToWithdrawalRequestsConnection) GetTypename() string
type WebhookEventType ¶
type WebhookEventType int
WebhookEventType This is an enum of the potential event types that can be associated with your Lightspark wallets.
const ( WebhookEventTypeUndefined WebhookEventType = iota WebhookEventTypePaymentFinished WebhookEventTypeForceClosure WebhookEventTypeWithdrawalFinished WebhookEventTypeFundsReceived WebhookEventTypeNodeStatus WebhookEventTypeUmaInvitationClaimed WebhookEventTypeWalletStatus WebhookEventTypeWalletOutgoingPaymentFinished WebhookEventTypeWalletIncomingPaymentFinished WebhookEventTypeWalletWithdrawalFinished WebhookEventTypeWalletFundsReceived WebhookEventTypeRemoteSigning WebhookEventTypeLowBalance )
func (WebhookEventType) MarshalJSON ¶
func (a WebhookEventType) MarshalJSON() ([]byte, error)
func (WebhookEventType) StringValue ¶
func (a WebhookEventType) StringValue() string
func (*WebhookEventType) UnmarshalJSON ¶
func (a *WebhookEventType) UnmarshalJSON(b []byte) error
type Withdrawal ¶
type Withdrawal struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"withdrawal_id"` // CreatedAt The date and time when this transaction was initiated. CreatedAt time.Time `json:"withdrawal_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"withdrawal_updated_at"` // Status The current status of this transaction. Status TransactionStatus `json:"withdrawal_status"` // ResolvedAt The date and time when this transaction was completed or failed. ResolvedAt *time.Time `json:"withdrawal_resolved_at"` // Amount The amount of money involved in this transaction. Amount CurrencyAmount `json:"withdrawal_amount"` // TransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network. TransactionHash *string `json:"withdrawal_transaction_hash"` // Fees The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin blockchain. Fees *CurrencyAmount `json:"withdrawal_fees"` // BlockHash The hash of the block that included this transaction. This will be null for unconfirmed transactions. BlockHash *string `json:"withdrawal_block_hash"` // BlockHeight The height of the block that included this transaction. This will be zero for unconfirmed transactions. BlockHeight int64 `json:"withdrawal_block_height"` // DestinationAddresses The Bitcoin blockchain addresses this transaction was sent to. DestinationAddresses []string `json:"withdrawal_destination_addresses"` // NumConfirmations The number of blockchain confirmations for this transaction in real time. NumConfirmations *int64 `json:"withdrawal_num_confirmations"` // Origin The Lightspark node this withdrawal originated from. Origin types.EntityWrapper `json:"withdrawal_origin"` // Typename The typename of the object Typename string `json:"__typename"` }
Withdrawal This object represents an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can retrieve this object to receive detailed information about any L1 withdrawal associated with your Lightspark Node or account.
func (Withdrawal) GetAmount ¶
func (obj Withdrawal) GetAmount() CurrencyAmount
GetAmount The amount of money involved in this transaction.
func (Withdrawal) GetBlockHash ¶
func (obj Withdrawal) GetBlockHash() *string
GetBlockHash The hash of the block that included this transaction. This will be null for unconfirmed transactions.
func (Withdrawal) GetBlockHeight ¶
func (obj Withdrawal) GetBlockHeight() int64
GetBlockHeight The height of the block that included this transaction. This will be zero for unconfirmed transactions.
func (Withdrawal) GetCreatedAt ¶
func (obj Withdrawal) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (Withdrawal) GetDestinationAddresses ¶
func (obj Withdrawal) GetDestinationAddresses() []string
GetDestinationAddresses The Bitcoin blockchain addresses this transaction was sent to.
func (Withdrawal) GetFees ¶
func (obj Withdrawal) GetFees() *CurrencyAmount
GetFees The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin blockchain.
func (Withdrawal) GetId ¶
func (obj Withdrawal) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (Withdrawal) GetNumConfirmations ¶
func (obj Withdrawal) GetNumConfirmations() *int64
GetNumConfirmations The number of blockchain confirmations for this transaction in real time.
func (Withdrawal) GetResolvedAt ¶
func (obj Withdrawal) GetResolvedAt() *time.Time
GetResolvedAt The date and time when this transaction was completed or failed.
func (Withdrawal) GetStatus ¶
func (obj Withdrawal) GetStatus() TransactionStatus
GetStatus The current status of this transaction.
func (Withdrawal) GetTransactionHash ¶
func (obj Withdrawal) GetTransactionHash() *string
GetTransactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network.
func (Withdrawal) GetTypename ¶ added in v0.6.1
func (obj Withdrawal) GetTypename() string
func (Withdrawal) GetUpdatedAt ¶
func (obj Withdrawal) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type WithdrawalFeeEstimateInput ¶ added in v0.7.4
type WithdrawalFeeEstimateInput struct { // NodeId The node from which you'd like to make the withdrawal. NodeId string `json:"withdrawal_fee_estimate_input_node_id"` // AmountSats The amount you want to withdraw from this node in Satoshis. Use the special value -1 to withdrawal all funds from this node. AmountSats int64 `json:"withdrawal_fee_estimate_input_amount_sats"` // WithdrawalMode The strategy that should be used to withdraw the funds from this node. WithdrawalMode WithdrawalMode `json:"withdrawal_fee_estimate_input_withdrawal_mode"` }
type WithdrawalFeeEstimateOutput ¶ added in v0.7.4
type WithdrawalFeeEstimateOutput struct { // FeeEstimate The estimated fee for the withdrawal. FeeEstimate CurrencyAmount `json:"withdrawal_fee_estimate_output_fee_estimate"` }
type WithdrawalMode ¶
type WithdrawalMode int
WithdrawalMode This is an enum of the potential modes that your Bitcoin withdrawal can take.
const ( WithdrawalModeUndefined WithdrawalMode = iota WithdrawalModeWalletOnly WithdrawalModeWalletThenChannels )
func (WithdrawalMode) MarshalJSON ¶
func (a WithdrawalMode) MarshalJSON() ([]byte, error)
func (WithdrawalMode) StringValue ¶
func (a WithdrawalMode) StringValue() string
func (*WithdrawalMode) UnmarshalJSON ¶
func (a *WithdrawalMode) UnmarshalJSON(b []byte) error
type WithdrawalRequest ¶
type WithdrawalRequest struct { // Id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string. Id string `json:"withdrawal_request_id"` // CreatedAt The date and time when the entity was first created. CreatedAt time.Time `json:"withdrawal_request_created_at"` // UpdatedAt The date and time when the entity was last updated. UpdatedAt time.Time `json:"withdrawal_request_updated_at"` // RequestedAmount The requested amount of money to be withdrawn. If the requested amount is -1, it means to withdraw all. RequestedAmount CurrencyAmount `json:"withdrawal_request_requested_amount"` // Amount The amount of money that should be withdrawn in this request. // Deprecated: Use `requested_amount` instead Amount CurrencyAmount `json:"withdrawal_request_amount"` // EstimatedAmount If the requested amount is `-1` (i.e. everything), this field may contain an estimate of the amount for the withdrawal. EstimatedAmount *CurrencyAmount `json:"withdrawal_request_estimated_amount"` // AmountWithdrawn The actual amount that is withdrawn. It will be set once the request is completed. AmountWithdrawn *CurrencyAmount `json:"withdrawal_request_amount_withdrawn"` // BitcoinAddress The bitcoin address where the funds should be sent. BitcoinAddress string `json:"withdrawal_request_bitcoin_address"` // WithdrawalMode The strategy that should be used to withdraw the funds from the account. WithdrawalMode WithdrawalMode `json:"withdrawal_request_withdrawal_mode"` // Status The current status of this withdrawal request. Status WithdrawalRequestStatus `json:"withdrawal_request_status"` // CompletedAt The time at which this request was completed. CompletedAt *time.Time `json:"withdrawal_request_completed_at"` // Withdrawal The withdrawal transaction that has been generated by this request. Withdrawal *types.EntityWrapper `json:"withdrawal_request_withdrawal"` // Typename The typename of the object Typename string `json:"__typename"` }
WithdrawalRequest This object represents a request made for an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can retrieve this object to receive detailed information about any withdrawal request made from your Lightspark account.
func (WithdrawalRequest) GetChannelClosingTransactions ¶
func (obj WithdrawalRequest) GetChannelClosingTransactions(requester *requester.Requester, first *int64) (*WithdrawalRequestToChannelClosingTransactionsConnection, error)
func (WithdrawalRequest) GetChannelOpeningTransactions ¶
func (obj WithdrawalRequest) GetChannelOpeningTransactions(requester *requester.Requester, first *int64) (*WithdrawalRequestToChannelOpeningTransactionsConnection, error)
func (WithdrawalRequest) GetCreatedAt ¶
func (obj WithdrawalRequest) GetCreatedAt() time.Time
GetCreatedAt The date and time when the entity was first created.
func (WithdrawalRequest) GetId ¶
func (obj WithdrawalRequest) GetId() string
GetId The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
func (WithdrawalRequest) GetTypename ¶ added in v0.6.1
func (obj WithdrawalRequest) GetTypename() string
func (WithdrawalRequest) GetUpdatedAt ¶
func (obj WithdrawalRequest) GetUpdatedAt() time.Time
GetUpdatedAt The date and time when the entity was last updated.
type WithdrawalRequestStatus ¶
type WithdrawalRequestStatus int
WithdrawalRequestStatus This is an enum of the potential statuses that a Withdrawal can take.
const ( WithdrawalRequestStatusUndefined WithdrawalRequestStatus = iota WithdrawalRequestStatusCreated WithdrawalRequestStatusFailed WithdrawalRequestStatusInProgress WithdrawalRequestStatusSuccessful )
func (WithdrawalRequestStatus) MarshalJSON ¶
func (a WithdrawalRequestStatus) MarshalJSON() ([]byte, error)
func (WithdrawalRequestStatus) StringValue ¶
func (a WithdrawalRequestStatus) StringValue() string
func (*WithdrawalRequestStatus) UnmarshalJSON ¶
func (a *WithdrawalRequestStatus) UnmarshalJSON(b []byte) error
type WithdrawalRequestToChannelClosingTransactionsConnection ¶
type WithdrawalRequestToChannelClosingTransactionsConnection struct { // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"withdrawal_request_to_channel_closing_transactions_connection_page_info"` // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"withdrawal_request_to_channel_closing_transactions_connection_count"` // Entities The channel closing transactions for the current page of this connection. Entities []ChannelClosingTransaction `json:"withdrawal_request_to_channel_closing_transactions_connection_entities"` }
type WithdrawalRequestToChannelOpeningTransactionsConnection ¶
type WithdrawalRequestToChannelOpeningTransactionsConnection struct { // PageInfo An object that holds pagination information about the objects in this connection. PageInfo PageInfo `json:"withdrawal_request_to_channel_opening_transactions_connection_page_info"` // Count The total count of objects in this connection, using the current filters. It is different from the number of objects returned in the current page (in the `entities` field). Count int64 `json:"withdrawal_request_to_channel_opening_transactions_connection_count"` // Entities The channel opening transactions for the current page of this connection. Entities []ChannelOpeningTransaction `json:"withdrawal_request_to_channel_opening_transactions_connection_entities"` }
Source Files ¶
- account.go
- account_to_api_tokens_connection.go
- account_to_channels_connection.go
- account_to_nodes_connection.go
- account_to_payment_requests_connection.go
- account_to_transactions_connection.go
- account_to_wallets_connection.go
- account_to_withdrawal_requests_connection.go
- all_entities.go
- api_token.go
- balances.go
- bitcoin_network.go
- blockchain_balance.go
- cancel_invoice_input.go
- cancel_invoice_output.go
- channel.go
- channel_closing_transaction.go
- channel_fees.go
- channel_opening_transaction.go
- channel_snapshot.go
- channel_status.go
- channel_to_transactions_connection.go
- claim_uma_invitation_input.go
- claim_uma_invitation_output.go
- claim_uma_invitation_with_incentives_input.go
- claim_uma_invitation_with_incentives_output.go
- compliance_provider.go
- connection.go
- create_api_token_input.go
- create_api_token_output.go
- create_invitation_with_incentives_input.go
- create_invitation_with_incentives_output.go
- create_invoice_input.go
- create_invoice_output.go
- create_lnurl_invoice_input.go
- create_node_wallet_address_input.go
- create_node_wallet_address_output.go
- create_test_mode_invoice_input.go
- create_test_mode_invoice_output.go
- create_test_mode_payment_input.go
- create_test_mode_paymentoutput.go
- create_uma_invitation_input.go
- create_uma_invitation_output.go
- create_uma_invoice_input.go
- currency_amount.go
- currency_unit.go
- daily_liquidity_forecast.go
- decline_to_sign_messages_input.go
- decline_to_sign_messages_output.go
- delete_api_token_input.go
- delete_api_token_output.go
- deposit.go
- entity.go
- fee_estimate.go
- fund_node_input.go
- fund_node_output.go
- graph_node.go
- hop.go
- htlc_attempt_failure_code.go
- id_and_signature.go
- incentives_ineligibility_reason.go
- incentives_status.go
- incoming_payment.go
- incoming_payment_attempt.go
- incoming_payment_attempt_status.go
- incoming_payment_to_attempts_connection.go
- invoice.go
- invoice_data.go
- invoice_type.go
- lightning_fee_estimate_for_invoice_input.go
- lightning_fee_estimate_for_node_input.go
- lightning_fee_estimate_output.go
- lightning_payment_direction.go
- lightning_transaction.go
- lightspark_node.go
- lightspark_node_owner.go
- lightspark_node_status.go
- lightspark_node_to_channels_connection.go
- lightspark_node_to_daily_liquidity_forecasts_connection.go
- lightspark_node_with_o_s_k.go
- lightspark_node_with_remote_signing.go
- node.go
- node_address.go
- node_address_type.go
- node_to_addresses_connection.go
- on_chain_transaction.go
- outgoing_payment.go
- outgoing_payment_attempt.go
- outgoing_payment_attempt_status.go
- outgoing_payment_attempt_to_hops_connection.go
- outgoing_payment_to_attempts_connection.go
- outgoing_payments_for_invoice_query_input.go
- outgoing_payments_for_invoice_query_output.go
- page_info.go
- pay_invoice_input.go
- pay_invoice_output.go
- pay_uma_invoice_input.go
- payment_direction.go
- payment_failure_reason.go
- payment_request.go
- payment_request_data.go
- payment_request_status.go
- permission.go
- post_transaction_data.go
- region_code.go
- register_payment_input.go
- register_payment_output.go
- release_channel_per_commitment_secret_input.go
- release_channel_per_commitment_secret_output.go
- release_payment_preimage_input.go
- release_payment_preimage_output.go
- remote_signing_sub_event_type.go
- request_withdrawal_input.go
- request_withdrawal_output.go
- rich_text.go
- risk_rating.go
- routing_transaction.go
- routing_transaction_failure_reason.go
- screen_node_input.go
- screen_node_output.go
- secret.go
- send_payment_input.go
- send_payment_output.go
- set_invoice_payment_hash_input.go
- set_invoice_payment_hash_output.go
- sign_invoice_input.go
- sign_invoice_output.go
- sign_messages_input.go
- sign_messages_output.go
- signable.go
- signable_payload.go
- signable_payload_status.go
- transaction.go
- transaction_failures.go
- transaction_status.go
- transaction_type.go
- uma_invitation.go
- update_channel_per_commitment_point_input.go
- update_channel_per_commitment_point_output.go
- update_node_shared_secret_input.go
- update_node_shared_secret_output.go
- wallet.go
- wallet_status.go
- wallet_to_payment_requests_connection.go
- wallet_to_transactions_connection.go
- wallet_to_withdrawal_requests_connection.go
- webhook_event_type.go
- withdrawal.go
- withdrawal_fee_estimate_input.go
- withdrawal_fee_estimate_output.go
- withdrawal_mode.go
- withdrawal_request.go
- withdrawal_request_status.go
- withdrawal_request_to_channel_closing_transactions_connection.go
- withdrawal_request_to_channel_opening_transactions_connection.go