core

package
v0.9.2-rc2 Latest Latest
Warning

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

Go to latest
Published: Sep 26, 2017 License: MIT Imports: 71 Imported by: 0

Documentation

Index

Constants

View Source
const (
	RatingMin           = 1
	RatingMax           = 5
	ReviewMaxCharacters = 3000
)
View Source
const (
	ListingVersion           = 1
	TitleMaxCharacters       = 140
	ShortDescriptionLength   = 160
	DescriptionMaxCharacters = 50000
	MaxTags                  = 10
	MaxCategories            = 10
	MaxListItems             = 30
	FilenameMaxCharacters    = 255
	CodeMaxCharacters        = 20
	WordMaxCharacters        = 40
	SentenceMaxCharacters    = 70
	CouponTitleMaxCharacters = 70
	PolicyMaxCharacters      = 10000
	AboutMaxCharacters       = 10000
	URLMaxCharacters         = 2000
	MaxCountryCodes          = 255
	EscrowTimeout            = 1080
	SlugBuffer               = 5
)
View Source
const (
	CHAT_MESSAGE_MAX_CHARACTERS = 20000
	CHAT_SUBJECT_MAX_CHARACTERS = 500
	DefaultPointerPrefixLength  = 14
)
View Source
const (
	CachedProfileTime = time.Hour * 24 * 7
)

Variables

View Source
var (
	VERSION   = "0.9.2"
	USERAGENT = "/openbazaar-go:" + VERSION + "/"
)
View Source
var DisputeWg = new(sync.WaitGroup)
View Source
var ErrCaseNotFound = errors.New("Case not found")
View Source
var ErrorProfileNotFound error = errors.New("Profile not found")
View Source
var EscrowTimeLockedError error
View Source
var ModeratorPointerID multihash.Multihash
View Source
var NoListingsError error = errors.New("No listings to set moderators on")
View Source
var OfflineMessageWaitGroup sync.WaitGroup

Functions

func EncodeCID added in v0.7.0

func EncodeCID(b []byte) (*cid.Cid, error)

Hash with SHA-256 and encode as a multihash

func EncodeMultihash added in v0.5.1

func EncodeMultihash(b []byte) (*mh.Multihash, error)

func ExtractIDFromPointer added in v0.5.1

func ExtractIDFromPointer(pi ps.PeerInfo) (string, error)

Certain pointers, such as moderators, contain a peerID. This function will extract the ID from the underlying PeerInfo object.

func GetSelectedSku added in v0.5.1

func GetSelectedSku(listing *pb.Listing, itemOptions []*pb.Order_Item_Option) (int, error)

func ParseContractForListing added in v0.5.5

func ParseContractForListing(hash string, contract *pb.RicardianContract) (*pb.Listing, error)

func SameSku added in v0.5.1

func SameSku(selectedVariants []int, sku *pb.Listing_Item_Sku) bool

func ValidateProfile added in v0.5.3

func ValidateProfile(profile *pb.Profile) error

func ValidateRating added in v0.6.0

func ValidateRating(rating *pb.Rating) (bool, error)

Types

type OpenBazaarNode

type OpenBazaarNode struct {
	// Context for issuing IPFS commands
	Context commands.Context

	// IPFS node object
	IpfsNode *core.IpfsNode

	/* The roothash of the node directory inside the openbazaar repo.
	   This directory hash is published on IPNS at our peer ID making
	   the directory publicly viewable on the network. */
	RootHash string

	// The path to the openbazaar repo in the file system
	RepoPath string

	// The OpenBazaar network service for direct communication between peers
	Service net.NetworkService

	// Database for storing node specific data
	Datastore repo.Datastore

	// Websocket channel used for pushing data to the UI
	Broadcast chan interface{}

	// Bitcoin wallet implementation
	Wallet wallet.Wallet

	// Storage for our outgoing messages
	MessageStorage sto.OfflineMessagingStorage

	// A service that periodically checks the dht for outstanding messages
	MessageRetriever *ret.MessageRetriever

	// A service that periodically republishes active pointers
	PointerRepublisher *rep.PointerRepublisher

	// Used to resolve domains to OpenBazaar IDs
	NameSystem *namesys.NameSystem

	// A service that periodically fetches and caches the bitcoin exchange rates
	ExchangeRates bitcoin.ExchangeRates

	// An optional gateway URL where we can crosspost data to ensure persistence
	CrosspostGateways []*url.URL

	// The user-agent for this node
	UserAgent string

	// A dialer for Tor if available
	TorDialer proxy.Dialer

	// Manage blocked peers
	BanManager *net.BanManager
}
var Node *OpenBazaarNode

