core

package
v1.2.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 24, 2021 License: GPL-3.0 Imports: 16 Imported by: 0

README

Core package define models & interface used by Pando project

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func SortOutputs 

func SortOutputs(outputs []*Output)

Types

type Action 

type Action int
const (
	// System Actions
	ActionSys Action = iota + 0
	// Withdraw Asset from multisig wallet, Gov required
	ActionSysWithdraw
)
const (
	// System Actions
	ActionProposal Action = iota + 10
	// Make a new proposal
	ActionProposalMake
	// Call on other mtg members to vote for this proposal, mtg member only
	ActionProposalShout
	// Vote for this proposal, mtg member only
	ActionProposalVote
)
const (
	// Collateral Actions
	ActionCat Action = iota + 20
	// Create a new collateral type, Gov required
	ActionCatCreate
	// Supply Dai to this collateral type
	ActionCatSupply
	// Edit Collateral parameters, Gov required
	ActionCatEdit
	// Update Collateral's Rate
	ActionCatFold
)
const (
	// Vault Actions
	ActionVat Action = iota + 30
	// Open a new Vault
	ActionVatOpen
	// Deposit gem into Vault
	ActionVatDeposit
	// Withdraw gem from Vault
	ActionVatWithdraw
	// Pay back dai for Vault
	ActionVatPayback
	// Generate dai from Vault
	ActionVatGenerate
)
const (
	ActionFlip Action = iota + 40
	// Launch an auction from an unsafe Vault by Keeper
	ActionFlipKick
	// Auction bid
	ActionFlipBid
	// Auction done
	ActionFlipDeal
)
const (
	// Oracle Actions
	ActionOracle Action = iota + 50
	// Updates the current feed value and queue up the next one
	ActionOraclePoke
	// Adjust oracle price delay
	ActionOracleStep
)

func (Action) MarshalBinary 

func (i Action) MarshalBinary() (data []byte, err error)

func (Action) String 

func (i Action) String() string

func (*Action) UnmarshalBinary 

func (i *Action) UnmarshalBinary(data []byte) error

type Asset 

