sdk

Documentation

Overview

event schemas: https://docs.opensea.io/reference/stream-api-event-schemas api document: https://docs.opensea.io/reference/using-stream-api-without-sdk

https://github.com/ProjectOpenSea/stream-js/blob/main/src/types.ts

Index

• Constants
• Variables
• func NewNotifyService(net int, key string) *notifyService
• type CollectionOfferRes
• type ItemCancelledRes
• type ItemListRes
• type ItemListedRes
• type ItemMetadataUpdatedRes
• type ItemReceivedBidRes
• type ItemReceivedOfferRes
• type ItemSoldRes
• type ItemTransferredRes
• type Message
  • func (m *Message) UnmarshalJSON(data []byte) error
• type MsgHandlerFanc
• type PayloadJson
• type Quit
  • func NewQuit() *Quit
  • func (q *Quit) IsQuit() bool
  • func (q *Quit) WatchOsSignal()
• type SafeCounter
  • func (c *SafeCounter) Inc()
  • func (c *SafeCounter) Value() int
• type TraitOfferRes
• type UnSubscribeHandlerFanc

Constants

const (
	ITEM_METADATA_UPDATED string = "item_metadata_updated"
	ITEM_LISTED                  = "item_listed"
	ITEM_SOLD                    = "item_sold"
	ITEM_TRANSFERRED             = "item_transferred"
	ITEM_RECEIVED_OFFER          = "item_received_offer"
	ITEM_RECEIVED_BID            = "item_received_bid"
	ITEM_CANCELLED               = "item_cancelled"
	COLLECTION_OFFER             = "collection_offer"
	TRAIT_OFFER                  = "trait_offer"
	ITEM_FEACH_ALL               = "*"
)

EventType

const (
	MAIN_NET_URL_PRIFIX = "wss://stream.openseabeta.com/socket/websocket?token="
	TEST_NET_URL_PRIFIX = "wss://testnets-stream.openseabeta.com/socket/websocket?token="
)

const (
	MAIN_NET = iota
	TEST_NET
)

Variables

var ErrNotConnected = errors.New("websocket: not connected")

ErrNotConnected is returned when the application attempts to read/write a message and the connection is closed.

Functions

func NewNotifyService

func NewNotifyService(net int, key string) *notifyService

Types

type CollectionOfferRes

type CollectionOfferRes struct {
	AssetContractCriteria struct {
		Address string `json:"address"`
	} `json:"asset_contract_criteria"`
	BasePrice  string `json:"base_price"`
	Collection struct {
		Slug string `json:"slug"`
	} `json:"collection"`
	CollectionCriteria struct {
		Slug string `json:"slug"`
	} `json:"collection_criteria"`
	CreatedDate    string `json:"created_date"`
	EventTimestamp string `json:"event_timestamp"`
	ExpirationDate string `json:"expiration_date"`
	Maker          struct {
		Address string `json:"address"`
	} `json:"maker"`
	OrderHash    string `json:"order_hash"`
	PaymentToken struct {
		Address  string `json:"address"`
		Decimals int    `json:"decimals"`
		EthPrice int    `json:"eth_price"`
		Name     string `json:"name"`
		Symbol   string `json:"Symbol"`
		UsdPrice string `json:"usd_price"`
	} `json:"payment_token"`
	Quantity int `json:"quantity"`
}

type ItemCancelledRes

type ItemCancelledRes struct {
	EventTimestamp string `json:"event_timestamp"`
	ListingType    string `json:"listing_type"`
	PaymentToken   struct {
		Address  string `json:"address"`
		Decimals int    `json:"decimals"`
		EthPrice int    `json:"eth_price"`
		Name     string `json:"name"`
		Symbol   string `json:"Symbol"`
		UsdPrice string `json:"usd_price"`
	} `json:"payment_token"`
	Quantity    int `json:"quantity"`
	Transaction struct {
		Timestamp string `json:"Timestamp"`
		Hash      string `json:"hash"`
	} `json:"transaction"`
}