func (*OpenBazaarNode) BuildTransactionRecords added in v0.6.2

func (n *OpenBazaarNode) BuildTransactionRecords(contract *pb.RicardianContract, records []*wallet.TransactionRecord, state pb.OrderState) ([]*pb.TransactionRecord, *pb.TransactionRecord, error)

Used by the GET order API to build transaction records suitable to be included in the order response

func (*OpenBazaarNode) CalcOrderId added in v0.2.0

func (n *OpenBazaarNode) CalcOrderId(order *pb.Order) (string, error)

func (*OpenBazaarNode) CalculateOrderTotal added in v0.1.1

func (n *OpenBazaarNode) CalculateOrderTotal(contract *pb.RicardianContract) (uint64, error)

func (*OpenBazaarNode) CancelOfflineOrder added in v0.2.0

func (n *OpenBazaarNode) CancelOfflineOrder(contract *pb.RicardianContract, records []*wallet.TransactionRecord) error

func (*OpenBazaarNode) CloseDispute added in v0.3.0

func (n *OpenBazaarNode) CloseDispute(orderId string, buyerPercentage, vendorPercentage float32, resolution string) error

func (*OpenBazaarNode) CompleteOrder added in v0.2.2

func (n *OpenBazaarNode) CompleteOrder(orderRatings *OrderRatings, contract *pb.RicardianContract, records []*wallet.TransactionRecord) error

func (*OpenBazaarNode) ConfirmOfflineOrder added in v0.2.0

func (n *OpenBazaarNode) ConfirmOfflineOrder(contract *pb.RicardianContract, records []*wallet.TransactionRecord) error

func (*OpenBazaarNode) DeleteListing added in v0.1.1

func (n *OpenBazaarNode) DeleteListing(slug string) error

Deletes the listing directory, removes the listing from the index, and deletes the inventory

func (*OpenBazaarNode) EncryptMessage

func (n *OpenBazaarNode) EncryptMessage(peerID peer.ID, peerKey *libp2p.PubKey, message []byte) (ct []byte, rerr error)

This is a placeholder until the libsignal is operational.

For now we will just encrypt outgoing offline messages with the long lived identity key.
Optionally you may provide a public key, to avoid doing an IPFS lookup

func (*OpenBazaarNode) EstimateOrderTotal added in v0.5.5

func (n *OpenBazaarNode) EstimateOrderTotal(data *PurchaseData) (uint64, error)

func (*OpenBazaarNode) FetchAvatar added in v0.6.0

func (n *OpenBazaarNode) FetchAvatar(peerId string, size string, useCache bool) (io.DagReader, error)

func (*OpenBazaarNode) FetchHeader added in v0.6.0

func (n *OpenBazaarNode) FetchHeader(peerId string, size string, useCache bool) (io.DagReader, error)

func (*OpenBazaarNode) FetchImage added in v0.6.0

func (n *OpenBazaarNode) FetchImage(peerId string, imageType string, size string, useCache bool) (io.DagReader, error)

func (*OpenBazaarNode) FetchProfile added in v0.5.0

func (n *OpenBazaarNode) FetchProfile(peerId string, useCache bool) (pb.Profile, error)

func (*OpenBazaarNode) Follow

func (n *OpenBazaarNode) Follow(peerId string) error

func (*OpenBazaarNode) FulfillOrder added in v0.2.1

func (n *OpenBazaarNode) FulfillOrder(fulfillment *pb.OrderFulfillment, contract *pb.RicardianContract, records []*wallet.TransactionRecord) error

func (*OpenBazaarNode) GenerateSlug added in v0.5.1

func (n *OpenBazaarNode) GenerateSlug(title string) (string, error)

func (*OpenBazaarNode) GetBase64Image added in v0.6.3

func (n *OpenBazaarNode) GetBase64Image(url string) (base64ImageData, filename string, err error)

func (*OpenBazaarNode) GetListingCount

func (n *OpenBazaarNode) GetListingCount() int

Return the current number of listings

func (*OpenBazaarNode) GetListingFromHash added in v0.1.1

func (n *OpenBazaarNode) GetListingFromHash(hash string) (*pb.SignedListing, error)

func (*OpenBazaarNode) GetListingFromSlug added in v0.1.1

func (n *OpenBazaarNode) GetListingFromSlug(slug string) (*pb.SignedListing, error)

func (*OpenBazaarNode) GetListings added in v0.2.3

func (n *OpenBazaarNode) GetListings() ([]byte, error)

func (*OpenBazaarNode) GetModeratorFee added in v0.3.0

