inputs

Documentation

Index

• type Selector
  • func NewSelector(db *gorm.DB, feeUnit bsv.FeeUnit) Selector

Examples

• Selector (BuildQueryForInputs_postgresql)
• Selector (BuildQueryForInputs_sqlite)
• Selector (BuildUpdateTouchedAtQuery_postgres)
• Selector (BuildUpdateTouchedAtQuery_sqlite)

Types

type Selector

type Selector interface {
	SelectInputsForTransaction(ctx context.Context, userID string, satoshis bsv.Satoshis, byteSizeOfTxBeforeAddingSelectedInputs uint64) ([]*database.UserUTXO, error)
}

Selector is a service that selects inputs for transaction.

Example (BuildQueryForInputs_postgresql)

ExampleSelector_buildQueryForInputs_postgresql demonstrates what would be the query used to select inputs for a transaction.

db := tgorm.GormDBForPrintingSQL(tgorm.PostgreSQL)

// and:
selector := givenInputsSelector(db)

query := db.ToSQL(func(db *gorm.DB) *gorm.DB {
	query := selector.buildQueryForInputs(db, "someuserid", 1, 10)
	query.Find(&database.UserUTXO{})
	return query
})

fmt.Println(query)

Output:

SELECT * FROM "xapi_user_utxos" WHERE (tx_id, vout) in (SELECT tx_id,vout FROM (SELECT tx_id,vout,change,min(case when change >= 0 then change end) over () as min_change FROM (SELECT tx_id,vout,case when remaining_value - fee_no_change_output <= 0 then remaining_value - fee_no_change_output else remaining_value - fee_with_change_output end as change FROM (SELECT "tx_id","vout",sum(satoshis) over (order by touched_at ASC, created_at ASC, tx_id ASC, vout ASC) - 1 as remaining_value,ceil((sum(estimated_input_size) over (order by touched_at ASC, created_at ASC, tx_id ASC, vout ASC) + 10) / cast(1000 as float)) * 1 as fee_no_change_output,ceil((sum(estimated_input_size) over (order by touched_at ASC, created_at ASC, tx_id ASC, vout ASC) + 10 + 34) / cast(1000 as float)) * 1 as fee_with_change_output FROM "xapi_user_utxos" WHERE user_id = 'someuserid') as utxo) as utxoWithChange) as utxoWithMinChange WHERE change <= min_change)

Example (BuildQueryForInputs_sqlite)

ExampleSelector_buildQueryForInputs_sqlite demonstrates what would be the query used to select inputs for a transaction.

db := tgorm.GormDBForPrintingSQL(tgorm.SQLite)

// and:
selector := givenInputsSelector(db)

query := db.ToSQL(func(db *gorm.DB) *gorm.DB {
	query := selector.buildQueryForInputs(db, "someuserid", 1, 10)
	query.Find(&database.UserUTXO{})
	return query
})

fmt.Println(query)

Output:

SELECT * FROM `xapi_user_utxos` WHERE (tx_id, vout) in (SELECT tx_id,vout FROM (SELECT tx_id,vout,change,min(case when change >= 0 then change end) over () as min_change FROM (SELECT tx_id,vout,case when remaining_value - fee_no_change_output <= 0 then remaining_value - fee_no_change_output else remaining_value - fee_with_change_output end as change FROM (SELECT `tx_id`,`vout`,sum(satoshis) over (order by touched_at ASC, created_at ASC, tx_id ASC, vout ASC) - 1 as remaining_value,ceil((sum(estimated_input_size) over (order by touched_at ASC, created_at ASC, tx_id ASC, vout ASC) + 10) / cast(1000 as float)) * 1 as fee_no_change_output,ceil((sum(estimated_input_size) over (order by touched_at ASC, created_at ASC, tx_id ASC, vout ASC) + 10 + 34) / cast(1000 as float)) * 1 as fee_with_change_output FROM `xapi_user_utxos` WHERE user_id = "someuserid") as utxo) as utxoWithChange) as utxoWithMinChange WHERE change <= min_change)

Example (BuildUpdateTouchedAtQuery_postgres)

ExampleSelector_buildUpdateTouchedAtQuery_postgres demonstrates what would be the SQL statement used to update inputs after selecting them.

db := tgorm.GormDBForPrintingSQL(tgorm.PostgreSQL)

selector := givenInputsSelector(db)

utxos := []*database.UserUTXO{
	{UserID: "id_of_user_1", TxID: "tx_id_1", Vout: 0, Satoshis: 10, EstimatedInputSize: 148, Bucket: "bsv", CreatedAt: time.Now(), TouchedAt: time.Now()},
	{UserID: "id_of_user_1", TxID: "tx_id_1", Vout: 1, Satoshis: 10, EstimatedInputSize: 148, Bucket: "bsv", CreatedAt: time.Now(), TouchedAt: time.Now()},
	{UserID: "id_of_user_1", TxID: "tx_id_2", Vout: 0, Satoshis: 10, EstimatedInputSize: 148, Bucket: "bsv", CreatedAt: time.Now(), TouchedAt: time.Now()},
}

query := db.ToSQL(func(db *gorm.DB) *gorm.DB {
	query := selector.buildUpdateTouchedAtQuery(db, utxos)
	query.UpdateColumn("touched_at", time.Date(2006, 02, 01, 15, 4, 5, 7, time.UTC))
	return query
})

fmt.Println(query)

Output:

UPDATE "xapi_user_utxos" SET "touched_at"='2006-02-01 15:04:05' WHERE (tx_id, vout) in (('tx_id_1',0),('tx_id_1',1),('tx_id_2',0))

Example (BuildUpdateTouchedAtQuery_sqlite)

ExampleSelector_buildUpdateTouchedAtQuery_sqlite demonstrates what would be the SQL statement used to update inputs after selecting them.

db := tgorm.GormDBForPrintingSQL(tgorm.SQLite)

selector := givenInputsSelector(db)

utxos := []*database.UserUTXO{
	{UserID: "id_of_user_1", TxID: "tx_id_1", Vout: 0, Satoshis: 10, EstimatedInputSize: 148, Bucket: "bsv", CreatedAt: time.Now(), TouchedAt: time.Now()},
	{UserID: "id_of_user_1", TxID: "tx_id_1", Vout: 1, Satoshis: 10, EstimatedInputSize: 148, Bucket: "bsv", CreatedAt: time.Now(), TouchedAt: time.Now()},
	{UserID: "id_of_user_1", TxID: "tx_id_2", Vout: 0, Satoshis: 10, EstimatedInputSize: 148, Bucket: "bsv", CreatedAt: time.Now(), TouchedAt: time.Now()},
}

query := db.ToSQL(func(db *gorm.DB) *gorm.DB {
	query := selector.buildUpdateTouchedAtQuery(db, utxos)
	query.UpdateColumn("touched_at", time.Date(2006, 02, 01, 15, 4, 5, 7, time.UTC))
	return query
})

fmt.Println(query)

Output:

UPDATE `xapi_user_utxos` SET `touched_at`="2006-02-01 15:04:05" WHERE (tx_id, vout) in (("tx_id_1",0),("tx_id_1",1),("tx_id_2",0))

func NewSelector

func NewSelector(db *gorm.DB, feeUnit bsv.FeeUnit) Selector

NewSelector creates a new instance of Selector.