type Asset struct {
	ID        string          `sql:"size:36;PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time       `json:"created_at,omitempty"`
	UpdatedAt time.Time       `json:"updated_at,omitempty"`
	Version   int64           `json:"version,omitempty"`
	Name      string          `sql:"size:64" json:"name,omitempty"`
	Symbol    string          `sql:"size:32" json:"symbol,omitempty"`
	ChainID   string          `sql:"size:36" json:"chain_id,omitempty"`
	Price     decimal.Decimal `sql:"type:decimal(24,12)" json:"price,omitempty"`
}

Asset represent mixin asset

type AssetService 

type AssetService interface {
	Find(ctx context.Context, id string) (*Asset, error)
	List(ctx context.Context) ([]*Asset, error)
}

AssetService provides access to remote mixin assets information

type AssetStore 

type AssetStore interface {
	Save(ctx context.Context, asset *Asset) error
	Find(ctx context.Context, id string) (*Asset, error)
	List(ctx context.Context) ([]*Asset, error)
}

AssetStore defines operations for working with assets on db.

type Collateral 

type Collateral struct {
	ID        int64     `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	TraceID   string    `sql:"size:36" json:"trace_id,omitempty"`
	Version   int64     `json:"version,omitempty"`
	Name      string    `sql:"size:64" json:"name,omitempty"`
	// Gem represent deposit asset id
	Gem string `sql:"size:36" json:"gem,omitempty"`
	// Dai represent debt asset id
	Dai string `sql:"size:36" json:"dai,omitempty"`
	// Ink represent All Locked Collateral
	Ink decimal.Decimal `sql:"type:decimal(64,8)" json:"ink,omitempty"`
	// Total Normalised Debt
	Art decimal.Decimal `sql:"type:decimal(64,16)" json:"art,omitempty"`
	// Accumulated Rates
	Rate decimal.Decimal `sql:"type:decimal(64,16)" json:"rate,omitempty"`
	// Time of last drip [unix epoch time]
	Rho time.Time `json:"rho,omitempty"`
	// Debt the total quantity of dai issued
	Debt decimal.Decimal `sql:"type:decimal(64,8)" json:"debt,omitempty"`
	// the debt ceiling
	Line decimal.Decimal `sql:"type:decimal(64,8)" json:"line,omitempty"`
	// the debt floor, eg 100
	Dust decimal.Decimal `sql:"type:decimal(64,8)" json:"dust,omitempty"`
	// Price = Gem.Price / Dai.Price
	Price decimal.Decimal `sql:"type:decimal(32,12)" json:"price,omitempty"`
	// Liquidation ratio, eg 150%
	Mat decimal.Decimal `sql:"type:decimal(10,8)" json:"mat,omitempty"`
	// stability fee, eg 110%
	Duty decimal.Decimal `sql:"type:decimal(20,8)" json:"duty,omitempty"`
	// Liquidation Penalty, eg 113%
	Chop decimal.Decimal `sql:"type:decimal(10,8)" json:"chop,omitempty"`
	// Dunk, max liquidation Quantity, eg 50000
	Dunk decimal.Decimal `sql:"type:decimal(64,8)" json:"dunk,omitempty"`
	// Flip Options
	// Box, Max Dai out for liquidation
	Box decimal.Decimal `sql:"type:decimal(64,8)" json:"box,omitempty"`
	// Litter, Balance of Dai out for liquidation
	Litter decimal.Decimal `sql:"type:decimal(64,8)" json:"litter,omitempty"`
	// Beg minimum bid increase
	Beg decimal.Decimal `sql:"type:decimal(8,4)" json:"beg,omitempty"`
	// TTL bid duration in seconds
	TTL int64 `json:"ttl,omitempty"`
	// Tau flip duration in seconds
	Tau int64 `json:"tau,omitempty"`
	// Live
	Live int `json:"live,omitempty"`
}

Collateral (CAT) represent collateral type

type CollateralStore 

type CollateralStore interface {
	Create(ctx context.Context, collateral *Collateral) error
	Update(ctx context.Context, collateral *Collateral, version int64) error
	Find(ctx context.Context, traceID string) (*Collateral, error)
	List(ctx context.Context) ([]*Collateral, error)
}

CollateralStore define operations for working with collateral on db

type Flip 

type Flip struct {
	ID           int64     `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt    time.Time `json:"created_at,omitempty"`
	UpdatedAt    time.Time `json:"updated_at,omitempty"`
	Version      int64     `json:"version,omitempty"`
	TraceID      string    `sql:"size:36" json:"trace_id,omitempty"`
	CollateralID string    `sql:"size:36" json:"collateral_id,omitempty"`
	VaultID      string    `sql:"size:36" json:"vault_id,omitempty"`
	Action       Action    `json:"action,omitempty"`
	// bid expiry time
	Tic int64 `json:"tic,omitempty"`
	// auction expiry time
	End int64 `json:"end,omitempty"`
	// pUSD paid
	Bid decimal.Decimal `sql:"type:decimal(64,8)" json:"bid,omitempty"`
	// gems in return for bid
	Lot decimal.Decimal `sql:"type:decimal(64,8)" json:"lot,omitempty"`
	// total pUSD wanted
	Tab decimal.Decimal `sql:"type:decimal(64,8)" json:"tab,omitempty"`
	// Art
	Art decimal.Decimal `sql:"type:decimal(64,16)" json:"art,omitempty"`
	// high bidder
	Guy string `sql:"size:36" json:"guy,omitempty"`
}

Flip represent auction by kicking unsafe vaults

func (*Flip) EndFinished 

func (f *Flip) EndFinished(at time.Time) bool

func (*Flip) TicFinished 

func (f *Flip) TicFinished(at time.Time) bool

type FlipEvent 

type FlipEvent struct {
	ID        int64           `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time       `json:"created_at,omitempty"`
	FlipID    string          `sql:"size:36" json:"flip_id,omitempty"`
	Version   int64           `json:"version,omitempty"`
	Action    Action          `json:"action,omitempty"`
	Bid       decimal.Decimal `sql:"type:decimal(64,8)" json:"bid,omitempty"`
	Lot       decimal.Decimal `sql:"type:decimal(64,8)" json:"lot,omitempty"`
}