func (n *OpenBazaarNode) GetModeratorFee(transactionTotal uint64) (uint64, error)

func (*OpenBazaarNode) GetPeerStatus

func (n *OpenBazaarNode) GetPeerStatus(peerId string) (string, error)

func (*OpenBazaarNode) GetProfile

func (n *OpenBazaarNode) GetProfile() (pb.Profile, error)

func (*OpenBazaarNode) ImportListings added in v0.6.3

func (n *OpenBazaarNode) ImportListings(r io.ReadCloser) error

func (*OpenBazaarNode) IsFulfilled added in v0.2.1

func (n *OpenBazaarNode) IsFulfilled(contract *pb.RicardianContract) bool

func (*OpenBazaarNode) IsItemForSale added in v0.2.0

func (n *OpenBazaarNode) IsItemForSale(listing *pb.Listing) bool

Check to see we are selling the given listing. Used when validating an order. FIXME: This wont scale well. We will need to store the hash of active listings in a db to do an indexed search.

func (*OpenBazaarNode) IsModerator added in v0.5.0

func (n *OpenBazaarNode) IsModerator() bool

func (*OpenBazaarNode) NewOrderConfirmation added in v0.2.0

func (n *OpenBazaarNode) NewOrderConfirmation(contract *pb.RicardianContract, addressRequest, calculateNewTotal bool) (*pb.RicardianContract, error)

func (*OpenBazaarNode) NotifyModerators added in v0.5.1

func (n *OpenBazaarNode) NotifyModerators(moderators []string) error

func (*OpenBazaarNode) OpenDispute added in v0.3.0

func (n *OpenBazaarNode) OpenDispute(orderID string, contract *pb.RicardianContract, records []*wallet.TransactionRecord, claim string) error

func (*OpenBazaarNode) PatchProfile added in v0.4.3

func (n *OpenBazaarNode) PatchProfile(patch map[string]interface{}) error

func (*OpenBazaarNode) ProcessDisputeOpen added in v0.3.0

func (n *OpenBazaarNode) ProcessDisputeOpen(rc *pb.RicardianContract, peerID string) error

func (*OpenBazaarNode) Purchase

func (n *OpenBazaarNode) Purchase(data *PurchaseData) (orderId string, paymentAddress string, paymentAmount uint64, vendorOnline bool, err error)

func (*OpenBazaarNode) RefundOrder added in v0.2.1

func (n *OpenBazaarNode) RefundOrder(contract *pb.RicardianContract, records []*wallet.TransactionRecord) error

func (*OpenBazaarNode) RejectOfflineOrder added in v0.2.0

func (n *OpenBazaarNode) RejectOfflineOrder(contract *pb.RicardianContract, records []*wallet.TransactionRecord) error

func (*OpenBazaarNode) ReleaseFunds added in v0.3.0

func (n *OpenBazaarNode) ReleaseFunds(contract *pb.RicardianContract, records []*wallet.TransactionRecord) error

func (*OpenBazaarNode) ReleaseFundsAfterTimeout added in v0.7.0

func (n *OpenBazaarNode) ReleaseFundsAfterTimeout(contract *pb.RicardianContract, records []*wallet.TransactionRecord) error

func (*OpenBazaarNode) RemoveSelfAsModerator added in v0.1.1

func (n *OpenBazaarNode) RemoveSelfAsModerator() error

func (*OpenBazaarNode) SeedNode

func (n *OpenBazaarNode) SeedNode() error

func (*OpenBazaarNode) SendCancel added in v0.2.0

func (n *OpenBazaarNode) SendCancel(peerId, orderId string) error

func (*OpenBazaarNode) SendChat added in v0.3.1

func (n *OpenBazaarNode) SendChat(peerId string, chatMessage *pb.Chat) error

func (*OpenBazaarNode) SendDisputeClose added in v0.3.0

func (n *OpenBazaarNode) SendDisputeClose(peerId string, k *libp2p.PubKey, resolutionMessage *pb.RicardianContract) error

func (*OpenBazaarNode) SendDisputeOpen added in v0.3.0

func (n *OpenBazaarNode) SendDisputeOpen(peerId string, k *libp2p.PubKey, disputeMessage *pb.RicardianContract) error

func (*OpenBazaarNode) SendDisputeUpdate added in v0.3.0

func (n *OpenBazaarNode) SendDisputeUpdate(peerId string, updateMessage *pb.DisputeUpdate) error

func (*OpenBazaarNode) SendModeratorAdd added in v0.5.1

func (n *OpenBazaarNode) SendModeratorAdd(peerId string) error

func (*OpenBazaarNode) SendModeratorRemove added in v0.5.1

