0.0.35 • Published 1 year ago

wallets-wrapper v0.0.35

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

README

How to install

yarn add wallets-wrappers
npm i wallets-wrappers

Example flow

const metamask = new WalletsWrapper({
  type: WalletsNames.Metamask,
  infuraApiKey: process.env.REACT_APP_INFURA_API_KEY || '',
})

metamask
  .init({
    appUrl: 'example.com',
    email: 'example@gmail.com',
  })
  .then(() => {
    metamask.address$.subscribe(setAddress)
    metamask.errors$.subscribe(setError)
    metamask.isConnected$.subscribe(setIsConnected)
    metamask.chainId$.subscribe(setChain)

    metamask.getAddress().then(setAddress)

    metamask.getStandardContract(coinAddresses[CoinNames.USDT]).then(async (contract) => {
      await contract.init()
      const usdtBalance = await contract.getBalance()
    })

    metamask.getStandardContract(ERC20address).then(async (contract) => {
      await contract.init()
      const balance = await contract.getBalance()
      setBalanceERC20(balance)
      setERC20Contract(contract)
    })
    metamask.getStandardContract(ERC721address).then(async (contract) => {
      await contract.init()
      const balance = await contract.getBalance()
      setBalanceERC721(balance)
      setERC721Contract(contract)
    })
    metamask.getStandardContract(ERC1155address).then(async (contract) => {
      await contract.init()
      const balance = await contract.getBalance({ ids: [0, 1] })
      setBalanceERC1155(balance)
      contract
      setERC1155Contract(contract)
    })
  })
  .catch()

const handleClickGetmetamaskwallet = async () => {
  await metamask.connectWallet()
}

const handleClickSwitchmetamasknetwork = async () => {
  await metamask.switchNetwork(ChainIds.GoerliTestNetwork)
}

const handleClickPersonalSign = async () => {
  await metamask.sign({ message: 'Hello signer!', type: 'personal_sign' })
}

const handleClickSendETH = async () => {
  await metamask.transfer({
    addressTo,
    value,
  })
}

const handleClickGetContract = async () => {
  const contract = await metamask.getStandardContract(ERC20ContractAddress?.value || '')
  await contract.init()
}

const handleClickTransferERC20 = async () => {
  await ERC20Contract?.transfer({
    addressTo: addressToERC20?.value || '',
    values: [Number(valueERC20?.value || '')],
  })
}

const handleClickTransferERC721 = async () => {
  await ERC721Contract?.transfer({
    addressTo: addressToERC721?.value || '',
    tokenIds: [Number(tokenIdERC721?.value || '')],
  })
}

const handleClickTransferERC1155 = async () => {
  await ERC1155Contract?.transfer({
    addressTo: addressToERC1155?.value || '',
    tokenIds: [Number(tokenIdERC1155?.value || '')],
    values: [1],
  })
}

const handleClickWatchAsset = async () => {
  await metamask.addToken(CoinNames.USDT)
}

Classes

ERC1155

Kind: global class
Implements: IStandardContract

erC1155.init()

Kind: instance method of ERC1155

erC1155.getBalance(object,) ⇒ Promise.<number>

Kind: instance method of ERC1155

ParamType
object,GetContractBalance

erC1155.transfer(args) ⇒ Promise.<Transaction>

Kind: instance method of ERC1155

ParamType
argsTransferContractToken

erC1155.getDecodedTransfer(args) ⇒ string

Kind: instance method of ERC1155

ParamType
argsTransferContractToken

erC1155.getTokenUri(tokenId) ⇒ Promise.<string>

Kind: instance method of ERC1155

ParamType
tokenIdstring

erC1155.transferEvents()

Kind: instance method of ERC1155

ERC20

Kind: global class
Implements: IStandardContract

erC20.init()

Kind: instance method of ERC20

erC20.getBalance(object,) ⇒ Promise.<number>

Kind: instance method of ERC20

ParamType
object,GetContractBalance

erC20.transfer(args) ⇒ Promise.<Transaction>

Kind: instance method of ERC20

ParamType
argsTransferContractToken

erC20.getDecodedTransfer(args) ⇒ string

Kind: instance method of ERC20

ParamType
argsTransferContractToken