type ItemListRes

type ItemListRes struct {
	AnimationUrl string `json:"animation_url"`
	ImageUrl     string `json:"image_url"`
	MetadataUrl  string `json:"metadata_url"`
	Name         string `json:"name"`
}

type ItemListedRes

type ItemListedRes struct {
	EventTimestamp string `json:"event_timestamp"`
	BasePrice      string `json:"base_price"`
	Collection     struct {
		Slug string `json:"slug"`
	} `json:"collection"`
	ExpirationDate string `json:"expiration_date"`
	IsPrivate      bool   `json:"is_private"`
	ListingDate    string `json:"listing_date"`
	ListingType    string `json:"listing_type"`
	Maker          struct {
		Address string `json:"address"`
	} `json:"maker"`
	PaymentToken struct {
		Address  string `json:"address"`
		Decimals int    `json:"decimals"`
		EthPrice int    `json:"eth_price"`
		Name     string `json:"name"`
		Symbol   string `json:"Symbol"`
		UsdPrice string `json:"usd_price"`
	} `json:"payment_token"`
	Item struct {
		Chain struct {
			Name string `json:"name"`
		} `json:"chain"`
		Metadata  ItemListRes `json:"metadata"`
		NFTId     string      `json:"nft_id"`
		Permalink string      `json:"permalink"`
	} `json:"item"`
	Quantity int    `json:"quantity"`
	Taker    string `json:"taker"`
}

type ItemMetadataUpdatedRes

type ItemMetadataUpdatedRes struct {
	Name            string `json:"name"`
	Description     string `json:"description"`
	ImagePreviewUrl string `json:"image_preview_url"`
	AnimationUrl    string `json:"animation_url"`
	BackgroundColor string `json:"background_color"`
	MetadataUrl     string `json:"metadata_url"`
}

type ItemReceivedBidRes

type ItemReceivedBidRes struct {
	EventTimestamp string `json:"event_timestamp"`
	BasePrice      string `json:"base_price"`
	CreatedDate    string `json:"created_date"`
	ExpirationDate string `json:"expiration_date"`
	Maker          struct {
		Address string `json:"address"`
	} `json:"maker"`
	Item struct {
		Chain struct {
			Name string `json:"name"`
		} `json:"chain"`
		Metadata  ItemMetadataUpdatedRes `json:"metadata"`
		NFTId     string                 `json:"nft_id"`
		Permalink string                 `json:"permalink"`
	} `json:"item"`
	PaymentToken struct {
		Address  string `json:"address"`
		Decimals int    `json:"decimals"`
		EthPrice int    `json:"eth_price"`
		Name     string `json:"name"`
		Symbol   string `json:"Symbol"`
		UsdPrice string `json:"usd_price"`
	} `json:"payment_token"`
	Quantity int `json:"quantity"`
	Taker    struct {
		Address string `json:"address"`
	} `json:"taker"`
}

type ItemReceivedOfferRes

type ItemReceivedOfferRes struct {
	EventTimestamp string `json:"event_timestamp"`
	BasePrice      string `json:"base_price"`
	CreatedDate    string `json:"created_date"`
	ExpirationDate string `json:"expiration_date"`
	Item           struct {
		Chain struct {
			Name string `json:"name"`
		} `json:"chain"`
		Metadata  ItemMetadataUpdatedRes `json:"metadata"`
		NFTId     string                 `json:"nft_id"`
		Permalink string                 `json:"permalink"`
	} `json:"item"`
	Maker struct {
		Address string `json:"address"`
	} `json:"maker"`
	PaymentToken struct {
		Address  string `json:"address"`
		Decimals int    `json:"decimals"`
		EthPrice int    `json:"eth_price"`
		Name     string `json:"name"`
		Symbol   string `json:"Symbol"`
		UsdPrice string `json:"usd_price"`
	} `json:"payment_token"`
	Quantity int `json:"quantity"`
	Taker    struct {
		Address string `json:"address"`
	} `json:"taker"`
}