FlipEvent define operation history on flip

type FlipStore 

type FlipStore interface {
	Create(ctx context.Context, flip *Flip) error
	Update(ctx context.Context, flip *Flip, version int64) error
	Find(ctx context.Context, traceID string) (*Flip, error)
	List(ctx context.Context, from int64, limit int) ([]*Flip, error)
	// Event
	CreateEvent(ctx context.Context, event *FlipEvent) error
	FindEvent(ctx context.Context, flipID string, version int64) (*FlipEvent, error)
	ListEvents(ctx context.Context, flipID string) ([]*FlipEvent, error)
}

FlipStore define operations for working on Flip & FlipEvent on db

type ListVaultRequest 

type ListVaultRequest struct {
	CollateralID string
	UserID       string
	Desc         bool
	FromID       int64
	Limit        int
}

type Message 

type Message struct {
	ID        int64          `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time      `json:"created_at,omitempty"`
	MessageID string         `sql:"size:36" json:"message_id,omitempty"`
	UserID    string         `sql:"size:36" json:"user_id,omitempty"`
	Raw       types.JSONText `sql:"type:TEXT" json:"raw,omitempty"`
}

Message define mixin messenger messages

func BuildMessage 

func BuildMessage(req *mixin.MessageRequest) *Message

BuildMessage convert mixin.MessageRequest to core.Message

type MessageService 

type MessageService interface {
	Send(ctx context.Context, messages []*Message) error
	Meet(ctx context.Context, userID string) error
}

MessageService provide access to handle message with mixin messenger service

type MessageStore 

type MessageStore interface {
	Create(ctx context.Context, messages []*Message) error
	List(ctx context.Context, limit int) ([]*Message, error)
	Delete(ctx context.Context, messages []*Message) error
}

MessageStore defines operations for working with messages on db.

type Notifier 

type Notifier interface {
	// Auth called when a user login successfully
	Auth(ctx context.Context, user *User) error
	// Transaction called when a new tx created
	Transaction(ctx context.Context, tx *Transaction) error
	// Snapshot called when a transfer confirmed by mixin main net
	Snapshot(ctx context.Context, transfer *Transfer, TxHash string) error
}

Notifier define operations to send notification to users

type Oracle 

type Oracle struct {
	ID        int64     `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	AssetID   string    `sql:"size:36" json:"asset_id,omitempty"`
	Version   int64     `json:"version,omitempty"`
	// Hop time delay (seconds) between poke calls
	Hop int64 `json:"hop,omitempty"`
	// Current Price Value
	Current decimal.Decimal `sql:"type:decimal(24,12)" json:"current,omitempty"`
	// Next Price Value
	Next decimal.Decimal `sql:"type:decimal(24,12)" json:"next,omitempty"`
	// Time of last update
	PeekAt time.Time `json:"peek_at,omitempty"`
}

Oracle represent price information

type OracleService 

type OracleService interface {
	Parse(b []byte) ([]byte, error)
}

OracleService define operations to parse new price from oracle service outside

type OracleStore 

type OracleStore interface {
	Save(ctx context.Context, oracle *Oracle, version int64) error
	Find(ctx context.Context, assetID string) (*Oracle, error)
	List(ctx context.Context) ([]*Oracle, error)
	ListCurrent(ctx context.Context) (number.Values, error)
}

OracleStore defines operations for working with oracles on db.

