Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetahubAdapter

Hierarchy

  • Adapter
    • MetahubAdapter

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly addressTranslator

addressTranslator: AddressTranslator

Protected Readonly contractResolver

contractResolver: ContractResolver

Methods

Protected accountIdToAddress

  • accountIdToAddress(accountId: AccountId): string

  • Parameters

    • accountId: AccountId

    Returns string

Protected addressToAccountId

  • addressToAccountId(address: string): AccountId

  • Parameters

    • address: string

    Returns AccountId

Protected addressToAssetType

  • addressToAssetType(address: string, namespace: string): AssetType

  • Parameters

    • address: string
    • namespace: string

    Returns AssetType

approveAllForListing

  • approveAllForListing(asset: Asset): Promise<ContractTransaction>

  • Approves Metahub to take any assets (from given collection) from lister account during listing process.

    Parameters

    • asset: Asset

      Some asset from requested for approval collection.

    Returns Promise<ContractTransaction>

approveForListing

  • approveForListing(asset: Asset): Promise<ContractTransaction>

  • Approves Metahub to take an asset from lister account during listing process.

    Parameters

    Returns Promise<ContractTransaction>

approveForRentalPayment

  • approveForRentalPayment(paymentToken: AssetType, amount: BigNumberish): Promise<ContractTransaction>

  • Sets payment token allowance. Allows Metahub to spend specified tokens to cover rental fees.

    Parameters

    • paymentToken: AssetType

      ERC20 payment token.

    • amount: BigNumberish

      Allowance amount.

    Returns Promise<ContractTransaction>

Protected assetIdToAddress

  • assetIdToAddress(assetId: AssetId): string

  • Parameters

    • assetId: AssetId

    Returns string

Protected assetTypeToAddress

  • assetTypeToAddress(assetType: AssetType): string

  • Parameters

    • assetType: AssetType

    Returns string

balance

  • balance(account: AccountId, token: AssetType): Promise<BigNumber>

  • Returns the amount of token, currently accumulated by the user.

    Parameters

    • account: AccountId

      The account to query the balance for.

    • token: AssetType

      The token in which the balance is nominated.

    Returns Promise<BigNumber>

balances

  • Returns the list of user balances in various tokens.

    Parameters

    • account: AccountId

      The account to query the balance for.

    Returns Promise<AccountBalance[]>

baseToken

Protected decodeAgreementTerms

  • decodeAgreementTerms(params: AgreementTermsStruct): AgreementTerms

  • Parameters

    • params: AgreementTermsStruct

    Returns AgreementTerms

Protected decodeAsset

  • decodeAsset(asset: AssetStructOutput): Asset

  • Parameters

    • asset: AssetStructOutput

    Returns Asset

Protected decodeAssetClass

Protected encodeAsset

  • encodeAsset(asset: Asset): AssetStruct

  • Parameters

    Returns AssetStruct

Protected encodeAssetClass

Protected erc20AssetMetadata

  • erc20AssetMetadata(assetType: AssetType): Promise<{ decimals: number; name: string; symbol: string }>

  • Parameters

    • assetType: AssetType

    Returns Promise<{ decimals: number; name: string; symbol: string }>

getChainId

  • getChainId(): Promise<ChainId>

  • Returns Promise<ChainId>

isApprovedForListing

  • isApprovedForListing(asset: Asset): Promise<boolean>

  • Checks whether the asset is approved for listing by the owner. Returns true if the asset can be listed, and false if the required approval is missing.

    Parameters

    Returns Promise<boolean>

Protected optionalAccountIdToAddress

  • optionalAccountIdToAddress(accountId?: AccountId): undefined | string

  • Parameters

    • Optional accountId: AccountId

    Returns undefined | string

paymentTokenAllowance

  • paymentTokenAllowance(paymentToken: AssetType, payer: AccountId): Promise<BigNumber>

  • Returns current Metahub allowance in specified payment tokens for specific payer account.

    Parameters

    • paymentToken: AssetType

      ERC20 payment token.

    • payer: AccountId

      Payer account ID.

    Returns Promise<BigNumber>

Protected signerData

supportedAssetCount

  • supportedAssetCount(): Promise<BigNumber>

  • Returns the number of currently supported assets.

    Returns Promise<BigNumber>

    Asset count.

supportedAssets

  • supportedAssets(offset: BigNumberish, limit: BigNumberish): Promise<AssetType[]>

  • Returns the list of all supported assets.

    Parameters

    • offset: BigNumberish

      Starting index.

    • limit: BigNumberish

      Max number of items.

    Returns Promise<AssetType[]>

universeBalance

  • universeBalance(universeId: BigNumberish, token: AssetType): Promise<BigNumber>

  • Returns the amount of token, currently accumulated by the universe.

    Parameters

    • universeId: BigNumberish

      The universe ID.

    • token: AssetType

      The token address.

    Returns Promise<BigNumber>

universeBalances

warperPresetFactory

  • warperPresetFactory(): Promise<AccountId>

withdrawFunds

  • withdrawFunds(token: AssetType, amount: BigNumberish, to: AccountId): Promise<ContractTransaction>

  • Transfers the specific amount of token from a user balance to an arbitrary address.

    Parameters

    • token: AssetType

      The balance token.

    • amount: BigNumberish

      The amount to be withdrawn.

    • to: AccountId

      The payee account.

    Returns Promise<ContractTransaction>

withdrawUniverseFunds

  • withdrawUniverseFunds(universeId: BigNumberish, token: AssetType, amount: BigNumberish, to: AccountId): Promise<ContractTransaction>

  • Transfers the specific amount of token from a universe balance to an arbitrary address.

    Parameters

    • universeId: BigNumberish

      The universe ID.

    • token: AssetType

      The balance token.

    • amount: BigNumberish

      The amount to be withdrawn.

    • to: AccountId

      The payee account.

    Returns Promise<ContractTransaction>

Generated using TypeDoc