definitions.go

package bux

import (
	"time"
)

// Defaults for engine functionality
const (
	changeOutputSize               = uint64(35)        // Average size in bytes of a change output
	databaseLongReadTimeout        = 30 * time.Second  // For all "GET" or "SELECT" methods
	defaultBroadcastTimeout        = 25 * time.Second  // Default timeout for broadcasting
	defaultCacheLockTTL            = 20                // in Seconds
	defaultCacheLockTTW            = 10                // in Seconds
	defaultDatabaseReadTimeout     = 20 * time.Second  // For all "GET" or "SELECT" methods
	defaultDraftTxExpiresIn        = 20 * time.Second  // Default TTL for draft transactions
	defaultHTTPTimeout             = 20 * time.Second  // Default timeout for HTTP requests
	defaultOverheadSize            = uint64(8)         // 8 bytes is the default overhead in a transaction = 4 bytes version + 4 bytes nLockTime
	defaultQueryTxTimeout          = 10 * time.Second  // Default timeout for syncing on-chain information
	defaultSleepForNewBlockHeaders = 30 * time.Second  // Default wait before checking for a new unprocessed block
	defaultUserAgent               = "bux: " + version // Default user agent
	dustLimit                      = uint64(546)       // Dust limit
	mongoTestVersion               = "4.2.1"           // Mongo Testing Version
	sqliteTestVersion              = "3.37.0"          // SQLite Testing Version (dummy version for now)
	version                        = "v0.2.27"         // bux version
)

// All the base models
const (
	ModelAccessKey           ModelName = "access_key"
	ModelBlockHeader         ModelName = "block_header"
	ModelDestination         ModelName = "destination"
	ModelDraftTransaction    ModelName = "draft_transaction"
	ModelIncomingTransaction ModelName = "incoming_transaction"
	ModelMetadata            ModelName = "metadata"
	ModelNameEmpty           ModelName = "empty"
	ModelPaymailAddress      ModelName = "paymail_address"
	ModelSyncTransaction     ModelName = "sync_transaction"
	ModelTransaction         ModelName = "transaction"
	ModelUtxo                ModelName = "utxo"
	ModelXPub                ModelName = "xpub"
)

var (
	// AllModelNames is a list of all models
	AllModelNames = []ModelName{
		ModelAccessKey,
		ModelBlockHeader,
		ModelDestination,
		ModelIncomingTransaction,
		ModelMetadata,
		ModelPaymailAddress,
		ModelPaymailAddress,
		ModelSyncTransaction,
		ModelTransaction,
		ModelUtxo,
		ModelXPub,
	}
)

// Internal table names
const (
	tableAccessKeys           = "access_keys"
	tableBlockHeaders         = "block_headers"
	tableDestinations         = "destinations"
	tableDraftTransactions    = "draft_transactions"
	tableIncomingTransactions = "incoming_transactions"
	tablePaymailAddresses     = "paymail_addresses"
	tableSyncTransactions     = "sync_transactions"
	tableTransactions         = "transactions"
	tableUTXOs                = "utxos"
	tableXPubs                = "xpubs"
)

const (
	// ReferenceIDField is used for Paymail
	ReferenceIDField = "reference_id"

	// Internal field names
	aliasField           = "alias"
	broadcastStatusField = "broadcast_status"
	currentBalanceField  = "current_balance"
	domainField          = "domain"
	draftIDField         = "draft_id"
	idField              = "id"
	metadataField        = "metadata"
	nextExternalNumField = "next_external_num"
	nextInternalNumField = "next_internal_num"
	p2pStatusField       = "p2p_status"
	satoshisField        = "satoshis"
	spendingTxIDField    = "spending_tx_id"
	statusField          = "status"
	syncStatusField      = "sync_status"
	typeField            = "type"
	xPubIDField          = "xpub_id"
	xPubMetadataField    = "xpub_metadata"

	// Universal statuses
	statusCanceled   = "canceled"
	statusComplete   = "complete"
	statusDraft      = "draft"
	statusError      = "error"
	statusExpired    = "expired"
	statusPending    = "pending"
	statusProcessing = "processing"
	statusReady      = "ready"
	statusSkipped    = "skipped"

	// Paymail / Handles
	cacheKeyAddressResolution       = "paymail-address-resolution-"
	cacheKeyCapabilities            = "paymail-capabilities-"
	cacheTTLAddressResolution       = 2 * time.Minute
	cacheTTLCapabilities            = 60 * time.Minute
	defaultAddressResolutionPurpose = "Created with BUX: getbux.io"
	defaultSenderPaymail            = "buxorg@moneybutton.com"
	handleHandcashPrefix            = "$"
	handleMaxLength                 = 25
	handleRelayPrefix               = "1"
	p2pMetadataField                = "p2p_tx_metadata"

	// Misc
	gormTypeText = "text"
	migrateList  = "migrate"
	modelList    = "models"
)

// Cache keys for model caching
const (
	cacheKeyDestinationModel                = "destination-id-%s"             // model-id-<destination_id>
	cacheKeyDestinationModelByAddress       = "destination-address-%s"        // model-address-<address>
	cacheKeyDestinationModelByLockingScript = "destination-locking-script-%s" // model-locking-script-<script>
	cacheKeyXpubModel                       = "xpub-id-%s"                    // model-id-<xpub_id>
)

var (

	// BaseModels is the list of models for loading the engine and AutoMigration (defaults)
	BaseModels = []interface{}{

		// Base extended HD-key table
		&Xpub{
			Model: *NewBaseModel(ModelXPub),
		},

		// Access keys (extend access from xPub)
		&AccessKey{
			Model: *NewBaseModel(ModelAccessKey),
		},

		// Draft transactions are created before the final transaction is completed
		&DraftTransaction{
			Model: *NewBaseModel(ModelDraftTransaction),
		},

		// Incoming transactions (external & unknown) (related to Transaction & Draft)
		&IncomingTransaction{
			Model: *NewBaseModel(ModelIncomingTransaction),
		},

		// Finalized transactions (related to Draft)
		&Transaction{
			Model: *NewBaseModel(ModelTransaction),
		},

		// Block Headers as received by the BitCoin network
		&BlockHeader{
			Model: *NewBaseModel(ModelBlockHeader),
		},

		// Sync configuration for transactions (on-chain) (related to Transaction)
		&SyncTransaction{
			Model: *NewBaseModel(ModelSyncTransaction),
		},

		// Various types of destinations (common is: P2PKH Address)
		&Destination{
			Model: *NewBaseModel(ModelDestination),
		},

		// Unspent outputs from known transactions
		&Utxo{
			Model: *NewBaseModel(ModelUtxo),
		},

		// Paymail addresses related to XPubs (automatically added when paymail is enabled)
		/*&PaymailAddress{
			Model: *NewBaseModel(ModelPaymailAddress),
		},*/
	}
)