type Output 

type Output struct {
	ID        int64     `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	Version   int64     `sql:"NOT NULL" json:"version,omitempty"`
	TraceID   string    `sql:"type:char(36)" json:"trace_id,omitempty"`
	// mixin id of operator
	Sender          string          `sql:"type:char(36)" json:"sender,omitempty"`
	AssetID         string          `sql:"type:char(36)" json:"asset_id,omitempty"`
	Amount          decimal.Decimal `sql:"type:decimal(64,8)" json:"amount,omitempty"`
	Memo            string          `sql:"size:320" json:"memo,omitempty"`
	State           string          `sql:"size:24" json:"state,omitempty"`       // unspent,signed,spent
	TransactionHash string          `sql:"size:64" json:"hash,omitempty"`        // utxo.transaction_hash.hex
	OutputIndex     int             `json:"output_index,omitempty"`              // utxo.output_index
	SignedTx        string          `sql:"type:TEXT" json:"signed_tx,omitempty"` // utxo.signed_tx

	// SpentBy represent the associated transfer trace id
	SpentBy string `sql:"type:char(36);NOT NULL" json:"spent_by,omitempty"`
}

Output represent Mixin Network multisig Outputs

func (*Output) Cmp 

func (a *Output) Cmp(b *Output) int

type Parliament 

type Parliament interface {
	// Created Called when a new proposal created
	Created(ctx context.Context, proposal *Proposal) error
	// Approved called when a proposal has a new vote
	Approved(ctx context.Context, proposal *Proposal) error
	// Passed called when a proposal is passed
	Passed(ctx context.Context, proposal *Proposal) error
}

Parliament is a proposal version notifier to mtg member admins

type Proposal 

type Proposal struct {
	ID        int64           `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time       `json:"created_at,omitempty"`
	UpdatedAt time.Time       `json:"updated_at,omitempty"`
	PassedAt  sql.NullTime    `json:"passed_at,omitempty"`
	Version   int64           `json:"version,omitempty"`
	TraceID   string          `sql:"size:36" json:"trace_id,omitempty"`
	Creator   string          `sql:"size:36" json:"creator,omitempty"`
	AssetID   string          `sql:"size:36" json:"asset_id,omitempty"`
	Amount    decimal.Decimal `sql:"type:decimal(64,8)" json:"amount,omitempty"`
	// Action the proposal applied
	Action Action `json:"action,omitempty"`
	// Data action parameters
	Data string `sql:"size:256" json:"data,omitempty"`
	// Votes mtg member voted for this proposal
	Votes pq.StringArray `sql:"type:varchar(1024)" json:"votes,omitempty"`
}

type ProposalStore 

type ProposalStore interface {
	Create(ctx context.Context, proposal *Proposal) error
	Find(ctx context.Context, trace string) (*Proposal, error)
	Update(ctx context.Context, proposal *Proposal, version int64) error
	List(ctx context.Context, fromID int64, limit int) ([]*Proposal, error)
}

ProposalStore define operations for working with proposals on db.

type RawTransaction 

