Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessKeyFilter ¶ added in v0.28.0
type AccessKeyFilter struct { ModelFilter `json:",inline"` // RevokedRange specifies the time range when a record was revoked. RevokedRange *TimeRange `json:"revokedRange,omitempty"` }
AccessKeyFilter is a struct for handling request parameters for destination search requests
func (*AccessKeyFilter) ToDbConditions ¶ added in v0.28.0
func (d *AccessKeyFilter) ToDbConditions() map[string]interface{}
ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy
type AdminAccessKeyFilter ¶ added in v0.28.0
type AdminAccessKeyFilter struct { AccessKeyFilter `json:",inline"` XpubID *string `json:"xpubId,omitempty"` }
AdminAccessKeyFilter wraps the AccessKeyFilter providing additional fields for admin access key search requests
func (*AdminAccessKeyFilter) ToDbConditions ¶ added in v0.28.0
func (d *AdminAccessKeyFilter) ToDbConditions() map[string]interface{}
ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy
type AdminPaymailFilter ¶ added in v0.28.0
type AdminPaymailFilter struct { ModelFilter `json:",inline"` ID *string `json:"id,omitempty" example:"ffb86c103d17d87c15aaf080aab6be5415c9fa885309a79b04c9910e39f2b542"` XpubID *string `json:"xpubId,omitempty" example:"79f90a6bab0a44402fc64828af820e9465645658aea2d138c5205b88e6dabd00"` Alias *string `json:"alias,omitempty" example:"alice"` Domain *string `json:"domain,omitempty" example:"example.com"` PublicName *string `json:"publicName,omitempty" example:"Alice"` }
AdminPaymailFilter is a struct for handling request parameters for paymail_addresses search requests
func (*AdminPaymailFilter) ToDbConditions ¶ added in v0.28.0
func (d *AdminPaymailFilter) ToDbConditions() map[string]interface{}
ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy
type AdminUtxoFilter ¶ added in v0.28.0
type AdminUtxoFilter struct { UtxoFilter `json:",inline"` XpubID *string `json:"xpubId,omitempty"` }
AdminUtxoFilter wraps the UtxoFilter providing additional fields for admin utxo search requests
func (*AdminUtxoFilter) ToDbConditions ¶ added in v0.28.0
func (d *AdminUtxoFilter) ToDbConditions() (map[string]interface{}, error)
ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy
type ContactFilter ¶ added in v0.28.0
type ContactFilter struct { ModelFilter `json:",inline"` ID *string `json:"id" example:"ffdbe74e-0700-4710-aac5-611a1f877c7f"` FullName *string `json:"fullName" example:"Alice"` Paymail *string `json:"paymail" example:"alice@example.com"` PubKey *string `json:"pubKey" example:"0334f01ecb971e93db179e6fb320cd1466beb0c1ec6c1c6a37aa6cb02e53d5dd1a"` Status *string `json:"status,omitempty" enums:"unconfirmed,awaiting,confirmed,rejected"` }
ContactFilter is a struct for handling request parameters for contact search requests
func (*ContactFilter) ToDbConditions ¶ added in v0.28.0
func (d *ContactFilter) ToDbConditions() (map[string]interface{}, error)
ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy
type DestinationFilter ¶
type DestinationFilter struct { ModelFilter `json:",inline"` LockingScript *string `json:"lockingScript,omitempty" example:"76a9147b05764a97f3b4b981471492aa703b188e45979b88ac"` Address *string `json:"address,omitempty" example:"1CDUf7CKu8ocTTkhcYUbq75t14Ft168K65"` DraftID *string `json:"draftId,omitempty" example:"b356f7fa00cd3f20cce6c21d704cd13e871d28d714a5ebd0532f5a0e0cde63f7"` }
DestinationFilter is a struct for handling request parameters for destination search requests
func (*DestinationFilter) ToDbConditions ¶
func (d *DestinationFilter) ToDbConditions() map[string]interface{}
ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy
type ModelFilter ¶
type ModelFilter struct { // IncludeDeleted is a flag whether or not to include deleted items in the search results IncludeDeleted *bool `json:"includeDeleted,omitempty" swaggertype:"boolean" default:"false" example:"true"` // CreatedRange specifies the time range when a record was created. CreatedRange *TimeRange `json:"createdRange,omitempty"` // UpdatedRange specifies the time range when a record was updated. UpdatedRange *TimeRange `json:"updatedRange,omitempty"` }
ModelFilter is a common model filter that contains common fields for all model filters.
func (*ModelFilter) ToDbConditions ¶
func (mf *ModelFilter) ToDbConditions() map[string]interface{}
ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy
type TimeRange ¶
type TimeRange struct { // From specifies the start time of the range. It's optional and can be nil. From *time.Time `json:"from,omitempty" example:"2024-02-26T11:01:28Z"` // To specifies the end time of the range. It's optional and can be nil. To *time.Time `json:"to,omitempty" example:"2024-02-26T11:01:28Z"` }
TimeRange defines a range between two points in time.
func (*TimeRange) ToDbConditions ¶
ToDbConditions converts the TimeRange to a set of database query conditions. Returns nil if both From and To are nil or zero, indicating no conditions.
type TransactionFilter ¶
type TransactionFilter struct { ModelFilter `json:",inline"` Hex *string `json:"hex,omitempty"` BlockHash *string `json:"blockHash,omitempty" example:"0000000000000000031928c28075a82d7a00c2c90b489d1d66dc0afa3f8d26f8"` BlockHeight *uint64 `json:"blockHeight,omitempty" example:"839376"` Fee *uint64 `json:"fee,omitempty" example:"1"` NumberOfInputs *uint32 `json:"numberOfInputs,omitempty" example:"1"` NumberOfOutputs *uint32 `json:"numberOfOutputs,omitempty" example:"2"` DraftID *string `json:"draftId,omitempty" example:"d425432e0d10a46af1ec6d00f380e9581ebf7907f3486572b3cd561a4c326e14"` TotalValue *uint64 `json:"totalValue,omitempty" example:"100000000"` Status *string `` /* 204-byte string literal not displayed */ }
TransactionFilter is a struct for handling request parameters for transactions search requests
func (*TransactionFilter) ToDbConditions ¶
func (d *TransactionFilter) ToDbConditions() map[string]interface{}
ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy
type UtxoFilter ¶ added in v0.28.0
type UtxoFilter struct { ModelFilter `json:",inline"` TransactionID *string `json:"transactionId,omitempty" example:"5e17858ea0ca4155827754ba82bdcfcce108d5bb5b47fbb3aa54bd14540683c6"` OutputIndex *uint32 `json:"outputIndex,omitempty" example:"0"` ID *string `json:"id,omitempty" example:"fe4cbfee0258aa589cbc79963f7c204061fd67d987e32ee5049aa90ce14658ee"` Satoshis *uint64 `json:"satoshis,omitempty" example:"1"` ScriptPubKey *string `json:"scriptPubKey,omitempty" example:"76a914a5f271385e75f57bcd9092592dede812f8c466d088ac"` Type *string `json:"type,omitempty" enums:"pubkey,pubkeyhash,nulldata,multisig,nonstandard,scripthash,metanet,token_stas,token_sensible"` DraftID *string `json:"draftId,omitempty" example:"89419d4c7c50810bfe5ff9df9ad5074b749959423782dc91a30f1058b9ad7ef7"` ReservedRange *TimeRange `json:"reservedRange,omitempty"` // ReservedRange specifies the time range when a UTXO was reserved. SpendingTxID *string `json:"spendingTxId,omitempty" example:"11a7746489a70e9c0170601c2be65558455317a984194eb2791b637f59f8cd6e"` }
UtxoFilter is a struct for handling request parameters for utxo search requests
func (*UtxoFilter) ToDbConditions ¶ added in v0.28.0
func (d *UtxoFilter) ToDbConditions() (map[string]interface{}, error)
ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy
type XpubFilter ¶ added in v0.28.0
type XpubFilter struct { ModelFilter `json:",inline"` ID *string `json:"id,omitempty" example:"00b953624f78004a4c727cd28557475d5233c15f17aef545106639f4d71b712d"` CurrentBalance *uint64 `json:"currentBalance,omitempty" example:"1000"` }
XpubFilter is a struct for handling request parameters for utxo search requests
func (*XpubFilter) ToDbConditions ¶ added in v0.28.0
func (d *XpubFilter) ToDbConditions() map[string]interface{}
ToDbConditions converts filter fields to the datastore conditions using gorm naming strategy