Releases: alchemyplatform/alchemy-sdk-js
Releases · alchemyplatform/alchemy-sdk-js
v2.1.0
Major Changes
- POTENTIALLY BREAKING: Fixed a typing bug where the
totalSupply
field in anNftContract
should have typestring
instead ofnumber
. - Updated the
Nft
class to include the contract metadata in theNft.contract
field. - Added commonly used utility methods from ethers.js into a top-level
Utils
export. - Added the
NftNamespace.verifyNftOwnership()
method to replace the deprecatedcheckNftOwnership()
method. - Added
Contract
andContractFactory
exports from ethers into the top-level exports.
Minor Changes
- Added support for
withTokenBalances
inNftNamespace.getOwnersForContract()
. - Added support for the
erc20
token type and pagination forCoreNamespace.getTokenBalances()
. - Added
bytes
field to theMedia
object in the NFT metadata responses to indicate the size of the media in bytes. Note that thesize
field is not supported by the backend and will be removed in the next version.
v2.0.3
Minor Changes
- Added support for the
pageSize
parameter inGetNftsForOwnerOptions
to specify the number of NFTs fetched when usingalchemy.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 thewithMetadata
param is true. - Added support the
tokenUriTimeoutInMs
parameter ongetNftsForOwner()
,getNftMetadata()
, andgetNftsForContract()
.
v2.0.2
Major Changes
- Added the
transact
namespace for functionality relating to sending transactions. This includes the Flashbots methodssendPrivateTransaction
andcancelPrivateTransaction
.
Minor Changes
- Removed the deprecated
TOKEN
enum fromAssetTransfersCategory
. - Added support for Optimism Goerli network via the
Network.OPT_GOERLI
enum. - Added the
pageSize
parameter inGetNftsForContractOption
to specify the number of NFTs fetched when usingalchemy.nft.getNftsForContract
. - Added correct
withMetadata
typing toAssetTransfersResponse
.
v2.0.1
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
Features
- Top level package has moved from
@alch/alchemy-sdk
toalchemy-sdk
for convenience. New command to install isnpm install alchemy-sdk
- Updated instantiation syntax:
initializeAlchemy(settings)
is nownew Alchemy(settings)
- Added three namespaces under the Alchemy object:
core
,nft
, andws
. All Ethers.js provider methods and Alchemy Enhanced APIs (other than NFT) are undercore
. - Moved top-level methods under the Alchemy object. Instead of
getNftsByOwner(alchemy, 'vitalik.eth')
, now methods are called usingalchemy.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 nowgetNftsForContract
.
v1.2.0
What's Changed
- Check if browser before adding 'accept encoding' by @deric-alchemy in #57
- Fix type exports by removing
@internal
tags by @thebrianchen in #63 - Update typings for getAssetTransfers() by @thebrianchen in #65
Full Changelog: v1.0.8...v1.2.0
v1.0.8
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
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
What's Changed
- Reordering overloads to suggest non-baseNft methods first by @deric-alchemy in #35
- Removing etc/ folder - outdated docs by @deric-alchemy in #36
- Add getNftContractMetadata by @deric-alchemy in #37
- Added isSpamNftContract, getSpamNftContracts, getNftFloorPrice by @deric-alchemy in #41
- Use 'websocket' library instead of 'ws' for easier integration with create-react-app by @thebrianchen in #42
New Contributors
- @deric-alchemy made their first contribution in #33
Full Changelog: v1.0.4...v1.0.6
v1.0.4
What's Changed
- Add gzip header for compression by @thebrianchen in #32
- Fixed a bug with default exports in react and node by @thebrianchen in #34
Full Changelog: v1.0.3...v1.0.4