imx

package

Go to main page

Versions in this module

v1

v1.1.0

Oct 24, 2023

v1.0.1

Oct 23, 2023

v1.0.0

Aug 1, 2023

Changes in this version

type Client

+ AssetsAPI api.AssetsApi

+ BalancesAPI api.BalancesApi

+ CollectionsAPI api.CollectionsApi

+ DepositsAPI api.DepositsApi

+ EncodingAPI api.EncodingApi

+ ExchangesAPI api.ExchangesApi

+ MetadataAPI api.MetadataApi

+ MetadataRefreshesAPI api.MetadataRefreshesApi

+ MintsAPI api.MintsApi

+ NftCheckoutPrimaryAPI api.NftCheckoutPrimaryApi

+ OrdersAPI api.OrdersApi

+ ProjectsAPI api.ProjectsApi

+ TokensAPI api.TokensApi

+ TradesAPI api.TradesApi

+ TransfersAPI api.TransfersApi

+ UsersAPI api.UsersApi

+ WithdrawalsAPI api.WithdrawalsApi

type L1Signer

+ GetPublicKey func() string

type L2Signer

+ GetPublicKey func() string

type MintableTokenData

+ TokenAddress string

v1.0.0-beta.1

Dec 12, 2022

v0

v0.2.2

Nov 14, 2022

v0.2.1

Oct 14, 2022

Changes in this version

+ var Ropsten = Environment

v0.2.0

Oct 10, 2022

Changes in this version

+ const ContractInvalidError

+ const ERC20TokenType

+ const ERC721TokenType

+ const ETHTokenType

+ const EthClientError

+ var Mainnet = Environment

+ var Sandbox = Environment

+ func NewIMXError(httpResponse *http.Response, err error) error

+ func SignableERC20Token(decimals int, tokenAddress string) api.SignableToken

+ func SignableERC721Token(tokenID, tokenAddress string) api.SignableToken

+ func SignableETHToken() api.SignableToken

+ type Client struct

+ CoreContract *contracts.Core

+ Environment Environment

+ EthClient *ethclient.Client

+ RegistrationContract *contracts.Registration

+ func NewClient(cfg *Config) (*Client, error)

+ func (c *Client) AddMetadataSchemaToCollection(ctx context.Context, l1signer L1Signer, contractAddress string, ...) (*api.SuccessResponse, error)

+ func (c *Client) BatchNftTransfer(ctx context.Context, l1signer L1Signer, l2signer L2Signer, ...) (*api.CreateTransferResponse, error)

+ func (c *Client) CancelOrder(ctx context.Context, l1signer L1Signer, l2signer L2Signer, ...) (*api.CancelOrderResponse, error)

+ func (c *Client) CreateCollection(ctx context.Context, l1signer L1Signer, ...) (*api.Collection, error)

+ func (c *Client) CreateMetadataRefresh(ctx context.Context, l1signer L1Signer, ...) (*api.CreateMetadataRefreshResponse, error)

+ func (c *Client) CreateOrder(ctx context.Context, l1signer L1Signer, l2signer L2Signer, ...) (*api.CreateOrderResponse, error)

+ func (c *Client) CreateProject(ctx context.Context, l1signer L1Signer, ...) (*api.CreateProjectResponse, error)

+ func (c *Client) CreateTrade(ctx context.Context, l1signer L1Signer, l2signer L2Signer, ...) (*api.CreateTradeResponse, error)

+ func (c *Client) GetAsset(ctx context.Context, tokenAddress, tokenID string, includeFees *bool) (*api.Asset, error)

+ func (c *Client) GetBalance(ctx context.Context, owner, tokenAddress string) (*api.Balance, error)

+ func (c *Client) GetCollection(ctx context.Context, collectionContractAddress string) (*api.Collection, error)

+ func (c *Client) GetDeposit(ctx context.Context, id string) (*api.Deposit, error)

+ func (c *Client) GetMetadataRefreshErrors(ctx context.Context, l1signer L1Signer, refreshID string, pageSize *int32, ...) (*api.GetMetadataRefreshErrorsResponse, error)

+ func (c *Client) GetMetadataRefreshResults(ctx context.Context, l1signer L1Signer, refreshID string) (*api.GetMetadataRefreshResponse, error)

