Class AlchemyService

class of AlchemyService

Hierarchy (view full)

AbstractRpcService
- AlchemyService

Implements

IRpcService

Constructors

constructor

new AlchemyService(chainId?): AlchemyService
Parameters
- Optional chainId: number
  {number} the chainId number. defaults to getCurrentChain()
Returns AlchemyService
Overrides AbstractRpcService.constructor
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:45

Properties

`Static` enumPageKeyTypes

enumPageKeyTypes: {
from: number;
to: number;
} = ...

Type declaration

from: number
to: number

`Static` pageKeySplitter

pageKeySplitter: string = ...

Accessors

config

get config(): NetworkModels
return verified configurations

Returns NetworkModels
Implementation of IRpcService.config
Overrides AbstractRpcService.config
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:70

supportedChainMap

get supportedChainMap(): RpcSupportedChainMap
get supported chain map

Returns RpcSupportedChainMap
Implementation of IRpcService.supportedChainMap
Inherited from AbstractRpcService.supportedChainMap
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:76

supportedChains

get supportedChains(): number[]
get supported chain id list

Returns number[]
Implementation of IRpcService.supportedChains
Inherited from AbstractRpcService.supportedChains
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:86

supportedNetworks

get supportedNetworks(): string[]
get supported chain/network short name list

Returns string[]
Implementation of IRpcService.supportedNetworks
Inherited from AbstractRpcService.supportedNetworks
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:96

Methods

`Private` buildQueryingTransactionsCommonParameters

buildQueryingTransactionsCommonParameters(queryOptions?, fetchOptions?): object
Private
build the common parameters for querying transactions
Parameters
- Optional queryOptions: TransactionHistoryQueryOptions
  {TransactionHistoryQueryOptions}
- Optional fetchOptions: FetchListOptions
  {FetchListOptions}
Returns object
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:388

`Private` extractTransactionHistoryFetchOptionsPageKey

extractTransactionHistoryFetchOptionsPageKey(pageKeyType, fetchOptions?): undefined | string
Private
extract pageKey from fetchOptions
Parameters
- pageKeyType: number
  {number}
- Optional fetchOptions: FetchListOptions
  {TransactionHistoryFetchOptions}
Returns undefined | string
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:342

getDefaultContractAddresses

getDefaultContractAddresses(chainId?): string[]
get default contract addresses
Parameters
- Optional chainId: number
  {number} the chainId number
Returns string[]
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:142

getDefaultTransferTypes

getDefaultTransferTypes(chainId?): string[]
get default transfer types
Parameters
- Optional chainId: number
  {number} the chainId number
Returns string[]
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:101

queryBalance

queryBalance(address): Promise<bigint>
query balance of native token, ETH
Parameters
- address: string
  {string} wallet address
Returns Promise<bigint>
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:463

`Private` queryByParameter

queryByParameter(method, paramData, options?): Promise<any>
query transaction list by param
Parameters
- method: string
  {string}
- paramData: any
  {any}
- Optional options: FetchListOptions
  {FetchListOptions}
Returns Promise<any>
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:771

queryNFTs

queryNFTs(address, options?): Promise<null | any[]>
https://docs.alchemy.com/reference/getnfts
Parameters
- address: string
  {string} wallet Address for NFT owner (can be in ENS format on mainnet).
- Optional options: FetchListOptions
  {FetchListOptions}
Returns Promise<null | any[]>
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:849

queryTokenBalances

queryTokenBalances(address, tokens, options?): Promise<ContractTokenBalanceItem[]>
query token balance by token contract address
Parameters
- address: string
  {string} wallet address
- tokens: ContractTokenBalanceItem[]
  {Array}
- Optional options: FetchListOptions
  {FetchListOptions}
Returns Promise<ContractTokenBalanceItem[]>
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:504

`Private` queryTokenBalancesFindMoreInfo

queryTokenBalancesFindMoreInfo(tokens, contractAddress): Promise<undefined | ContractTokenBalanceItem>
Private
An extension function of queryTokenBalances that queries more information about a specified token through TokenService by contractAddress.
Parameters
- tokens: ContractTokenBalanceItem[]
  {Array} token list
- contractAddress: string
  {string} the contract address of a token
Returns Promise<undefined | ContractTokenBalanceItem>
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:619

queryTransactions

queryTransactions(address, queryOptions?, fetchOptions?): Promise<TransactionHistoryResult>
query all transaction list from/to the special address
Parameters
- address: string
  {string} wallet address
- Optional queryOptions: TransactionHistoryQueryOptions
  {TransactionHistoryQueryOptions}
- Optional fetchOptions: FetchListOptions
  {TransactionHistoryFetchOptions} .fromPageKey and .toPageKey can be defined as: - undefined : will start querying from the first page. - empty string : no query request will be sent.
Returns Promise<TransactionHistoryResult>
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:176

queryTransactionsByFromAddress

queryTransactionsByFromAddress(fromAddress, queryOptions?, fetchOptions?): Promise<TransactionHistoryResult>
query transaction list filter by fromAddress
Parameters
- fromAddress: string
  {string} payer's wallet address
- Optional queryOptions: TransactionHistoryQueryOptions
  {TransactionHistoryQueryOptions}