erC20.transferEvents()

Kind: instance method of ERC20

ERC721

Kind: global class
Implements: IStandardContract

erC721.init()

Kind: instance method of ERC721

erC721.getBalance(address,, object,) ⇒ Promise.<number>

Kind: instance method of ERC721

ParamTypeDescription
address,stringyou can specify explicitly to check a different address
object,GetContractBalance

erC721.transfer(args) ⇒ Promise.<Transaction>

Kind: instance method of ERC721

ParamType
argsTransferContractToken

erC721.getDecodedTransfer(args) ⇒ string

Kind: instance method of ERC721

ParamType
argsTransferContractToken

erC721.getTokenUri(tokenId) ⇒ Promise.<string>

Kind: instance method of ERC721

ParamType
tokenIdstring

erC721.transferEvents()

Kind: instance method of ERC721

StandardContract

Kind: global class
Implements: IStandardContract

standardContract.init()

Kind: instance method of StandardContract

standardContract.getBalance(object,) ⇒ Promise.<number>

Kind: instance method of StandardContract

ParamType
object,GetContractBalance

standardContract.transfer(args) ⇒ Promise.<Transaction>

Kind: instance method of StandardContract

ParamType
argsTransferContractToken

standardContract.getTokenUri(tokenId) ⇒ Promise.<string>

Kind: instance method of StandardContract

ParamType
tokenIdstring

standardContract.approve(object) ⇒ Promise.<ethers.providers.TransactionResponse>

Kind: instance method of StandardContract

ParamType
objectApproveToken

standardContract.setApprovalForAll(object) ⇒ Promise.<ethers.providers.TransactionResponse>

Kind: instance method of StandardContract

ParamType
objectSetApprovalForAll

standardContract.transferEvents()

Kind: instance method of StandardContract

AnchorWrapper

Kind: global class
Implements: IAnchorWrapper

anchorWrapper.init() ⇒ LinkSession | null

Kind: instance method of AnchorWrapper

anchorWrapper.getBalance(coins) ⇒ Promise.<Array.<number>>

Kind: instance method of AnchorWrapper
Returns: Promise.<Array.<number>> -

ParamTypeDescription
coinsGetEosAccountInfoProps

anchorWrapper.getContractData(coins) ⇒ Promise.<Array.<number>>

Kind: instance method of AnchorWrapper
Returns: Promise.<Array.<number>> -

ParamTypeDescription
coinsGetEosAccountInfoProps

anchorWrapper.getAccountInfo(args) ⇒ Promise.<Array.<number>>

Kind: instance method of AnchorWrapper

ParamTypeDescription
argsGetEosAccountInfoProps

anchorWrapper.connectWallet() ⇒ Promise.<Array.<string>>

Kind: instance method of AnchorWrapper
Returns: Promise.<Array.<string>> -

anchorWrapper.sendSignedTransaction(object) ⇒ Promise.<(TransactResult|undefined)>

Kind: instance method of AnchorWrapper

ParamType
objectSendEosSignedTransaction

anchorWrapper.sendTransaction(tx) ⇒ Promise.<SendTransactionResponse>

Kind: instance method of AnchorWrapper

ParamType
txSendEosTransaction

anchorWrapper.transfer(args) ⇒ TransactResult | undefined

Kind: instance method of AnchorWrapper

ParamType
argsEosTransferProps

MetamaskWrapper

Kind: global class
Implements: IMetamaskWrapper

new MetamaskWrapper()

metamaskWrapper.generateWallet() ⇒ object

Kind: instance method of MetamaskWrapper
Returns: object -

metamaskWrapper.connectWallet() ⇒ Promise.<Array.<string>>

Kind: instance method of MetamaskWrapper
Returns: Promise.<Array.<string>> -

metamaskWrapper.getAddress() ⇒ Promise.<Array.<string>>

Kind: instance method of MetamaskWrapper
Returns: Promise.<Array.<string>> -

metamaskWrapper.getBalance(getBalanceProps, network, address) ⇒ Promise.<Array.<number>>

Kind: instance method of MetamaskWrapper
Returns: Promise.<Array.<number>> -

ParamTypeDescription
getBalancePropsGetBalancePropscustom props if balance in custom network and address needed
networkChainIds
addressstring

