Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

state change schema & type definitions #135

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

state change schema & type definitions #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae7b52e
state change schema & type definitions
gouthamp-stellar Feb 21, 2025
655e16d
make toid a BIGINT instead of TEXT, add indices for opeationtoid and …
gouthamp-stellar Feb 21, 2025
0b01b98
toid *string -> *int64 in type StateChange
gouthamp-stellar Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 120 additions & 0 deletions internal/db/migrations/2025-02-19.0-statechange_schema.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
-- +migrate Up


CREATE TYPE statechangetype_enum AS ENUM (
'DEBIT',
'CREDIT',
'HOMEDOMAIN',
'FLAGS',
'SIGNERS',
'DATAENTRY',
'ALLOWANCE',
'BALANCEAUTHORIZATION',
'THRESHOLDS',
'AUTHORIZATION'
);

CREATE TYPE statechangereason_enum AS ENUM (
'CREATEACCOUNT',
'MERGEACCOUNT',
'PAYMENT',
'CREATECLAIMABLEBALANCE',
'CLAIMCLAIMABLEBALANCE',
'CLAWBACK',
'LIQUIDITYPOOLDEPOSIT',
'LIQUIDITYPOOLWITHDRAW',
'OFFERS',
'PATHPAYMENT',
'FEE'
'TRANSFER',
'CONTRACT_TRANSFER',
'CONTRACT_MINT',
'CONTRACT_BURN',
'CONTRACT_CLAWBACK'
'FLAGS_CLEARED',
'FLAGS_SET',
'SIGNERS_ADDED',
'SIGNERS_UPDATED',
'SINGERS_REMOVED',
'ALLOWANCE_SET',
'ALLOWANCE_CONSUMED'
);

-- Transactions Table
CREATE TABLE transactions (
txhash VARCHAR(64) PRIMARY KEY,
transactionxdr TEXT NOT NULL,
txmeta TEXT,
ts TIMESTAMP NOT NULL
);

-- Operations Table
CREATE TABLE operations (
toid BIGINT PRIMARY KEY,
txhash VARCHAR(64) NOT NULL REFERENCES transactions(txhash) ON DELETE CASCADE,
operationindex INTEGER NOT NULL,
operationtype INTEGER NOT NULL,
ts TIMESTAMP NOT NULL
);

-- State Changes Table
CREATE TABLE statechanges (
id SERIAL PRIMARY KEY,
acctid TEXT NOT NULL,
operationtoid BIGINT REFERENCES operations(toid) ON DELETE CASCADE,
txhash VARCHAR(64) NOT NULL REFERENCES transactions(txhash) ON DELETE CASCADE,
statechangetype statechangetype_enum NOT NULL,
statechangereason statechangereason_enum NOT NULL,
changemetadata JSONB,
asset TEXT,
amount FLOAT,
lowthreshold INTEGER,
mediumthreshold INTEGER,
highthreshold INTEGER,
flags_cleared TEXT[],
flags_set TEXT[],
homedomain TEXT,
signer_added JSONB,
signer_removed JSONB,
signer_updated JSONB,
data_entry JSONB,
balance_authorization BOOLEAN,
contract_address TEXT,
function_name TEXT,
ts TIMESTAMP NOT NULL
);

-- Indexes for optimized queries
CREATE INDEX idx_transactions_ts ON transactions (ts);

CREATE INDEX idx_operations_txhash ON operations (txhash);
CREATE INDEX idx_operations_operationtype ON operations (operationtype);
CREATE INDEX idx_operations_ts ON operations (ts);

CREATE INDEX idx_statechanges_acctid ON statechanges (acctid);
CREATE INDEX idx_statechanges_operationtoid ON statechanges (operationtoid);
CREATE INDEX idx_statechanges_txhash ON statechanges (txhash);
CREATE INDEX idx_statechanges_statechangetype ON statechanges (statechangetype);
CREATE INDEX idx_statechanges_statechangereason ON statechanges (statechangereason);
CREATE INDEX idx_statechanges_ts ON statechanges (ts);

-- +migrate Down

DROP INDEX IF EXISTS idx_transactions_ts;
DROP INDEX IF EXISTS idx_operations_txhash;
DROP INDEX IF EXISTS idx_operations_operationtype;
DROP INDEX IF EXISTS idx_operations_ts;
DROP INDEX IF EXISTS idx_statechanges_acctid;
DROP INDEX IF EXISTS idx_statechanges_operationtoid;
DROP INDEX IF EXISTS idx_statechanges_txhash;
DROP INDEX IF EXISTS idx_statechanges_statechangetype;
DROP INDEX IF EXISTS idx_statechanges_statechangereason;
DROP INDEX IF EXISTS idx_statechanges_ts;

