Type Aliases
AddressValidationOptions
AddressValidationOptions: { apiValidation: boolean }
AlgorandSocketHelper
AlgorandSocketHelper: { claimHederaNfts: any; claimNfts: any; cleanNfts: any; waitAlgorandNft: any }
Type declaration
claimHederaNfts:function
- claimHederaNfts(from: number, to: string): Promise<any[]>
Parameters
Returns Promise<any[]>
claimNfts:function
- claimNfts(receiver: string): Promise<DbClaimInfo[]>
Parameters
Returns Promise<DbClaimInfo[]>
cleanNfts:function
- cleanNfts(owner: string): Promise<void>
Parameters
Returns Promise<void>
waitAlgorandNft:function
- waitAlgorandNft(sourceChain: number, receiver: string, action_id: string): Promise<ClaimNftInfo>
Parameters
sourceChain: number
receiver: string
action_id: string
Returns Promise<ClaimNftInfo>
ChainFactory
ChainFactory: { balance: any; bridgeStatus: any; checkWhitelist: any; claimHederaNFT: any; claimNFT: any; claimableAlgorandNfts: any; estimateBatchFees: any; estimateClaimFee: any; estimateFees: any; estimateSFTfees: any; estimateWithContractDep: any; getDestinationTransaction: any; getVerifiedContract: any; hederaGetMintedCollection: any; inner: any; isWrappedNft: any; listHederaClaimableNFT: any; lockNFT: any; mint: any; nftList: any; pkeyToSigner: any; setProvider: any; transferBatchNft: any; transferNft: any; transferSft: any; updateParams: any; waitAlgorandNft: any; whitelistEVM: any }
Type declaration
balance:function
- balance(inner: BalanceCheck, address: string): Promise<BigNumber>
Parameters
Returns Promise<BigNumber>
bridgeStatus:function
- bridgeStatus(): Promise<{}>
checkWhitelist:function
Type Parameters
Parameters
Returns Promise<boolean>
claimHederaNFT:function
- claimHederaNFT(serialNumber: BigNumberish, proxyAddress: string, htsToken: string, sender: Wallet): Promise<any>
Parameters
serialNumber: BigNumberish
proxyAddress: string
htsToken: string
sender: Wallet
Returns Promise<any>
claimNFT:function
- claimNFT<SignerF, RawNftF, Resp>(fromChain: TransferNftForeign<never, unknown, unknown> & UnfreezeForeignNft<never, unknown, unknown> & EstimateTxFees<unknown> & EstimateDeployFees & ChainNonceGet & ValidateAddress & { XpNft: string; XpNft1155?: string } & GetFeeMargins & GetExtraFees & LockNFT<never, unknown, unknown> & ClaimV3NFT<never, unknown> & GetClaimData, toChain: FullChain<SignerF, RawNftF, Resp>, txHash: string, sender: SignerF, fee: undefined | string): Promise<undefined | Resp>
Type Parameters
Parameters
toChain: FullChain<SignerF, RawNftF, Resp>
txHash: string
sender: SignerF
fee: undefined | string
Returns Promise<undefined | Resp>
claimableAlgorandNfts:function
- claimableAlgorandNfts(claimer: string): Promise<ClaimNftInfo[]>
Parameters
Returns Promise<ClaimNftInfo[]>
estimateBatchFees:function
- estimateBatchFees<SignerF, RawNftF, SignerT, RawNftT, Resp>(fromChain: FullChain<SignerF, RawNftF, Resp>, toChain: FullChain<SignerT, RawNftT, Resp>, nft: NftInfo<RawNftF>[], receiver: string): Promise<BigNumber>
Type Parameters
SignerF
RawNftF
SignerT
RawNftT
Resp
Parameters
fromChain: FullChain<SignerF, RawNftF, Resp>
toChain: FullChain<SignerT, RawNftT, Resp>
nft: NftInfo<RawNftF>[]
receiver: string
Returns Promise<BigNumber>
estimateClaimFee:function
- estimateClaimFee(fromChain: FullChain<never, unknown, unknown>, storageContract: undefined | BridgeStorage): Promise<string>
Parameters
fromChain: FullChain<never, unknown, unknown>
storageContract: undefined | BridgeStorage
Returns Promise<string>
estimateFees:function
- estimateFees<SignerF, RawNftF, SignerT, RawNftT, Resp>(fromChain: FullChain<SignerF, RawNftF, Resp>, toChain: FullChain<SignerT, RawNftT, Resp>, nft: NftInfo<RawNftF>, receiver: string): Promise<BigNumber>
Type Parameters
SignerF
RawNftF
SignerT
RawNftT
Resp
Parameters
fromChain: FullChain<SignerF, RawNftF, Resp>
toChain: FullChain<SignerT, RawNftT, Resp>
receiver: string
Returns Promise<BigNumber>
estimateSFTfees:function
- estimateSFTfees<SignerF, RawNftF, Resp>(fromChain: FullChain<SignerF, RawNftF, Resp>, amount: bigint, price: number): Promise<BigNumber>
Type Parameters
Parameters
fromChain: FullChain<SignerF, RawNftF, Resp>
amount: bigint
price: number
Returns Promise<BigNumber>
estimateWithContractDep:function
- estimateWithContractDep<SignerF, RawNftF, SignerT, RawNftT, Resp>(fromChain: FullChain<SignerF, RawNftF, Resp>, toChain: FullChain<SignerT, RawNftT, Resp>, nft: NftInfo<RawNftF>, receiver: string): Promise<{ calcContractDep: BigNumber }>
Type Parameters
SignerF
RawNftF
SignerT
RawNftT
Resp
Parameters
fromChain: FullChain<SignerF, RawNftF, Resp>
toChain: FullChain<SignerT, RawNftT, Resp>
receiver: string
Returns Promise<{ calcContractDep: BigNumber }>
getDestinationTransaction:function
Type Parameters
Parameters
destination: number
hash: Txn
transaction hash in original chain, unique action id
getVerifiedContract:function
- getVerifiedContract<SignerF, RawNftF, Resp>(from: string, targetChain: number, fc: FullChain<SignerF, RawNftF, Resp>, tokenId?: string): Promise<undefined | string>
Type Parameters
Parameters
from: string
targetChain: number
fc: FullChain<SignerF, RawNftF, Resp>
Optional tokenId: string
Returns Promise<undefined | string>
hederaGetMintedCollection:function
- hederaGetMintedCollection(from: number, receiver: string): Promise<any[]>
Parameters
from: number
receiver: string
Returns Promise<any[]>
inner:function
- inner<T>(chain: T): Promise<InferChainH<T>>
Type Parameters
T extends 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45
Parameters
Returns Promise<InferChainH<T>>
isWrappedNft:function
- isWrappedNft(nft: NftInfo<unknown>, fromChain: number): Promise<{ bool: boolean; wrapped: any }>
Parameters
Returns Promise<{ bool: boolean; wrapped: any }>
listHederaClaimableNFT:function
- listHederaClaimableNFT(proxyContract: string, htsToken: string, sender: Wallet): Promise<BigNumber[]>
Parameters
proxyContract: string
htsToken: string
sender: Wallet
Returns Promise<BigNumber[]>
lockNFT:function
- lockNFT<SignerF, RawNftF, Resp>(fromChain: FullChain<SignerF, RawNftF, Resp>, toChain: FullChain<never, unknown, unknown>, nft: NftInfo<RawNftF>, sender: SignerF, receiver: string, fee?: Value): Promise<undefined | Resp>
Type Parameters
Parameters
fromChain: FullChain<SignerF, RawNftF, Resp>
toChain: FullChain<never, unknown, unknown>
sender: SignerF
receiver: string
Optional fee: Value
Returns Promise<undefined | Resp>
mint:function
- mint<Signer, Args, Ret>(chain: MintNft<Signer, Args, Ret>, owner: Signer, args: Args): Promise<Ret>
Type Parameters
Parameters
chain: MintNft<Signer, Args, Ret>
owner: Signer
args: Args
Returns Promise<Ret>
nftList:function
Type Parameters
Parameters
Returns Promise<NftInfo<InferNativeNft<T>>[]>
pkeyToSigner:function
- pkeyToSigner<S>(nonce: S, key: string): Promise<InferSigner<InferChainH<S>>>
Type Parameters
S extends 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45
Parameters
Returns Promise<InferSigner<InferChainH<S>>>
setProvider:function
- setProvider(fromChain: number, provider: any): Promise<void>
Parameters
fromChain: number
provider: any
Returns Promise<void>
transferBatchNft:function
- transferBatchNft<SignerF, RawNftF, Resp>(fromChain: FullChainBatch<SignerF, RawNftF, Resp>, toChain: FullChainBatch<never, unknown, unknown>, nft: NftInfo<RawNftF>[], sender: SignerF, receiver: string, fee?: Value, mintWith?: string): Promise<Resp[]>
Type Parameters
Parameters
fromChain: FullChainBatch<SignerF, RawNftF, Resp>
toChain: FullChainBatch<never, unknown, unknown>
nft: NftInfo<RawNftF>[]
sender: SignerF
receiver: string
Optional fee: Value
Optional mintWith: string
Returns Promise<Resp[]>
transferNft:function
- transferNft<SignerF, RawNftF, Resp>(fromChain: FullChain<SignerF, RawNftF, Resp>, toChain: FullChain<never, unknown, unknown>, nft: NftInfo<RawNftF>, sender: SignerF, receiver: string, fee?: Value, mintWith?: string, gasLimit?: BigNumberish, extraFee?: Value, gasPrice?: BigNumberish): Promise<undefined | Resp>
Type Parameters
Parameters
fromChain: FullChain<SignerF, RawNftF, Resp>
toChain: FullChain<never, unknown, unknown>
sender: SignerF
receiver: string
Optional fee: Value
Optional mintWith: string
Optional gasLimit: BigNumberish
Optional extraFee: Value
Optional gasPrice: BigNumberish
Returns Promise<undefined | Resp>
transferSft:function
- transferSft<SignerF, RawNftF, Resp>(fromChain: FullChainBatch<SignerF, RawNftF, Resp>, toChain: FullChainBatch<never, unknown, unknown>, nft: NftInfo<RawNftF>, sender: SignerF, receiver: string, amt: bigint, fee?: Value, mintWith?: string): Promise<Resp[]>
Type Parameters
Parameters
fromChain: FullChainBatch<SignerF, RawNftF, Resp>
toChain: FullChainBatch<never, unknown, unknown>
sender: SignerF
receiver: string
amt: bigint
Optional fee: Value
Optional mintWith: string
Returns Promise<Resp[]>
updateParams:function
- updateParams<T>(nonce: T, params: InferChainParam<T>): void
Type Parameters
T extends 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45
Parameters
nonce: T
params: InferChainParam<T>
Returns void
waitAlgorandNft:function
Type Parameters
Parameters
txn: Txn
claimer: AlgoSignerH
Returns Promise<ClaimNftInfo>
whitelistEVM:function
- whitelistEVM<T>(chain: T, address: string, nonce: number): Promise<{ success: true }>
Type Parameters
T extends 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45
Parameters
chain: T
address: string
nonce: number
Returns Promise<{ success: true }>
DepTrxData
DepTrxData: { destinationChain: V3_ChainId; destinationUserAddress: string; nftType: "singular" | "multiple"; sourceChain: V3_ChainId; sourceNftContractAddress: string; tokenAmount: string; tokenId: string }
Type declaration
destinationChain: V3_ChainId
destinationUserAddress: string
nftType: "singular" | "multiple"
sourceChain: V3_ChainId
sourceNftContractAddress: string
tokenAmount: string
tokenId: string
ESDTRole
ESDTRole: "ESDTRoleNFTCreate" | "ESDTRoleNFTBurn"
ElrondHelper
Elrond
Helper
: BalanceCheck & TransferNftForeign<ElrondSigner, EsdtNftInfo, Transaction> & UnfreezeForeignNft<ElrondSigner, EsdtNftInfo, Transaction> & TransferNftForeignBatch<ElrondSigner, EsdtNftInfo, Transaction> & UnfreezeForeignNftBatch<ElrondSigner, EsdtNftInfo, Transaction> & IssueESDTNFT & MintNft<ElrondSigner, NftIssueArgs, string> & { mintableEsdts
: any } & ChainNonceGet & ValidateAddress & ExtractAction<Transaction> & PreTransfer<ElrondSigner, EsdtNftInfo, string, undefined> & EstimateTxFees<EsdtNftInfo> & EstimateTxFeesBatch<EsdtNftInfo> & PreTransferRawTxn<EsdtNftInfo, ElrondRawUnsignedTxn> & ExtractTxnStatus & SetESDTRoles & { XpNft
: string } & GetFeeMargins & { unwrapWegld
: any; wegldBalance
: any } & IsContractAddress & GetTokenURI & LockNFT<ElrondSigner, EsdtNftInfo, XTRX> & ClaimV3NFT<ElrondSigner, XTRX> & GetClaimData & GetTokenInfo & GetNftOriginEsdtTokenInfo
EsdtTokenInfo: { balance: 1 | string; tokenIdentifier: string }
Type declaration
Readonly balance: 1 | string
Readonly tokenIdentifier: string
EthNftInfo
EthNftInfo: { chainId: string; contract: string; contractType: "ERC721" | "ERC1155"; owner: string; tokenId: string; uri: string }
Type declaration
chainId: string
contract: string
contractType: "ERC721" | "ERC1155"
owner: string
tokenId: string
uri: string
ExtraArgs
ExtraArgs: { overrides: ethers.Overrides }
Type declaration
overrides: ethers.Overrides
MetaMap
MetaMap: { 11: Web3Meta; 12: Web3Meta; 13: Web3Meta; 14: Web3Meta; 15: AlgoMeta; 16: Web3Meta; 17: Web3Meta; 18: TezosMeta; 19: Web3Meta; 2: ElrondMeta; 20: Web3Meta; 21: Web3Meta; 22: Web3Meta; 23: Web3Meta; 24: SecretMeta; 25: Web3Meta; 26: SolanaMeta; 27: TonMeta; 28: DfinityMeta; 29: Web3Meta; 3: Web3Meta; 30: Web3ERC20Meta; 31: NearMeta; 32: Web3Meta; 33: Web3Meta; 34: AptosMeta; 35: Web3Meta; 36: Web3Meta; 37: Web3Meta; 38: Web3Meta; 39: CasperMeta; 4: Web3Meta; 40: Web3Meta; 41: Web3Meta; 42: Web3Meta; 43: Web3Meta; 44: Web3Meta; 45: Web3Meta; 5: Web3Meta; 6: Web3Meta; 7: Web3Meta; 8: Web3Meta; 9: TronMeta } & MetaMapAssert
MintArgs
MintArgs: { contract: string; uri: string }
Type declaration
contract: string
uri: string
MinterRes
MinterRes: { minter: string; whitelist: string[]; xpnft: string; xpnft1155: string }
Type declaration
minter: string
whitelist: string[]
xpnft: string
xpnft1155: string
MoralisNetwork
MoralisNetwork: "mainnet" | "testnet"
NftInfo
NftInfo<Raw>: { collectionIdent: string; native: Raw; originChain?: any; tokenId?: any; uri: string }
Type Parameters
Type declaration
Readonly collectionIdent: string
Readonly native: Raw
Optional Readonly originChain?: any
Optional Readonly tokenId?: any
Readonly uri: string
NftIssueArgs
NftIssueArgs: { attrs?: string; hash?: string; identifier: string; name: string; quantity?: number; royalties?: number; uris: string[] }
Type declaration
Optional Readonly attrs?: string
Optional Readonly hash?: string
Readonly identifier: string
Readonly name: string
Optional Readonly quantity?: number
Optional Readonly royalties?: number
Readonly uris: string[]
TokenInfo
TokenInfo: { image?: string; metadata: string; name: string; royalty: string; symbol: string }
Type declaration
Optional image?: string
metadata: string
name: string
royalty: string
symbol: string
TxnSocketHelper
TxnSocketHelper: { waitTxHash: any }
Type declaration
waitTxHash:function
- waitTxHash(chain: number, action_id: string): Promise<string>
Parameters
chain: number
action_id: string
Returns Promise<string>
transaction hash on the foreign chain
Web3Helper
Web3
Helper
: BaseWeb3Helper & TransferNftForeign<Signer, EthNftInfo, TransactionResponse> & UnfreezeForeignNft<Signer, EthNftInfo, TransactionResponse> & TransferNftForeignBatch<Signer, EthNftInfo, TransactionResponse> & UnfreezeForeignNftBatch<Signer, EthNftInfo, TransactionResponse> & EstimateTxFees<EthNftInfo> & EstimateTxFeesBatch<EthNftInfo> & EstimateDeployFees & ChainNonceGet & IsApproved<Signer> & Approve<Signer> & ValidateAddress & ExtractAction<TransactionResponse> & { createWallet
: any } & Pick<PreTransfer<Signer, EthNftInfo, string, ExtraArgs>, "preTransfer"> & PreTransferRawTxn<EthNftInfo, PopulatedTransaction> & ExtractTxnStatus & GetProvider<providers.Provider> & { XpNft
: string; XpNft1155
: string } & WhitelistCheck<EthNftInfo> & GetFeeMargins & IsContractAddress & GetTokenURI & ParamsGetter<Web3Params> & UserStore & LockNFT<Signer, EthNftInfo, TransactionResponse> & ClaimV3NFT<Signer, TransactionResponse> & GetClaimData & GetTokenInfo & GetNftOriginWhitelistCheck
WhitelistCheck<RawNft, Singer>: { isNftWhitelisted: any }
Type Parameters
Type declaration
isNftWhitelisted:function
- isNftWhitelisted(nft: NftInfo<RawNft>, signer?: Singer): boolean | Promise<boolean>
Parameters
Returns boolean | Promise<boolean>
Base util traits