package
2.4.3+incompatible
Repository: https://github.com/phoreproject/openbazaar-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# Functions

AllCurrencies returns the singleton representing all known currency definitions.
CreateListing will create a pb Listing.
CreateSlugFor Create a slug from a multi-lang string.
No description provided by the author
ExtractIDFromListing returns pb.ID of the listing.
ExtractVersion returns the version of the listing.
FiatCurrencies returns the mainnet crypto currency definition singleton.
GenerateSlug - slugify the title of the listing.
GetListingFromSlug - fetch listing for the specified slug.
GetObjectFromIPFS gets the requested name from ipfs or the local cache.
No description provided by the author
GetRepoPath returns the directory to store repo data in.
MainnetCurrencies returns the mainnet crypto currency definition singleton.
MigrateUp looks at the currently active migration version and will migrate all the way up (applying all up migrations).
NewAPITime returns a pointer to a new APITime instance.
NewCurrencyConverter returns a valid CurrencyConverter.
NewCurrencyDictionary returns a CurrencyDictionary for managing CurrencyDefinitions.
NewCurrencyValue accepts string amounts and currency codes, and creates a valid CurrencyValue.
NewCurrencyValueFromBigInt is a convenience function which converts a big.Int and CurrencyDefinition into a new CurrencyValue.
NewCurrencyValueFromInt is a convenience function which converts an int64 into a string and passes the arguments to NewCurrencyValue.
NewCurrencyValueFromProtobuf consumes the string and pb.CurrencyDefinition objects from parsed Listings and converts them into CurrencyValue objects.
NewCurrencyValueFromUint is a convenience function which converts an int64 into a string and passes the arguments to NewCurrencyValue.
NewCurrencyValueWithLookup accepts a string value as a base10 integer and uses the currency code to lookup the CurrencyDefinition.
NewEquivalentConverter returns a currency converter where all rates are always returns as 1.0 making all currencies equivalent to one another.
NewListingFromProtobuf - return Listing from pb.Listing.
NewNotification is a helper that returns a properly instantiated *Notification.
No description provided by the author
NewPeerInfoFromProtobuf translates a pb.ID protobuf into a PeerInfo.
NewProfileFromProtobuf returns a Profile wrapped around a profile protobuf.
No description provided by the author
NewUnknownCryptoDefinition returns a suitable crypto definition when one does not already exist in local dictionaries.
TestnetCurrencies returns the mainnet crypto currency definition singleton.
No description provided by the author
ToV5Dispute scans through the dispute looking for any deprecated fields and turns them into their v5 counterpart.
ToV5DisputeResolution scans through the dispute resolution looking for any deprecated fields and turns them into their v5 counterpart.
ToV5Order scans through the order looking for any deprecated fields and turns them into their v5 counterpart.
ToV5OrderConfirmation scans through the order confirmation looking for any deprecated fields and turns them into their v5 counterpart.
ToV5OrderFulfillment scans through the order fulfillment looking for any deprecated fields and turns them into their v5 counterpart.
ToV5Refund scans through the refund looking for any deprecated fields and turns them into their v5 counterpart.
UnmarshalJSONListing - unmarshal listing.
UnmarshalJSONProfile consumes a JSON byte slice and returns a Profile-wrapped unmarshaled protobuf.
UnmarshalJSONSignedListing extracts a SignedListing from marshaled JSON.
UnmarshalJSONSignedListingIndex consumes a []byte payload of JSON representing a list of SignedListings and returns a parsed instance or an error if the payload cannot be successfully parsed.
UpdateListing will update a pb Listing.
ValidateListingOptions is a helper to ensure item options are valid.
ValidateShippingRegion ensures shipping options are valid.

# Constants