type RawTransaction struct {
	ID        int64     `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	TraceID   string    `sql:"type:char(36);" json:"trace_id,omitempty"`
	Data      string    `sql:"type:TEXT" json:"data,omitempty"`
}

type Session 

type Session interface {
	// Login return user mixin id
	Login(ctx context.Context, accessToken string) (*User, error)
}

Session define operations to parse authorization token

type System 

type System struct {
	Admins       []string
	ClientID     string
	ClientSecret string
	Members      []string
	Threshold    uint8
	VoteAsset    string
	VoteAmount   decimal.Decimal
	PrivateKey   ed25519.PrivateKey
	PublicKey    ed25519.PublicKey
	Version      string
}

System stores system information.

func (*System) IsMember 

func (s *System) IsMember(id string) bool

func (*System) IsStaff 

func (s *System) IsStaff(id string) bool

type Transaction 

type Transaction struct {
	ID         int64             `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt  time.Time         `json:"created_at,omitempty"`
	TraceID    string            `sql:"size:36" json:"trace_id,omitempty"`
	Version    int64             `json:"version,omitempty"`
	UserID     string            `sql:"size:36" json:"user_id,omitempty"`
	FollowID   string            `sql:"size:36" json:"follow_id,omitempty"`
	AssetID    string            `sql:"size:36" json:"asset_id,omitempty"`
	Amount     decimal.Decimal   `sql:"type:decimal(64,8)" json:"amount,omitempty"`
	Action     Action            `json:"action,omitempty"`
	Status     TransactionStatus `json:"status,omitempty"`
	Message    string            `sql:"size:128" json:"message,omitempty"`
	Parameters types.JSONText    `sql:"type:varchar(1024)" json:"parameters,omitempty"` // []interface{}
}

type TransactionAction 

type TransactionAction struct {
	FollowID []byte `msgpack:"f,omitempty"`
	Body     []byte `msgpack:"b,omitempty"`
}

func DecodeTransactionAction 

func DecodeTransactionAction(b []byte) (*TransactionAction, error)

func (TransactionAction) Encode 

func (action TransactionAction) Encode() ([]byte, error)

type TransactionStatus 

type TransactionStatus int
const (
	TransactionStatusPending TransactionStatus = iota
	TransactionStatusAbort
	TransactionStatusOk
)

func (TransactionStatus) String 

func (i TransactionStatus) String() string

type TransactionStore 

type TransactionStore interface {
	Create(ctx context.Context, tx *Transaction) error
	Find(ctx context.Context, trace string) (*Transaction, error)
	// FindFollow Find the last tx with the userID & followID
	FindFollow(ctx context.Context, userID, followID string) (*Transaction, error)
	// List list transactions
	List(ctx context.Context, fromID int64, limit int) ([]*Transaction, error)
}

type Transfer 

type Transfer struct {
	ID        int64           `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time       `json:"created_at,omitempty"`
	UpdatedAt time.Time       `json:"updated_at,omitempty"`
	TraceID   string          `sql:"type:char(36)" json:"trace_id,omitempty"`
	AssetID   string          `sql:"type:char(36)" json:"asset_id,omitempty"`
	Amount    decimal.Decimal `sql:"type:decimal(64,8)" json:"amount,omitempty"`
	Memo      string          `sql:"size:200" json:"memo,omitempty"`
	Handled   types.BitBool   `sql:"type:bit(1)" json:"handled,omitempty"`
	Passed    types.BitBool   `sql:"type:bit(1)" json:"passed,omitempty"`
	Threshold uint8           `json:"threshold,omitempty"`
	Opponents pq.StringArray  `sql:"type:varchar(1024)" json:"opponents,omitempty"`
}

type TransferAction 

type TransferAction struct {
	ID     string `json:"id,omitempty"`
	Source string `json:"s,omitempty"`
}

func (TransferAction) Encode 

func (action TransferAction) Encode() string

type User 

type User struct {
	ID          int64     `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt   time.Time `json:"created_at,omitempty"`
	UpdatedAt   time.Time `json:"updated_at,omitempty"`
	Version     int64     `json:"version,omitempty"`
	MixinID     string    `sql:"size:36" json:"mixin_id,omitempty"`
	Role        string    `sql:"size:24" json:"role,omitempty"`
	Lang        string    `sql:"size:36" json:"lang,omitempty"`
	Name        string    `sql:"size:64" json:"name,omitempty"`
	Avatar      string    `sql:"size:255" json:"avatar,omitempty"`
	AccessToken string    `sql:"size:512" json:"access_token,omitempty"`
}

type UserService 

type UserService interface {
	Find(ctx context.Context, mixinID string) (*User, error)
	Login(ctx context.Context, token string) (*User, error)
	Auth(ctx context.Context, code string) (string, error)
}