DROP TABLE IF EXISTS statechanges;
DROP TABLE IF EXISTS operations;
DROP TABLE IF EXISTS transactions;

DROP TYPE IF EXISTS operationtype_enum;
DROP TYPE IF EXISTS statechangetype_enum;
DROP TYPE IF EXISTS statechangereason_enum;
89 changes: 89 additions & 0 deletions internal/statechanges/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
package statechanges

import (
"time"
)

type Transaction struct {
TxHash string `db:"txhash"`
TransactionXDR string `db:"transactionxdr"`
TxMeta *string `db:"txmeta"`
TS time.Time `db:"ts"`
}

type Operation struct {
ToID string `db:"toid"`
TxHash string `db:"txhash"`
OperationIndex int `db:"operationindex"`
OperationType int `db:"operationtype"`
TS time.Time `db:"ts"`
}

type StateChangeType string

const (
StateChangeDebit StateChangeType = "DEBIT"
StateChangeCredit StateChangeType = "CREDIT"
StateChangeHomeDomain StateChangeType = "HOMEDOMAIN"
StateChangeFlags StateChangeType = "FLAGS"
StateChangeSigners StateChangeType = "SIGNERS"
StateChangeDataEntry StateChangeType = "DATAENTRY"
StateChangeAllowance StateChangeType = "ALLOWANCE"
StateChangeBalanceAuthorization StateChangeType = "BALANCEAUTHORIZATION"
StateChangeThresholds StateChangeType = "THRESHOLDS"
StateChangeAuthorization StateChangeType = "AUTHORIZATION"
)

type StateChangeReason string

const (
ReasonCreateAccount StateChangeReason = "CREATEACCOUNT"
ReasonMergeAccount StateChangeReason = "MERGEACCOUNT"
ReasonPayment StateChangeReason = "PAYMENT"
ReasonCreateClaimableBalance StateChangeReason = "CREATECLAIMABLEBALANCE"
ReasonClaimClaimableBalance StateChangeReason = "CLAIMCLAIMABLEBALANCE"
ReasonClawback StateChangeReason = "CLAWBACK"
ReasonLiquidityPoolDeposit StateChangeReason = "LIQUIDITYPOOLDEPOSIT"
ReasonLiquidityPoolWithdraw StateChangeReason = "LIQUIDITYPOOLWITHDRAW"
ReasonOffers StateChangeReason = "OFFERS"
ReasonPathPayment StateChangeReason = "PATHPAYMENT"
ReasonFee StateChangeReason = "FEE"
ReasonTransfer StateChangeReason = "TRANSFER"
ReasonContractTransfer StateChangeReason = "CONTRACT_TRANSFER"
ReasonContractMint StateChangeReason = "CONTRACT_MINT"
ReasonContractBurn StateChangeReason = "CONTRACT_BURN"
ReasonContractClawback StateChangeReason = "CONTRACT_CLAWBACK"
ReasonFlagsCleared StateChangeReason = "FLAGS_CLEARED"
ReasonFlagsSet StateChangeReason = "FLAGS_SET"
ReasonSignersAdded StateChangeReason = "SIGNERS_ADDED"
ReasonSignersUpdated StateChangeReason = "SIGNERS_UPDATED"
ReasonSignersRemoved StateChangeReason = "SIGNERS_REMOVED"
ReasonAllowanceSet StateChangeReason = "ALLOWANCE_SET"
ReasonAllowanceConsumed StateChangeReason = "ALLOWANCE_CONSUMED"
)

type StateChange struct {
ID int64 `db:"id"`
AcctID string `db:"acctid"`
OperationTOID *int64 `db:"operationtoid"`
TxHash string `db:"txhash"`
StateChangeType StateChangeType `db:"statechangetype"`
StateChangeReason StateChangeReason `db:"statechangereason"`
ChangeMetadata string `db:"changemetadata"` // JSONB stored as string
Asset *string `db:"asset"`
Amount *float64 `db:"amount"`
LowThreshold *int `db:"lowthreshold"`
MediumThreshold *int `db:"mediumthreshold"`
HighThreshold *int `db:"highthreshold"`
FlagsCleared []string `db:"flags_cleared"`
FlagsSet []string `db:"flags_set"`
HomeDomain *string `db:"homedomain"`
SignerAdded string `db:"signer_added"` // JSONB stored as string
SignerRemoved string `db:"signer_removed"` // JSONB stored as string
SignerUpdated string `db:"signer_updated"` // JSONB stored as string
DataEntry string `db:"data_entry"` // JSONB stored as string
BalanceAuthorization *bool `db:"balance_authorization"`
ContractAddress *string `db:"contract_address"`
FunctionName *string `db:"function_name"`
TS time.Time `db:"ts"`
}