metamaskWrapper.getAccountInfo(accounts) ⇒ Promise.<Array.<AccountInfo>>

Kind: instance method of MetamaskWrapper
Returns: Promise.<Array.<AccountInfo>> -

ParamTypeDescription
accountsArray.<GetBalanceProps>

metamaskWrapper.getChain() ⇒ Promise.<(ChainInfo|null)>

Kind: instance method of MetamaskWrapper
Returns: Promise.<(ChainInfo|null)> -

metamaskWrapper.switchNetwork(chainId) ⇒ Promise.<void>

Kind: instance method of MetamaskWrapper

ParamTypeDescription
chainIdChainIdsid of Chain

metamaskWrapper.switchCustomNetwork(network) ⇒ Promise.<void>

Kind: instance method of MetamaskWrapper

ParamTypeDescription
networkAddEthereumChainParameterObject of chain network

metamaskWrapper.addToken(token) ⇒ Promise.<boolean>

Kind: instance method of MetamaskWrapper

ParamTypeDescription
tokenCoinsTypesCoinsTypes, like USDT

metamaskWrapper.addCustomToken(newAsset) ⇒ Promise.<boolean>

Kind: instance method of MetamaskWrapper

ParamTypeDescription
newAssetWatchAssetParamsAsset object

metamaskWrapper.sign(object) ⇒ Promise.<void>

Kind: instance method of MetamaskWrapper

ParamTypeDescription
objectSignPropsSign Object with type and message

metamaskWrapper.transfer(args) ⇒ Promise.<(ethers.providers.TransactionResponse|null)>

Kind: instance method of MetamaskWrapper

ParamType
argsTransferToken

metamaskWrapper.sendSignedTransaction(tx) ⇒ Promise.<ethers.providers.TransactionResponse>

Kind: instance method of MetamaskWrapper

ParamTypeDescription
txethers.utils.Deferrable.<ethers.providers.TransactionRequest>Transaction Request

metamaskWrapper.sendTransaction(tx) ⇒ Promise.<ethers.providers.TransactionResponse>

Kind: instance method of MetamaskWrapper

ParamTypeDescription
txethers.utils.Deferrable.<ethers.providers.TransactionRequest>Transaction Request

metamaskWrapper.getMobileLink() ⇒ string

Kind: instance method of MetamaskWrapper

TrezorWrapper

Kind: global class
Implements: ITrezorWrapper

trezorWrapper.init(object) ⇒ Promise.<void>

Kind: instance method of TrezorWrapper

ParamType
objectManifest

trezorWrapper.getBalance(coins) ⇒ Promise.<Array.<number>>

Kind: instance method of TrezorWrapper
Returns: Promise.<Array.<number>> -

ParamTypeDescription
coinsArray.<AllCoins>

trezorWrapper.getAccountInfo(args) ⇒ Promise.<Array.<number>>

Kind: instance method of TrezorWrapper

ParamTypeDescription
argsArray.<GetAccountInfo>

trezorWrapper.connectWallet(params) ⇒ Promise.<Array.<string>>

Kind: instance method of TrezorWrapper
Returns: Promise.<Array.<string>> -

ParamType
paramsParams.<(RequestLoginAsync|LoginChallenge)>

trezorWrapper.sendSignedTransaction(object) ⇒ Promise.<(SignedTransaction|PushedTransaction|CardanoSignedTxData|EosSignedTx)>

Kind: instance method of TrezorWrapper

ParamType
objectSendSignedTransactionProps

trezorWrapper.sendTransaction(object) ⇒ Promise.<PushedTransaction>

Kind: instance method of TrezorWrapper

ParamType
objectSendTransactionProps

trezorWrapper.transfer(args) ⇒ Promise.<(SignedTransaction|CardanoSignedTxData|EosSignedTx|PushedTransaction)>

Kind: instance method of TrezorWrapper

ParamType
argsTransferProps

WalletsWrapper

Kind: global class
Implements: WalletWrapper

new WalletsWrapper(object, type, infuraApiKey)

ParamTypeDescription
objectWalletsWrapperProps
typeWalletsNamestype of wallet, default is MetamaskWrapper
infuraApiKeyWalletsWrapperPropsthe parameter is needed to connect to the blockchain