type ItemSoldRes

type ItemSoldRes struct {
	EventTimestamp string `json:"event_timestamp"`
	ClosingDate    string `json:"closing_date"`
	IsPrivate      bool   `json:"is_private"`
	ListingDate    string `json:"listing_date"`
	ListingType    string `json:"listing_type"`
	Maker          struct {
		Address string `json:"address"`
	} `json:"maker"`
	PaymentToken struct {
		Address  string `json:"address"`
		Decimals int    `json:"decimals"`
		EthPrice int    `json:"eth_price"`
		Name     string `json:"name"`
		Symbol   string `json:"Symbol"`
		UsdPrice string `json:"usd_price"`
	} `json:"payment_token"`
	Quantity int `json:"quantity"`
	Taker    struct {
		Address string `json:"address"`
	} `json:"taker"`
	Transaction struct {
		Timestamp string `json:"Timestamp"`
		Hash      string `json:"hash"`
	} `json:"transaction"`
}

type ItemTransferredRes

type ItemTransferredRes struct {
	EventTimestamp string `json:"event_timestamp"`
	Transaction    struct {
		Timestamp string `json:"Timestamp"`
		Hash      string `json:"hash"`
	} `json:"transaction"`
	FromAccount struct {
		Address string `json:"address"`
	} `json:"from_account"`
	ToAccount struct {
		Address string `json:"address"`
	} `json:"to_account"`
	Quantity int `json:"quantity"`
}

type Message

type Message struct {
	Topic   string      `json:"topic"`
	Event   string      `json:"event"`
	Payload PayloadJson `json:"payload"`
	Ref     int         `json:"ref"`
}

func (*Message) UnmarshalJSON

func (m *Message) UnmarshalJSON(data []byte) error

type MsgHandlerFanc

type MsgHandlerFanc func(msg *Message) error

type PayloadJson

type PayloadJson struct {
	EventType string      `json:"event_type,omitempty"`
	Payload   interface{} `json:"payload,omitempty"`
	SentAt    string      `json:"sent_at,omitempty"`
}

type Quit

type Quit struct {
	QuitChan chan bool
}

func NewQuit

func NewQuit() *Quit

func (*Quit) IsQuit

func (q *Quit) IsQuit() bool

func (*Quit) WatchOsSignal

func (q *Quit) WatchOsSignal()

type SafeCounter

type SafeCounter struct {
	// contains filtered or unexported fields
}

func (*SafeCounter) Inc

func (c *SafeCounter) Inc()

func (*SafeCounter) Value

func (c *SafeCounter) Value() int

type TraitOfferRes

type TraitOfferRes struct {
	AssetContractCriteria struct {
		Address string `json:"address"`
	} `json:"asset_contract_criteria"`
	BasePrice  string `json:"base_price"`
	Collection struct {
		Slug string `json:"slug"`
	} `json:"collection"`
	CollectionCriteria struct {
		Slug string `json:"slug"`
	} `json:"collection_criteria"`
	CreatedDate    string `json:"created_date"`
	EventTimestamp string `json:"event_timestamp"`
	ExpirationDate string `json:"expiration_date"`
	Maker          struct {
		Address string `json:"address"`
	} `json:"maker"`
	OrderHash    string `json:"order_hash"`
	PaymentToken struct {
		Address  string `json:"address"`
		Decimals int    `json:"decimals"`
		EthPrice int    `json:"eth_price"`
		Name     string `json:"name"`
		Symbol   string `json:"Symbol"`
		UsdPrice string `json:"usd_price"`
	} `json:"payment_token"`
	Quantity      int `json:"quantity"`
	TraitCriteria struct {
		TraitName string `json:"trait_name"`
		TraitType string `json:"trait_type"`
	} `json:"trait_criteria"`
}

type UnSubscribeHandlerFanc

type UnSubscribeHandlerFanc func()