+ func (c *Client) GetMetadataSchema(ctx context.Context, collectionContractAddress string) ([]api.MetadataSchemaProperty, error)

+ func (c *Client) GetMint(ctx context.Context, id string) (*api.Mint, error)

+ func (c *Client) GetOrder(ctx context.Context, id string) (*api.Order, error)

+ func (c *Client) GetProject(ctx context.Context, l1signer L1Signer, id string) (*api.Project, error)

+ func (c *Client) GetProjects(ctx context.Context, l1signer L1Signer, pageSize *int32, ...) (*api.GetProjectsResponse, error)

+ func (c *Client) GetToken(ctx context.Context, id string) (*api.TokenDetails, error)

+ func (c *Client) GetTrade(ctx context.Context, id string) (*api.Trade, error)

+ func (c *Client) GetTransfer(ctx context.Context, id string) (*api.Transfer, error)

+ func (c *Client) GetUsers(ctx context.Context, user string) (*api.GetUsersApiResponse, error)

+ func (c *Client) GetWithdrawal(ctx context.Context, id string) (*api.Withdrawal, error)

+ func (c *Client) IsRegisteredOnChain(ctx context.Context, starkPublicKey string) (*bool, error)

+ func (c *Client) ListAssets(req *api.ApiListAssetsRequest) (*api.ListAssetsResponse, error)

+ func (c *Client) ListBalances(req *api.ApiListBalancesRequest) (*api.ListBalancesResponse, error)

+ func (c *Client) ListCollectionFilters(req *api.ApiListCollectionFiltersRequest) (*api.CollectionFilter, error)

+ func (c *Client) ListCollections(req *api.ApiListCollectionsRequest) (*api.ListCollectionsResponse, error)

+ func (c *Client) ListDeposits(req *api.ApiListDepositsRequest) (*api.ListDepositsResponse, error)

+ func (c *Client) ListMetadataRefreshes(ctx context.Context, l1signer L1Signer, collectionAddress *string, ...) (*api.GetMetadataRefreshes, error)

+ func (c *Client) ListMints(req *api.ApiListMintsRequest) (*api.ListMintsResponse, error)

+ func (c *Client) ListOrders(req *api.ApiListOrdersRequest) (*api.ListOrdersResponse, error)

+ func (c *Client) ListTokens(req *api.ApiListTokensRequest) (*api.ListTokensResponse, error)

+ func (c *Client) ListTrades(req *api.ApiListTradesRequest) (*api.ListTradesResponse, error)

+ func (c *Client) ListTransfers(req *api.ApiListTransfersRequest) (*api.ListTransfersResponse, error)

+ func (c *Client) ListWithdrawals(req *api.ApiListWithdrawalsRequest) (*api.ListWithdrawalsResponse, error)

+ func (c *Client) Mint(ctx context.Context, l1signer L1Signer, ...) (*api.MintTokensResponse, error)

+ func (c *Client) NewIERC20Contract(ctx context.Context, address string) (*contracts.IERC20, error)

+ func (c *Client) NewIERC721Contract(ctx context.Context, address string) (*contracts.IERC721, error)

+ func (c *Client) NewListAssetsRequest(ctx context.Context) api.ApiListAssetsRequest

+ func (c *Client) NewListBalancesRequest(ctx context.Context, owner string) api.ApiListBalancesRequest

+ func (c *Client) NewListCollectionFiltersRequest(ctx context.Context, collectionContractAddress string) api.ApiListCollectionFiltersRequest

+ func (c *Client) NewListCollectionsRequest(ctx context.Context) api.ApiListCollectionsRequest

+ func (c *Client) NewListDepositsRequest(ctx context.Context) api.ApiListDepositsRequest

+ func (c *Client) NewListMintsRequest(ctx context.Context) api.ApiListMintsRequest

+ func (c *Client) NewListOrdersRequest(ctx context.Context) api.ApiListOrdersRequest

+ func (c *Client) NewListTokensRequest(ctx context.Context) api.ApiListTokensRequest

+ func (c *Client) NewListTradesRequest(ctx context.Context) api.ApiListTradesRequest

+ func (c *Client) NewListTransfersRequest(ctx context.Context) api.ApiListTransfersRequest

+ func (c *Client) NewListWithdrawalsRequest(ctx context.Context) api.ApiListWithdrawalsRequest

+ func (c *Client) PrepareWithdrawal(ctx context.Context, l1signer L1Signer, l2signer L2Signer, ...) (*api.CreateWithdrawalResponse, error)

+ func (c *Client) RegisterOffchain(ctx context.Context, l1signer L1Signer, l2signer L2Signer, userEmail string) (*api.RegisterUserResponse, error)

+ func (c *Client) Transfer(ctx context.Context, l1signer L1Signer, l2signer L2Signer, ...) (*api.CreateTransferResponseV1, error)

+ func (c *Client) UpdateCollection(ctx context.Context, l1signer L1Signer, contractAddress string, ...) (*api.Collection, error)

+ func (c *Client) UpdateMetadataSchemaByName(ctx context.Context, l1signer L1Signer, ...) (*api.SuccessResponse, error)

+ type Config struct

+ APIConfig *api.Configuration

+ AlchemyAPIKey string

+ type ERC20Deposit struct

+ Amount string

+ TokenAddress string

+ func NewERC20Deposit(unDecimalisedAmount uint64, tokenAddress string) *ERC20Deposit

+ func (d *ERC20Deposit) Deposit(ctx context.Context, c *Client, l1signer L1Signer, ...) (*types.Transaction, error)

+ type ERC20Withdrawal struct

+ TokenAddress string

+ func NewERC20Withdrawal(tokenAddress string) *ERC20Withdrawal

+ func (w *ERC20Withdrawal) CompleteWithdrawal(ctx context.Context, c *Client, l1signer L1Signer, starkKeyHex string, ...) (*types.Transaction, error)

+ type ERC721Deposit struct

+ TokenAddress string

+ TokenID string

+ func NewERC721Deposit(tokenID, tokenAddress string) *ERC721Deposit

+ func (d *ERC721Deposit) Deposit(ctx context.Context, c *Client, l1signer L1Signer, ...) (*types.Transaction, error)

+ type ERC721Withdrawal struct

+ TokenAddress string

+ TokenID string

+ func NewERC721Withdrawal(tokenID, tokenAddress string) *ERC721Withdrawal

+ func (w *ERC721Withdrawal) CompleteWithdrawal(ctx context.Context, c *Client, l1signer L1Signer, starkKeyHex string, ...) (*types.Transaction, error)

+ type ETHDeposit struct

+ Amount string

+ func NewETHDeposit(amount Wei) *ETHDeposit

+ func (d *ETHDeposit) Deposit(ctx context.Context, c *Client, l1signer L1Signer, ...) (*types.Transaction, error)

+ type Environment struct

+ BaseAPIPath string

+ ChainID *big.Int

+ CoreContractAddress string

+ EthereumRPC string

+ RegistrationContractAddress string

+ type EthWithdrawal struct

+ func NewEthWithdrawal() *EthWithdrawal

+ func (w *EthWithdrawal) CompleteWithdrawal(ctx context.Context, c *Client, l1signer L1Signer, starkKeyHex string, ...) (*types.Transaction, error)

+ type IMXError struct

+ HTTPStatusCode int

+ RequestURL string

+ func (e *IMXError) Error() string

+ type L1Signer interface

+ GetAddress func() string

+ SignMessage func(message string) ([]byte, error)

+ SignTx func(tx *types.Transaction) (*types.Transaction, error)

+ type L2Signer interface

+ GetAddress func() string

+ SignMessage func(message string) (string, error)

+ type MintFee struct

+ Percentage float32

+ Recipient string

+ type MintableTokenData struct

+ Blueprint *string

+ ID string

+ Royalties []MintFee

+ type TokenDeposit interface

+ Deposit func(ctx context.Context, c *Client, l1signer L1Signer, ...) (*types.Transaction, error)

+ type TokenWithdrawal interface

+ CompleteWithdrawal func(ctx context.Context, c *Client, l1signer L1Signer, starkPublicKey string, ...) (*types.Transaction, error)

+ type UnsignedMintRequest struct

+ AuthSignature string

+ ContractAddress string

+ Royalties []MintFee

+ Users []User

+ type User struct

+ Tokens []MintableTokenData

+ User string

+ type Wei = uint64

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