- Optional fetchOptions: FetchListOptions
  {TransactionHistoryFetchOptions}
Returns Promise<TransactionHistoryResult>
Remark
https://docs.alchemy.com/reference/alchemy-getassettransfers
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:260

queryTransactionsByParameter

queryTransactionsByParameter(transactionParam, fetchOptions?): Promise<TransactionHistoryResult>
query transaction list by param
Parameters
- transactionParam: any[]
  {Array}
- Optional fetchOptions: FetchListOptions
  {FetchListOptions}
Returns Promise<TransactionHistoryResult>
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:671

queryTransactionsByToAddress

queryTransactionsByToAddress(toAddress, queryOptions?, fetchOptions?): Promise<TransactionHistoryResult>
query transaction list filter by toAddress
Parameters
- toAddress: string
  {string} the recipient's wallet address
- Optional queryOptions: TransactionHistoryQueryOptions
  {TransactionHistoryQueryOptions}
- Optional fetchOptions: FetchListOptions
  {TransactionHistoryFetchOptions}
Returns Promise<TransactionHistoryResult>
Remark
https://docs.alchemy.com/reference/alchemy-getassettransfers
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:304

Basic Methods

`Protected` cloneConfig

cloneConfig(config): NetworkModels
Protected
deep clone configuration from the input
Parameters
- config: NetworkModels
  {NetworkModels}
Returns NetworkModels
Inherited from AbstractRpcService.cloneConfig
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:221

getEndpointByChainId

getEndpointByChainId(chainId?): string
set end point by chainId
Parameters
- Optional chainId: number
  {number} the chainId number
Returns string
Implementation of IRpcService.getEndpointByChainId
Overrides AbstractRpcService.getEndpointByChainId
- Defined in ../../src/services/rpcs/alchemy/AlchemyService.ts:82

getNetworkByChainId

getNetworkByChainId(chainId?): null | string
get network short name by chainId
Parameters
- Optional chainId: number
  {number} the chainId number
Returns null | string
Implementation of IRpcService.getNetworkByChainId
Inherited from AbstractRpcService.getNetworkByChainId
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:135

isSupportedChain

isSupportedChain(chainId): boolean
check if the given chainId is supported
Parameters
- chainId: number
  {number} the chainId number
Returns boolean
Inherited from AbstractRpcService.isSupportedChain
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:121

`Protected` setApiKey

setApiKey(apiKey): void
set api key
Parameters
- apiKey: string
  {string}
Returns void
Inherited from AbstractRpcService.setApiKey
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:204

`Protected` setChainMap

setChainMap(chainMap): void
set supported chain map
Parameters
- chainMap: RpcSupportedChainMap
  {RpcSupportedChainMap}
Returns void
Inherited from AbstractRpcService.setChainMap
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:168

`Protected` setEndpoint

setEndpoint(endpoint): void
set end point
Parameters
- endpoint: string
  {string} the end point url
Returns void
Inherited from AbstractRpcService.setEndpoint
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:180

`Protected` setVersion

setVersion(version): void
set version
Parameters
- version: string
  {string}
Returns void
Inherited from AbstractRpcService.setVersion
- Defined in ../../src/services/rpcs/AbstractRpcService.ts:192

Class AlchemyService

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Basic Methods

Constructors

constructor

Parameters

Returns AlchemyService

Properties

Static enumPageKeyTypes

Type declaration

from: number

to: number

Static pageKeySplitter

Accessors

config

Returns NetworkModels

supportedChainMap

Returns RpcSupportedChainMap

supportedChains

Returns number[]

supportedNetworks

Returns string[]

Methods

Private buildQueryingTransactionsCommonParameters

Parameters

Returns object

Private extractTransactionHistoryFetchOptionsPageKey

Parameters

Returns undefined | string

getDefaultContractAddresses

Parameters

Returns string[]

getDefaultTransferTypes

Parameters

Returns string[]

queryBalance

Parameters

Returns Promise<bigint>

Private queryByParameter

Parameters

Returns Promise<any>

queryNFTs

Parameters

Returns Promise<null | any[]>

queryTokenBalances

Parameters

Returns Promise<ContractTokenBalanceItem[]>

Private queryTokenBalancesFindMoreInfo

Parameters

Returns Promise<undefined | ContractTokenBalanceItem>

queryTransactions

Parameters

Returns Promise<TransactionHistoryResult>

queryTransactionsByFromAddress

Parameters

Returns Promise<TransactionHistoryResult>

Remark

queryTransactionsByParameter

Parameters

Returns Promise<TransactionHistoryResult>

queryTransactionsByToAddress

Parameters

Returns Promise<TransactionHistoryResult>

Remark

Basic Methods

Protected cloneConfig

Parameters

Returns NetworkModels

getEndpointByChainId

Parameters

Returns string

getNetworkByChainId

Parameters

Returns null | string

`Static` enumPageKeyTypes

`Static` pageKeySplitter

`Private` buildQueryingTransactionsCommonParameters

`Private` extractTransactionHistoryFetchOptionsPageKey

`Private` queryByParameter

`Private` queryTokenBalancesFindMoreInfo

`Protected` cloneConfig

`Protected` setApiKey

`Protected` setChainMap

`Protected` setEndpoint

`Protected` setVersion