Documentation
¶
Index ¶
- Constants
- func MintSignature(mint Mint, privateKey *ecdsa.PrivateKey) (string, error)
- func Sign(msg []byte, privateKey *ecdsa.PrivateKey) (string, error)
- type Asset
- type Balance
- type Client
- func (c *Client) GetAsset(request *GetAssetRequest) (*Asset, error)
- func (c *Client) GetToken(request *GetTokenRequest) (*Token, error)
- func (c *Client) GetTransfer(request GetTransferRequest) (response types.Transfer, err error)
- func (c *Client) ListAssets(request *ListAssetsRequest) (*ListAssetsResponse, error)
- func (c *Client) ListBalances(request ListBalancesRequest) (response ListBalancesResponse, err error)
- func (c *Client) ListOrders(request *ListOrdersRequest) (*ListOrdersResponse, error)
- func (c *Client) ListTransfers(request ListTransfersRequest) (response ListTransfersResponse, err error)
- func (c *Client) Mint(request *MintRequest) (*MintResponse, error)
- func (c *Client) RestRequest(method, path string, data url.Values, body, responseType interface{}) error
- func (c *Client) SDKRequest(method, path string, data url.Values, body, responseType interface{}) error
- func (c *Client) TransferERC20(request *TransferERC20Request) (response TransferERC20Response, err error)
- func (c *Client) TransferERC721(request *TransferERC721Request) (response TransferERC721Response, err error)
- type Collection
- type GetAssetRequest
- type GetTokenRequest
- type GetTransferRequest
- type IMXError
- type IMXResponse
- type InitSDKRequest
- type InitSDKResponse
- type ListAssetsRequest
- type ListAssetsResponse
- type ListBalancesRequest
- type ListBalancesResponse
- type ListOrdersRequest
- type ListOrdersResponse
- type ListTransfersRequest
- type ListTransfersResponse
- type Mint
- type MintData
- type MintRequest
- type MintResponse
- type Network
- type Option
- type Order
- type OrderData
- type OrderDetail
- type SDKServiceParams
- type SigMint
- type Token
- type TokenToMint
- type TransferERC20Request
- type TransferERC20Response
- type TransferERC721Request
- type TransferERC721Response
Constants ¶
View Source
const ApplicationsURL = "/v1/applications"
View Source
const AssetsURL = "/v1/assets"
View Source
const BalancesURL = "/v2/balances"
View Source
const ClaimsURL = "/v1/rewards"
View Source
const CollectionsURL = "/v1/collections"
View Source
const DepositsURL = "/v1/deposits"
View Source
const MainnetURL = "https://api.x.immutable.com"
View Source
const MintableTokenURL = "/v1/mintable-token"
View Source
const MintsURL = "/v1/mints"
View Source
const OrdersURL = "/v1/orders"
View Source
const RopstenURL = "https://api.ropsten.x.immutable.com"
View Source
const SDKInitURL = "init"
View Source
const SDKTransferERC20URL = "erc20/transfer"
View Source
const SDKTransferERC721URL = "erc721/transfer"
View Source
const SnapshotURL = "/v1/snapshot/balances"
View Source
const TokensURL = "/v1/tokens"
View Source
const TradesURL = "/v1/trades"
View Source
const TransfersURL = "/v1/transfers"
View Source
const UsersURL = "/v1/users"
View Source
const WithdrawalsURL = "/v1/withdrawals"
Variables ¶
This section is empty.
Functions ¶
func MintSignature ¶
func MintSignature(mint Mint, privateKey *ecdsa.PrivateKey) (string, error)
Types ¶
type Asset ¶
type Asset struct {
ID string `json:"id"`
TokenAddress string `json:"token_address"`
TokenID string `json:"token_id"`
User string `json:"user"`
Status string `json:"eth"`
URI string `json:"uri"`
Name string `json:"name"`
Description string `json:"description"`
ImageURL string `json:"image_url"`
Metadata interface{} `json:"metadata"`
Collection Collection `json:"collection"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
}
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) GetToken ¶ added in v0.1.7
func (c *Client) GetToken(request *GetTokenRequest) (*Token, error)
func (*Client) GetTransfer ¶
func (c *Client) GetTransfer(request GetTransferRequest) (response types.Transfer, err error)
func (*Client) ListAssets ¶
func (c *Client) ListAssets(request *ListAssetsRequest) (*ListAssetsResponse, error)
func (*Client) ListBalances ¶
func (c *Client) ListBalances(request ListBalancesRequest) (response ListBalancesResponse, err error)
func (*Client) ListOrders ¶
func (c *Client) ListOrders(request *ListOrdersRequest) (*ListOrdersResponse, error)
func (*Client) ListTransfers ¶
func (c *Client) ListTransfers(request ListTransfersRequest) (response ListTransfersResponse, err error)
func (*Client) Mint ¶
func (c *Client) Mint(request *MintRequest) (*MintResponse, error)
func (*Client) RestRequest ¶
func (*Client) SDKRequest ¶
func (*Client) TransferERC20 ¶
func (c *Client) TransferERC20(request *TransferERC20Request) (response TransferERC20Response, err error)
func (*Client) TransferERC721 ¶
func (c *Client) TransferERC721(request *TransferERC721Request) (response TransferERC721Response, err error)
type Collection ¶
type GetAssetRequest ¶
type GetTokenRequest ¶ added in v0.1.7
type GetTokenRequest struct {
TokenAddress string
}
type GetTransferRequest ¶
type GetTransferRequest struct {
TransferID string
}
type IMXResponse ¶
type IMXResponse struct {
Payload interface{}
}
type InitSDKRequest ¶
type InitSDKResponse ¶
type ListAssetsRequest ¶
type ListAssetsRequest struct {
PageSize int `url:"page_size,omitempty"`
Cursor string `url:"cursor,omitempty"`
OrderBy string `url:"order_by,omitempty"`
Direction string `url:"direction,omitempty"`
User string `url:"user,omitempty"`
Status string `url:"status,omitempty"`
Name string `url:"name,omitempty"`
Metadata string `url:"metadata,omitempty"`
SellOrders bool `url:"sell_orders,omitempty"`
BuyOrders bool `url:"buy_orders,omitempty"`
IncludeFees bool `url:"include_fees,omitempty"`
Collection string `url:"collection,omitempty"`
UpdatedMinTimestamp string `url:"updated_min_timestamp,omitempty"`
UpdatedMaxTimestamp string `url:"updated_max_timestamp,omitempty"`
}
type ListAssetsResponse ¶
type ListBalancesRequest ¶
type ListBalancesRequest struct {
Owner string `url:"owner,omitempty"`
}
type ListBalancesResponse ¶
type ListOrdersRequest ¶
type ListOrdersRequest struct {
PageSize int `url:"page_size,omitempty"`
Cursor string `url:"cursor,omitempty"`
OrderBy string `url:"order_by,omitempty"`
Direction string `url:"direction,omitempty"`
User string `url:"user,omitempty"`
Status string `url:"status,omitempty"`
MinTimestamp string `url:"min_timestamp,omitempty"`
MaxTimestamp string `url:"max_timestamp,omitempty"`
UpdatedMinTimestamp string `url:"updated_min_timestamp,omitempty"`
UpdatedMaxTimestamp string `url:"updated_max_timestamp,omitempty"`
BuyTokenType string `url:"buy_token_type,omitempty"`
BuyTokenID string `url:"buy_token_id,omitempty"`
BuyAssetID string `url:"buy_asset_id,omitempty"`
BuyTokenAddress string `url:"buy_token_address,omitempty"`
BuyTokenName string `url:"buy_token_name,omitempty"`
BuyMinQuantity string `url:"buy_min_quantity,omitempty"`
BuyMaxQuantity string `url:"buy_max_quantity,omitempty"`
BuyMetadata string `url:"buy_metadata,omitempty"`
SellTokenType string `url:"sell_token_type,omitempty"`
SellTokenID string `url:"sell_token_id,omitempty"`
SellAssetID string `url:"sell_asset_id,omitempty"`
SellTokenAddress string `url:"sell_token_address,omitempty"`
SellMinQuantity string `url:"sell_min_quantity,omitempty"`
SellMaxQuantity string `url:"sell_max_quantity,omitempty"`
SellMetadata string `url:"sell_metadata,omitempty"`
}
type ListOrdersResponse ¶
type ListTransfersRequest ¶
type ListTransfersRequest struct {
PageSize int `url:"page_size,omitempty"`
Cursor string `url:"cursor,omitempty"`
OrderBy string `url:"order_by,omitempty"`
Direction string `url:"direction,omitempty"`
User string `url:"user,omitempty"`
Receiver string `url:"receiver,omitempty"`
Status string `url:"status,omitempty"`
Name string `url:"name,omitempty"`
Metadata string `url:"metadata,omitempty"`
SellOrders bool `url:"sell_orders,omitempty"`
BuyOrders bool `url:"buy_orders,omitempty"`
IncludeFees bool `url:"include_fees,omitempty"`
Collection string `url:"collection,omitempty"`
UpdatedMinTimestamp string `url:"updated_min_timestamp,omitempty"`
UpdatedMaxTimestamp string `url:"updated_max_timestamp,omitempty"`
}
type ListTransfersResponse ¶
type Mint ¶
type Mint struct {
User string `json:"user"`
Tokens []TokenToMint `json:"tokens"`
Nonce int64 `json:"nonce"`
AuthSignature string `json:"auth_signature"`
}
type MintRequest ¶
type MintRequest struct {
Mints []Mint `json:"mints"`
}
type MintResponse ¶
type MintResponse struct {
}
type Option ¶
type Option interface {
// contains filtered or unexported methods
}
func SetIMXSDKServiceParams ¶
func SetIMXSDKServiceParams(params SDKServiceParams) Option
type Order ¶
type Order struct {
OrderID int `json:"order_id"`
Status string `json:"status"`
User string `json:"user"`
Sell OrderDetail `json:"sell"`
Buy OrderDetail `json:"buy"`
AmountSold string `json:"amount_sold"`
ExpirationTimestamp string `json:"expiration_timestamp"`
Timestamp string `json:"timestamp"`
UpdatedTimestamp string `json:"updated_timestamp"`
}
type OrderDetail ¶
type SDKServiceParams ¶
type SigMint ¶
type SigMint struct {
EtherKey string `json:"ether_key"`
Tokens []TokenToMint `json:"tokens"`
Nonce int64 `json:"nonce"`
AuthSignature string `json:"auth_signature"`
}
type TokenToMint ¶ added in v0.1.7
type TransferERC20Request ¶
type TransferERC20Response ¶
type TransferERC20Response struct {
TransferIDs []int `json:"transfer_ids"`
}
type TransferERC721Request ¶
type TransferERC721Response ¶
type TransferERC721Response struct {
TransferIDs []int `json:"transfer_ids"`
}
Click to show internal directories.
Click to hide internal directories.