func (n *OpenBazaarNode) SendModeratorRemove(peerId string) error

func (*OpenBazaarNode) SendOfflineAck

func (n *OpenBazaarNode) SendOfflineAck(peerId string, pointerID peer.ID) error

func (*OpenBazaarNode) SendOfflineMessage

func (n *OpenBazaarNode) SendOfflineMessage(p peer.ID, k *libp2p.PubKey, m *pb.Message) error

Supply of a public key is optional, if nil is instead provided n.EncryptMessage does a lookup

func (*OpenBazaarNode) SendOrder added in v0.1.1

func (n *OpenBazaarNode) SendOrder(peerId string, contract *pb.RicardianContract) (resp *pb.Message, err error)

func (*OpenBazaarNode) SendOrderCompletion added in v0.2.2

func (n *OpenBazaarNode) SendOrderCompletion(peerId string, k *libp2p.PubKey, completionMessage *pb.RicardianContract) error

func (*OpenBazaarNode) SendOrderConfirmation added in v0.2.0

func (n *OpenBazaarNode) SendOrderConfirmation(peerId string, contract *pb.RicardianContract) error

func (*OpenBazaarNode) SendOrderFulfillment added in v0.2.1

func (n *OpenBazaarNode) SendOrderFulfillment(peerId string, k *libp2p.PubKey, fulfillmentMessage *pb.RicardianContract) error

func (*OpenBazaarNode) SendRefund added in v0.2.1

func (n *OpenBazaarNode) SendRefund(peerId string, refundMessage *pb.RicardianContract) error

func (*OpenBazaarNode) SendReject added in v0.2.0

func (n *OpenBazaarNode) SendReject(peerId string, rejectMessage *pb.OrderReject) error

func (*OpenBazaarNode) SetAvatarImages added in v0.2.0

func (n *OpenBazaarNode) SetAvatarImages(base64ImageData string) (*pb.Profile_Image, error)

func (*OpenBazaarNode) SetHeaderImages added in v0.2.0

func (n *OpenBazaarNode) SetHeaderImages(base64ImageData string) (*pb.Profile_Image, error)

func (*OpenBazaarNode) SetListingInventory

func (n *OpenBazaarNode) SetListingInventory(listing *pb.Listing) error

Sets the inventory for the listing in the database. Does some basic validation

to make sure the inventory uses the correct variants.

func (*OpenBazaarNode) SetModeratorsOnListings added in v0.4.3

func (n *OpenBazaarNode) SetModeratorsOnListings(moderators []string) error

func (*OpenBazaarNode) SetProductImages added in v0.2.0

func (n *OpenBazaarNode) SetProductImages(base64ImageData, filename string) (*pb.Profile_Image, error)

func (*OpenBazaarNode) SetSelfAsModerator added in v0.1.1

func (n *OpenBazaarNode) SetSelfAsModerator(moderator *pb.Moderator) error

func (*OpenBazaarNode) SignDispute added in v0.3.0

func (n *OpenBazaarNode) SignDispute(contract *pb.RicardianContract) (*pb.RicardianContract, error)

func (*OpenBazaarNode) SignDisputeResolution added in v0.3.0

func (n *OpenBazaarNode) SignDisputeResolution(contract *pb.RicardianContract) (*pb.RicardianContract, error)

func (*OpenBazaarNode) SignListing

func (n *OpenBazaarNode) SignListing(listing *pb.Listing) (*pb.SignedListing, error)

Add our identity to the listing and sign it

func (*OpenBazaarNode) SignOrder added in v0.2.0

func (n *OpenBazaarNode) SignOrder(contract *pb.RicardianContract) (*pb.RicardianContract, error)

func (*OpenBazaarNode) SignOrderCompletion added in v0.2.2

func (n *OpenBazaarNode) SignOrderCompletion(contract *pb.RicardianContract) (*pb.RicardianContract, error)

func (*OpenBazaarNode) SignOrderConfirmation added in v0.2.0

func (n *OpenBazaarNode) SignOrderConfirmation(contract *pb.RicardianContract) (*pb.RicardianContract, error)

func (*OpenBazaarNode) SignOrderFulfillment added in v0.2.1

func (n *OpenBazaarNode) SignOrderFulfillment(contract *pb.RicardianContract) (*pb.RicardianContract, error)

func (*OpenBazaarNode) SignRefund added in v0.2.1

func (n *OpenBazaarNode) SignRefund(contract *pb.RicardianContract) (*pb.RicardianContract, error)

func (*OpenBazaarNode) Unfollow

func (n *OpenBazaarNode) Unfollow(peerId string) error

