Skip to content

Latest commit

 

History

History
110 lines (90 loc) · 2.38 KB

README.md

File metadata and controls

110 lines (90 loc) · 2.38 KB
Raw

imxpy

USE AT YOUR OWN RISK

THIS LIBRARY IS IN DEVELOPMENT AND CAN CONTAIN BUGS, USE AT YOUR OWN RISK! I WON'T BE RESPONSIBLE IF YOU LOSE YOUR MONEY!

Build & Install

// install npm

// install all dependencies
npm install

// build the typescript file
tsc

Examples

from imxpy import IMXClient

client = IMXClient(
    net="<main/test>, n_workers=<number of async workers>, pk="<YOUR_PRIVATE_KEY>"
)

# see imx_objects for parameter types
some_params = SomeParams()

# the client returns a future
future = client.some_function(some_params)
# resolve the future
res = future.result()

# if not interested in returned results, make the client shutdown its running processes
client.shutdown()

Other examples on how to use the client correctly can be found in tests/test_imx_client.py. Tests starting with test_okay_*, are meant to show the correct usage of the library, whereas the others show wrong behavior.

Feature Overview

Fell free to submit any feature requests / proposals through the issues.

Signable

  • register
  • approveNFT
  • approveERC20
  • deposit
  • depositCancel
  • depositReclaim
  • prepareWithdrawal
  • completeWithdrawal
  • transfer
  • burn
  • signMessage (it is there, but IMX currently just returns a success)
  • mint
  • createOrder
  • cancelOrder
  • createTrade
  • createExchange
  • createProject
  • createCollection
  • updateCollection
  • addMetadataSchemaToCollection
  • updateMetadataSchemaByName

Database

  • applications
    • list
    • details
  • assets
    • list
    • details
  • balances
    • list
    • token balance
  • TLV Info // seems to be version one and replaced by claims
  • collections
    • list
    • details
    • filters
    • metadataSchema
  • depostis
    • list
    • details
  • mints
    • mintable_token
    • mintable_token_with_addr
    • mints
    • mints details
  • `orders
    • list
    • details
  • `claims
  • starkkeys
  • transfers
    • list
    • details
  • withdrawals
    • list
    • details
  • snapshot
  • tokens
    • list
    • details
  • trades
    • list
    • details

Known Issues