walletsWrapper.init(object) ⇒ Promise.<void>

Kind: instance method of WalletsWrapper

ParamType
objectManifest

walletsWrapper.isInstalled() ⇒ Promise.<boolean>

Kind: instance method of WalletsWrapper

walletsWrapper.connectWallet(params) ⇒ Promise.<Array.<string>>

Kind: instance method of WalletsWrapper
Returns: Promise.<Array.<string>> -

ParamTypeDescription
paramsParams.<(RequestLoginAsync|LoginChallenge)>params for trezor

walletsWrapper.getChain(object) ⇒ Promise.<Array.<string>>

Kind: instance method of WalletsWrapper
Returns: Promise.<Array.<string>> -

ParamType
objectGetAddressProps

walletsWrapper.getStandardContract(address, network) ⇒ Promise.<StandardContract>

Kind: instance method of WalletsWrapper

ParamTypeDescription
addressstringContract address
networkChainIdsnetwork in which to search for a contract

ErrorTypes : enum

Kind: global enum
Read only: true

generateCoin : enum

Kind: global enum
Read only: true

networks : enum

Kind: global enum
Read only: true
Properties

NameTypeDefault
"_models.ChainIds.EthereumMainNetwork"string"{\"chainId\":\"\",\"chainName\":\"\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\"}"
"_models.ChainIds.RopstenTestNetwork"string"{\"chainId\":\"\",\"chainName\":\"\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\"}"
"_models.ChainIds.RinkebyTestNetwork"string"{\"chainId\":\"\",\"chainName\":\"Rinkeby Test Network\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\"}"
"_models.ChainIds.GoerliTestNetwork"string"{\"chainId\":\"\",\"chainName\":\"\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\"}"
"_models.ChainIds.KovanTestNetwork"string"{\"chainId\":\"\",\"chainName\":\"Kovan Test Network\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\"}"
"_models.ChainIds.PolygonMainnet"string"{\"chainId\":\"\",\"chainName\":\"Polygon Mainnet\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\"}"
"_models.ChainIds.HardhatLocalhost"string"{\"chainId\":\"\",\"chainName\":\"Hardhat Localhost\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\"}"
"_models.ChainIds.GanacheLocalhost"string"{\"chainId\":\"\",\"chainName\":\"Ganache Localhost\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\"}"
"_models.ChainIds.BinanceSmartChain"string"{\"chainId\":\"\",\"chainName\":\"\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\",\"blockExplorerUrls\":\"\"}"
"_models.ChainIds.BinanceSmartTestnet"string"{\"chainId\":\"\",\"chainName\":\"\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\",\"blockExplorerUrls\":\"\"}"
"_models.ChainIds.Palm"string"{\"chainId\":\"\",\"chainName\":\"\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\",\"blockExplorerUrls\":\"\"}"
"_models.ChainIds.PalmTestnet"string"{\"chainId\":\"\",\"chainName\":\"\",\"nativeCurrency\":\"\",\"rpcUrls\":\"\",\"blockExplorerUrls\":\"\"}"
0.0.20

1 year ago

0.0.21

1 year ago

0.0.22

1 year ago

0.0.23

1 year ago

0.0.24

1 year ago

0.0.25

1 year ago

0.0.17

1 year ago

0.0.18

1 year ago

0.0.19

1 year ago

0.0.30

1 year ago

0.0.31

1 year ago

0.0.32

1 year ago

0.0.33

1 year ago

0.0.34

1 year ago

0.0.35

1 year ago

0.0.26

1 year ago

0.0.27

1 year ago

0.0.28

1 year ago

0.0.29

1 year ago

0.0.16

1 year ago

0.0.15

1 year ago

0.0.14

1 year ago

0.0.13

1 year ago

0.0.12

1 year ago

0.0.11

1 year ago

0.0.10

1 year ago

0.0.9

1 year ago

0.0.8

1 year ago

0.0.7

1 year ago

0.0.6

1 year ago

0.0.5

1 year ago

0.0.4

1 year ago

0.0.3

1 year ago

0.0.2

1 year ago

0.0.1

1 year ago