Skip to content

Releases: alchemyplatform/alchemy-sdk-js

v2.1.0

29 Sep 15:55
0edf193
Compare
Choose a tag to compare

Major Changes

  • POTENTIALLY BREAKING: Fixed a typing bug where the totalSupply field in an NftContract should have type string instead of number.
  • Updated the Nft class to include the contract metadata in the Nft.contract field.
  • Added commonly used utility methods from ethers.js into a top-level Utils export.
  • Added the NftNamespace.verifyNftOwnership() method to replace the deprecated checkNftOwnership() method.
  • Added Contract and ContractFactory exports from ethers into the top-level exports.

Minor Changes

  • Added support for withTokenBalances in NftNamespace.getOwnersForContract().
  • Added support for the erc20 token type and pagination for CoreNamespace.getTokenBalances().
  • Added bytes field to the Media object in the NFT metadata responses to indicate the size of the media in bytes. Note that the size field is not supported by the backend and will be removed in the next version.

v2.0.3

19 Aug 18:28
Compare
Choose a tag to compare

Minor Changes

  • Added support for the pageSize parameter in GetNftsForOwnerOptions to specify the number of NFTs fetched when using alchemy.nft.getNftsForOwner().
  • Added support for a Wallet object. This object is identical to the Ethers Wallet class.
  • Added support for Arbitrum Goerli network via the Network.ARB_GOERLI enum.
  • Added support for the AStar Mainnet network via the Network.ASTAR_MAINNET enum.
  • Added typed request/response overloads for CoreNamespace.getAssetTransfers() for when the withMetadata param is true.
  • Added support the tokenUriTimeoutInMs parameter on getNftsForOwner(), getNftMetadata(), and getNftsForContract().

v2.0.2

10 Aug 17:37
Compare
Choose a tag to compare

Major Changes

  • Added the transact namespace for functionality relating to sending transactions. This includes the Flashbots methods sendPrivateTransaction and cancelPrivateTransaction.

Minor Changes

  • Removed the deprecated TOKEN enum from AssetTransfersCategory.
  • Added support for Optimism Goerli network via the Network.OPT_GOERLI enum.
  • Added the pageSize parameter in GetNftsForContractOption to specify the number of NFTs fetched when using alchemy.nft.getNftsForContract.
  • Added correct withMetadata typing to AssetTransfersResponse.

v2.0.1

01 Aug 21:26
Compare
Choose a tag to compare

What's Changed

  • Added option to hardcode URL endpoint for all SDK requests in AlchemySettings @thebrianchen in #79
  • Fixed a bug where the SDK would incorrectly include a gzip header in browser environments by @thebrianchen in #78

Full Changelog: v2.0.0...v2.0.1

v2.0.0

25 Jul 22:12
b9bb9cd
Compare
Choose a tag to compare

Features

  • Top level package has moved from @alch/alchemy-sdk to alchemy-sdk for convenience. New command to install is npm install alchemy-sdk
  • Updated instantiation syntax: initializeAlchemy(settings) is now new Alchemy(settings)
  • Added three namespaces under the Alchemy object: core, nft, and ws. All Ethers.js provider methods and Alchemy Enhanced APIs (other than NFT) are under core.
  • Moved top-level methods under the Alchemy object. Instead of getNftsByOwner(alchemy, 'vitalik.eth'), now methods are called using alchemy.nft.getNftsByOwner('vitalik.eth')
  • Ethers.js Alchemy Provider methods are now directly embedded under alchemy.core
  • Ethers.js WebSocket Provider methods are now directly embedded under alchemy.ws
  • The settings object is now a config module under alchemy.config.
  • If necessary, the full Ethers.js Provider is now available under alchemy.config.getProvider() as a promise to reduce bundle size.
  • If necessary, the full WebSocket Provider is now available under alchemy.config.getWebSocketProvider() as a promise to reduce bundle size.
  • Dynamic imports for large methods (in particular, Ethers.js methods) are now supported. Initial package size for the Alchemy SDK is 20kB, and will only download Ethers.js packages when a relevant method is called.
  • Methods including Collection in the NFT package have been renamed to Contract: for instance, getNftsForCollection is now getNftsForContract.

v1.2.0

22 Jul 18:30
Compare
Choose a tag to compare

What's Changed

Full Changelog: v1.0.8...v1.2.0

v1.0.8

09 Jul 21:48
Compare
Choose a tag to compare

What's Changed

  • Significant reductions in bundle size. Using the NFT API will drop the ethers dependency when using a bundler like webpack by @thebrianchen in #45 and #47
  • Fixed a bug where NFTs without a description field would throw an error by @deric-alchemy in #50

Full Changelog: v1.0.6...v1.0.8

v1.0.7 BROKEN RELEASE

09 Jul 21:46
Compare
Choose a tag to compare

v1.0.7 has been marked deprecated in npm as this release accidentally included breaking changes. Please use v1.0.8 instead.

v1.0.6

30 Jun 22:36
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v1.0.4...v1.0.6

v1.0.4

17 Jun 00:10
Compare
Choose a tag to compare

What's Changed

Full Changelog: v1.0.3...v1.0.4