func (*OpenBazaarNode) UpdateFollow

func (n *OpenBazaarNode) UpdateFollow() error

This function updates the follow and following lists in the node's root directory

as well as adds the current follow, following, and listing counts to the profile.
We only do this when a user updates his node to avoid needing to make network calls
each time a new follower or unfollow request comes in.

func (*OpenBazaarNode) UpdateIndexHashes added in v0.4.3

func (n *OpenBazaarNode) UpdateIndexHashes(hashes map[string]string) error

Update the hashes in the listings.json file

func (*OpenBazaarNode) UpdateListingIndex

func (n *OpenBazaarNode) UpdateListingIndex(listing *pb.SignedListing) error

func (*OpenBazaarNode) UpdateProfile

func (n *OpenBazaarNode) UpdateProfile(profile *pb.Profile) error

func (*OpenBazaarNode) ValidateAndSaveRating added in v0.2.2

func (n *OpenBazaarNode) ValidateAndSaveRating(contract *pb.RicardianContract) (retErr error)

func (*OpenBazaarNode) ValidateCaseContract added in v0.3.0

func (n *OpenBazaarNode) ValidateCaseContract(contract *pb.RicardianContract) []string

func (*OpenBazaarNode) ValidateDirectPaymentAddress added in v0.2.0

func (n *OpenBazaarNode) ValidateDirectPaymentAddress(order *pb.Order) error

func (*OpenBazaarNode) ValidateDisputeResolution added in v0.3.0

func (n *OpenBazaarNode) ValidateDisputeResolution(contract *pb.RicardianContract) error

func (*OpenBazaarNode) ValidateModeratedPaymentAddress added in v0.2.1

func (n *OpenBazaarNode) ValidateModeratedPaymentAddress(order *pb.Order, timeout time.Duration) error

func (*OpenBazaarNode) ValidateOrder added in v0.2.0

func (n *OpenBazaarNode) ValidateOrder(contract *pb.RicardianContract) error

func (*OpenBazaarNode) ValidateOrderCompletion added in v0.2.2

func (n *OpenBazaarNode) ValidateOrderCompletion(contract *pb.RicardianContract) error

func (*OpenBazaarNode) ValidateOrderConfirmation added in v0.2.1

func (n *OpenBazaarNode) ValidateOrderConfirmation(contract *pb.RicardianContract, validateAddress bool) error

func (*OpenBazaarNode) ValidateOrderFulfillment added in v0.2.1

func (n *OpenBazaarNode) ValidateOrderFulfillment(fulfillment *pb.OrderFulfillment, contract *pb.RicardianContract) error

func (*OpenBazaarNode) ValidatePaymentAmount added in v0.4.0

func (n *OpenBazaarNode) ValidatePaymentAmount(requestedAmount, paymentAmount uint64) bool

func (*OpenBazaarNode) VerifySignatureOnDisputeOpen added in v0.3.0

func (n *OpenBazaarNode) VerifySignatureOnDisputeOpen(contract *pb.RicardianContract, peerID string) error

func (*OpenBazaarNode) VerifySignaturesOnRefund added in v0.2.1

func (n *OpenBazaarNode) VerifySignaturesOnRefund(contract *pb.RicardianContract) error

type OrderRatings added in v0.2.2

type OrderRatings struct {
	OrderId string       `json:"orderId"`
	Ratings []RatingData `json:"ratings"`
}

type PurchaseData

type PurchaseData struct {
	ShipTo               string  `json:"shipTo"`
	Address              string  `json:"address"`
	City                 string  `json:"city"`
	State                string  `json:"state"`
	PostalCode           string  `json:"postalCode"`
	CountryCode          string  `json:"countryCode"`
	AddressNotes         string  `json:"addressNotes"`
	Moderator            string  `json:"moderator"`
	Items                []item  `json:"items"`
	AlternateContactInfo string  `json:"alternateContactInfo"`
	RefundAddress        *string `json:"refundAddress"` //optional, can be left out of json
}

type RatingData added in v0.2.2

type RatingData struct {
	Slug            string `json:"slug"`
	Overall         int    `json:"overall"`
	Quality         int    `json:"quality"`
	Description     int    `json:"description"`
	DeliverySpeed   int    `json:"deliverySpeed"`
	CustomerService int    `json:"customerService"`
	Review          string `json:"review"`
	Anonymous       bool   `json:"anonymous"`
}

type SavedRating added in v0.6.0

type SavedRating struct {
	Slug    string   `json:"slug"`
	Count   int      `json:"count"`
	Average float32  `json:"average"`
	Ratings []string `json:"ratings"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL