db

Documentation

Index

• Constants
• func Close(conn *sqlite.Conn, pool *sqlitex.Pool) error
• func OpenConnPool(ctx context.Context, dbURI string) (conn *sqlite.Conn, pool *sqlitex.Pool, err error)
• type FATChain
  • func NewFATChain(ctx context.Context, dbPath, tokenID string, ...) (_ FATChain, err error)
  • func OpenAllFATChains(ctx context.Context, dbPath string) (chains []FATChain, err error)
  • func OpenFATChain(ctx context.Context, dbPath, fname string) (chain FATChain, err error)
  • func (chain *FATChain) AddNumIssued(add uint64) error
• type FactomChain
  • func NewFactomChain(ctx context.Context, dbPath string, chainID *factom.Bytes32, ...) (_ FactomChain, err error)
  • func OpenFactomChain(ctx context.Context, dbPath, fname string) (_ FactomChain, err error)
  • func (chain *FactomChain) Close() error
  • func (chain *FactomChain) LatestEntryTimestamp() time.Time
  • func (chain *FactomChain) SetSync(height uint32, dbKeyMR *factom.Bytes32) error

Constants

const ApplicationID int32 = 0x0FA7D000

const (

	// TODO: expose this as flag
	PoolSize = 2
)

Functions

func Close

func Close(conn *sqlite.Conn, pool *sqlitex.Pool) error

Close all database connections. Log any errors.

func OpenConnPool

func OpenConnPool(ctx context.Context, dbURI string) (
	conn *sqlite.Conn, pool *sqlitex.Pool, err error)

OpenConnPool opens a Conn to the sqlite3 database at dbURI and performs a number of checks and operations to ensure that the Conn is ready for use. The Interrupt on the Conn is set to ctx.Done().

If the Conn is successfully initialized a read-only Pool will be opened on the same database.

The caller is responsible for closing conn and pool if err is not nil.

Types

type FATChain

type FATChain struct {
	// FAT Specific Data
	TokenID       string
	IssuerChainID *factom.Bytes32
	Identity      factom.Identity
	Issuance      fat.Issuance
	NumIssued     uint64

	// General Factom Blockchain Data
	FactomChain
}

func NewFATChain

func NewFATChain(ctx context.Context, dbPath, tokenID string,
	chainID, issuerChainID *factom.Bytes32,
	networkID factom.NetworkID) (_ FATChain, err error)

func OpenAllFATChains

func OpenAllFATChains(ctx context.Context, dbPath string) (chains []FATChain, err error)

func OpenFATChain

func OpenFATChain(ctx context.Context,
	dbPath, fname string) (chain FATChain, err error)

func (*FATChain) AddNumIssued

func (chain *FATChain) AddNumIssued(add uint64) error

type FactomChain

type FactomChain struct {
	ID          *factom.Bytes32
	Head        factom.EBlock
	HeadDBKeyMR *factom.Bytes32
	NetworkID   factom.NetworkID
	SyncHeight  uint32
	SyncDBKeyMR *factom.Bytes32

	DBFile   string
	Conn     *sqlite.Conn  // Read/Write
	Pool     *sqlitex.Pool // Read Only Pool
	CloseMtx trylock.TryLocker

	Log _log.Log
}

func NewFactomChain

func NewFactomChain(ctx context.Context,
	dbPath string, chainID *factom.Bytes32,
	networkID factom.NetworkID) (_ FactomChain, err error)

func OpenFactomChain

func OpenFactomChain(ctx context.Context,
	dbPath, fname string) (_ FactomChain, err error)

func (*FactomChain) Close

func (chain *FactomChain) Close() error

Close all database connections. Log any errors.

func (*FactomChain) LatestEntryTimestamp

func (chain *FactomChain) LatestEntryTimestamp() time.Time

func (*FactomChain) SetSync

func (chain *FactomChain) SetSync(height uint32, dbKeyMR *factom.Bytes32) error