AboutMaxCharacters - max length for about.
CodeMaxCharacters - max chars for a code.
CouponTitleMaxCharacters - max length of a coupon title.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DefaultEscrowTimeout - escrow timeout in hours.
DescriptionMaxCharacters - max length for description.
Number of hours after purchase before a dispute may no longer be opened.
Number of hours after dispute begins before it is resolved automatically.
No description provided by the author
FilenameMaxCharacters - max filename size.
time.RFC3339Nano.
ListingVersion - current listing version.
MaxCategories - max permitted categories.
MaxCountryCodes - max country codes.
MaxListItems - max items in a listing.
MaxTags - max permitted tags.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PolicyMaxCharacters - max length for policy.
PriceModifierMax = max price modifier.
PriceModifierMin - min price modifier.
No description provided by the author
SentenceMaxCharacters - max chars for sentence.
ShortDescriptionLength - min length for description.
SlugBuffer - buffer size for slug.
TitleMaxCharacters - max size for title.
URLMaxCharacters - max length for URL.
WordMaxCharacters - max chars for word.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrCryptocurrencySkuQuantityInvalid - invalid sku qty err.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrFixedFeeHasNonZeroPercentage indicates when the percentage is not zero but should be.
No description provided by the author
ErrListingAlreadyExists - duplicate listing err.
ErrListingCryptoCurrencyCodeInvalid indicates the given code isn't valid or known.
ErrListingCryptoDivisibilityInvalid indicates the given divisibility doesn't match the default.
ErrListingDoesNotExist - non-existent listing err.
ErrMissingModeratorFee indicates the fee schedule is missing.
ErrModeratorFeeHasNegativePercentage indicates when the percentage is non-positive but should be.
ErrModeratorFixedFeeAmountIsEmpty indicates the fee is defined with an empty amount.
ErrModeratorFixedFeeIsMissing indicates when the fixed fee is missing.
ErrModeratorFixedFeeIsNegative indicates that the fixed fee is non-positive.
ErrModeratorInfoMissing indicates when the moderator information is missing while also indicating they are a moderator.
No description provided by the author
ErrPercentageFeeHasFixedFee indicates that a fixed fee is included when there should not be.
ErrPriceCalculationRequiresExchangeRates - exchange rates dependency err.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrUnknownMessage - notify an invalid message.
ErrUnknownModeratorFeeType indicates the feeType is unknown.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
BuyerDisputeExpiry represents a notification about a purchase which has an open dispute that is expiring.
BuyerDisputeTimeout represents a notification about a purchase which will soon be unable to dispute.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CurrencyConverter is suitable for converting a currency from one CurrencyDefinition to another, accounting for their differing divisibility as well as their differing exchange rate as provided by the rater.
No description provided by the author
No description provided by the author
CurrencyValue represents the amount and variety of currency.
No description provided by the author
DisputeCaseRecord is a one-to-one relationship with records in the SQL datastore.
No description provided by the author
No description provided by the author
No description provided by the author
ErrPriceModifierOutOfRange - customize limits for price modifier.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IndividualListingContainer is a wrapper for a single listing.
Item represents a purchased item.
Listing represents a trade offer which can be accepted by another party on the OpenBazaar network.
ListingCoupon represents an coupon which can be applied to a listing for a discount.
ListingImage represents the underlying protobuf image.
No description provided by the author
ListingMetadata -.
No description provided by the author
ListingTax describes how a listing is taxed in each region.
No description provided by the author
Message - wrapper for pb.Message.
No description provided by the author
No description provided by the author
ModeratorDisputeExpiry represents a notification about an open dispute which will soon be expired and automatically resolved.
No description provided by the author
Notification represents both a record from the Notifications Datastore as well as an unmarshalling envelope for the Notifier interface field NotifierData.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PeerInfo represents a signed identity on OpenBazaar.
PeerKeychain holds bytes representing key material suitable for extracting with libp2p-crypto.
PremarshalledNotifier is a hack to allow []byte data to be transferred through the Notifier interface without having to do things the right way.
No description provided by the author
Profile presents the user's metadata.
No description provided by the author
PurchaseData represents purchase request metadata.
PurchaseRecord represents a one-to-one relationship with records in the SQL datastore.
No description provided by the author
No description provided by the author
SaleRecord represents a one-to-one relationship with records in the SQL datastore.
No description provided by the author
No description provided by the author
SignedListing represents a finalized listing which has been signed by the vendor.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
VendorDisputeTimeout represents a notification about a sale which will soon be unable to dispute.
VendorFinalizedPayment represents a notification about a purchase which will soon be unable to dispute.

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Coupons interface defines basic database operations for coupon information.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MessageStore is the messages table interface.
No description provided by the author
ModeratedStores interface defines basic database operations for moderated stores.
Notifications interface defines basic database operations for notification information.
Notifier is an interface which is used to send data to the frontend.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TxMetadata interface defines basic database operations for transaction metadata.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

ChatMessageNotification handles serialization of ChatMessages for notifications.
No description provided by the author
No description provided by the author
ErrCryptocurrencyListingIllegalField - invalid field err.
ErrCryptocurrencyPurchaseIllegalField - invalid purchase field err.
ErrMarketPriceListingIllegalField - invalid listing field err.
ListingCoupons is a set of listing coupons.
ListingTaxes is a set of taxes.
No description provided by the author