@imtbl/core-sdk - npm Package Versions

[1.0.0-beta.3] - 2022-10-18

Fixed

• Correct the x-sdk-version header value

[1.0.0-beta.2] - 2022-09-28

Added

• Added methods from MetadataRefreshesApi

Changed

• Expose fewer public methods to make it easier for us to maintain the SDK.
• Introduced a single entry point for the SDK to improve discoverability
• Clear response and error types, no more Axios wrappers
• Simplified complex types required for creating trades, orders and transfers, no more SignableToken in the interface
• Make the deposit method on SDK consistent with the API and industry norms.
• SDK now handles L1 signature-protected APIs; no need to generate imx-signature separately for authentication headers
• Removed wallet-specific logic
• Removed the ethereumjs-wallet dependency.

[0.7.0] - 2022-08-03

Added

• Added on all workflow methods a chain check comparing the current connected wallet chain versus the chain informed on setup phase

Changed

• listMints endpoint accepts max_timestamp, min_timestamp instead of updated_max_timestamp, updated_min_timestamp respectively

• [BREAKING CHANGE] x-imx-eth-address, and x-imx-eth-signature headers are now required for createOrder, cancelOrder, createTransfer, createTransferV1, createWithdrawal, and createTrade endpoints.

• [BREAKING CHANGE] Removed the getKeyPairFromPrivateKey function

• [BREAKING CHANGE] Removed the getStarkPublicKey function

• [BREAKING CHANGE] getConfig method now requires environment parameters and returns the new ImmutableXConfiguration

• [BREAKING CHANGE] Renamed the registerOffchainWithSigner method to registerOffchain

• [BREAKING CHANGE] Renamed the isRegisteredOnchainWithSigner method to isRegisteredOnchain

• [BREAKING CHANGE] Renamed the transferWithSigner method to transfer

• [BREAKING CHANGE] Renamed the batchNftTransferWithSigner method to batchNftTransfer

• [BREAKING CHANGE] Renamed the burnWithSigner method to burn

• [BREAKING CHANGE] Renamed the prepareWithdrawalWithSigner method to prepareWithdrawal

• [BREAKING CHANGE] Renamed the createOrderWithSigner method to createOrder

• [BREAKING CHANGE] Renamed the cancelOrderWithSigner method to cancelOrder

• [BREAKING CHANGE] Renamed the createTradeWithSigner method to createTrade

• Changed the getAddress method from the L2Signer interface to be able to return both string or async Promise<string>

Removed

• [BREAKING CHANGE] Removed the deprecated registerOffchain method
• [BREAKING CHANGE] Removed the deprecated isRegisteredOnchain method
• [BREAKING CHANGE] Removed the deprecated transfer method
• [BREAKING CHANGE] Removed the deprecated batchNftTransfer method
• [BREAKING CHANGE] Removed the deprecated burn method
• [BREAKING CHANGE] Removed the deprecated prepareWithdrawal method
• [BREAKING CHANGE] Removed the deprecated createOrder method
• [BREAKING CHANGE] Removed the deprecated cancelOrder method
• [BREAKING CHANGE] Removed the deprecated createTrade method

[0.6.0] - 2022-07-18

Added

• Added createOrderWithSigner function to enable create order with l2signer
• Added cancelOrderWithSigner function to enable cancel order with l2signer
• Added WalletConnection type
• Added transferWithSigner function to enable transfer with l2signer
• Added batchNftTransferWithSigner function to enable batch transfer with l2signer
• Added prepareWithdrawalWorkflowWithSigner function to enable prepare withdrawal with l2signer
• Added burnWithSigner function to enable burn with l2signer
• Added getStarkPublicKeyWithXCoordinate method to get the same public key as the generateStarkWallet returns

Deprecated

• createOrder, use createOrderWithSigner instead
• cancelOrder, use cancelOrderWithSigner instead
• transfer, use transferWithSigner instead
• batchNftTransfer, use batchNftTransferWithSigner instead
• prepareWithdrawalWorkflow, use prepareWithdrawalWorkflowWithSigner instead
• burn, use burnWithSigner instead
• getStarkPublicKey, use BaseSigner's getAddress instead

[0.5.0] - 2022-07-12

Added

• Added registerOffchainWithSigner function to enable register offchain user with L2Signer

Changed

• Changed registerOffchainWorkflowWithSigner to return a void promise and return early if wallet is already registered
• RegisterUserRequest email property added
• [BREAKING CHANGE] Transfer and ListTransfersResponse objects swapped data and type properties with token

Deprecated

• registerOffchain, use registerOffchainWithSigner instead

Fixed

• getAddress method from BaseSigner
• Mark project_id as required on CreateCollectionRequest
• Updated list orders OpenAPI spec to document the include_fees query param