type UserStore 

type UserStore interface {
	Save(ctx context.Context, user *User) error
	Find(ctx context.Context, mixinID string) (*User, error)
}

type Vault 

type Vault struct {
	ID        int64     `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	TraceID   string    `sql:"size:36" json:"trace_id,omitempty"`
	Version   int64     `sql:"not null" json:"version,omitempty"`
	UserID    string    `sql:"size:36" json:"user_id,omitempty"`
	// CollateralID represent collateral id
	CollateralID string `sql:"size:36" json:"collateral_id,omitempty"`
	// Locked Collateral
	Ink decimal.Decimal `sql:"type:decimal(64,8)" json:"ink,omitempty"`
	// Normalised Debt
	Art decimal.Decimal `sql:"type:decimal(64,16)" json:"art,omitempty"`
}

type VaultEvent 

type VaultEvent struct {
	ID        int64     `sql:"PRIMARY_KEY" json:"id,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	VaultID   string    `sql:"size:36" json:"vault_id,omitempty"`
	Version   int64     `json:"version,omitempty"`
	Action    Action    `json:"action,omitempty"`
	// Locked Collateral change
	Dink decimal.Decimal `sql:"type:decimal(64,8)" json:"dink,omitempty"`
	// Normalised Debt change
	Dart decimal.Decimal `sql:"type:decimal(64,16)" json:"dart,omitempty"`
	// Debt change
	Debt decimal.Decimal `sql:"type:decimal(64,8)" json:"debt,omitempty"`
}

type VaultStore 

type VaultStore interface {
	Create(ctx context.Context, vault *Vault) error
	Update(ctx context.Context, vault *Vault, version int64) error
	Find(ctx context.Context, traceID string) (*Vault, error)
	List(ctx context.Context, req ListVaultRequest) ([]*Vault, error)
	CountCollateral(ctx context.Context) (map[string]int64, error)
	// Events
	CreateEvent(ctx context.Context, event *VaultEvent) error
	FindEvent(ctx context.Context, vaultID string, version int64) (*VaultEvent, error)
	ListEvents(ctx context.Context, vaultID string) ([]*VaultEvent, error)
}

type WalletService 

type WalletService interface {
	// Pull fetch NEW Output updates
	Pull(ctx context.Context, offset time.Time, limit int) ([]*Output, error)
	// Spend spend multiple Output
	Spend(ctx context.Context, outputs []*Output, transfer *Transfer) (*RawTransaction, error)
	// ReqTransfer generate payment code for multisig transfer
	ReqTransfer(ctx context.Context, transfer *Transfer) (string, error)
	// Transfer handle a transfer request
	HandleTransfer(ctx context.Context, transfer *Transfer) error
}

type WalletStore 

type WalletStore interface {
	// Save batch update multiple Output
	Save(ctx context.Context, outputs []*Output) error
	// List return a list of Output by order
	List(ctx context.Context, fromID int64, limit int) ([]*Output, error)
	// ListUnspent list unspent Output
	ListUnspent(ctx context.Context, assetID string, limit int) ([]*Output, error)
	ListSpentBy(ctx context.Context, assetID string, spentBy string) ([]*Output, error)
	// Transfers
	CreateTransfers(ctx context.Context, transfers []*Transfer) error
	UpdateTransfer(ctx context.Context, transfer *Transfer) error
	ListPendingTransfers(ctx context.Context) ([]*Transfer, error)
	ListNotPassedTransfers(ctx context.Context) ([]*Transfer, error)
	Spent(ctx context.Context, outputs []*Output, transfer *Transfer) error
	// mixin net transaction
	CreateRawTransaction(ctx context.Context, tx *RawTransaction) error
	ListPendingRawTransactions(ctx context.Context, limit int) ([]*RawTransaction, error)
	ExpireRawTransaction(ctx context.Context, tx *RawTransaction) error
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.