Class RentingManagerAdapter

Hierarchy

Adapter
- RentingManagerAdapter

Constructors

constructor

new RentingManagerAdapter(accountId: AccountId, contractResolver: ContractResolver, addressTranslator: AddressTranslator): RentingManagerAdapter

Overrides Adapter.constructor
- Defined in adapters/renting-manager.ts:16
Parameters
- accountId: AccountId
- contractResolver: ContractResolver
- addressTranslator: AddressTranslator
Returns RentingManagerAdapter

Properties

Protected Readonly addressTranslator

addressTranslator: AddressTranslator

Protected Readonly contractResolver

contractResolver: ContractResolver

Methods

Protected accountIdToAddress

accountIdToAddress(accountId: AccountId): string

Inherited from Adapter.accountIdToAddress
- Defined in adapter.ts:26
Parameters
- accountId: AccountId
Returns string

Protected addressToAccountId

addressToAccountId(address: string): AccountId

Inherited from Adapter.addressToAccountId
- Defined in adapter.ts:18
Parameters
- address: string
Returns AccountId

Protected addressToAssetType

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

Inherited from Adapter.addressToAssetType
- Defined in adapter.ts:22
Parameters
- address: string
- namespace: string
Returns AssetType

Protected assetIdToAddress

assetIdToAddress(assetId: AssetId): string

Inherited from Adapter.assetIdToAddress
- Defined in adapter.ts:38
Parameters
- assetId: AssetId
Returns string

assetRentalStatus

assetRentalStatus(asset: Asset): Promise<RentalStatus>

- Defined in adapters/renting-manager.ts:88
Returns the rental status of a given warped asset.

Parameters
- asset: Asset
  
  Asset reference.
Returns Promise<RentalStatus>

Protected assetTypeToAddress

assetTypeToAddress(assetType: AssetType): string

Inherited from Adapter.assetTypeToAddress
- Defined in adapter.ts:34
Parameters
- assetType: AssetType
Returns string

collectionRentedValue

collectionRentedValue(warpedCollectionId: BytesLike, renter: AccountId): Promise<BigNumber>

- Defined in adapters/renting-manager.ts:80
Returns token amount from specific collection rented by particular account.

Parameters
- warpedCollectionId: BytesLike
  
  Warped collection ID.
- renter: AccountId
  
  Renter account ID.
Returns Promise<BigNumber>

Protected decodeAgreementTerms

decodeAgreementTerms(params: AgreementTermsStruct): AgreementTerms

Inherited from Adapter.decodeAgreementTerms
- Defined in adapter.ts:59
Parameters
- params: AgreementTermsStruct
Returns AgreementTerms

Protected decodeAsset

decodeAsset(asset: AssetStructOutput): Asset

Inherited from Adapter.decodeAsset
- Defined in adapter.ts:47
Parameters
- asset: AssetStructOutput
Returns Asset

Protected decodeAssetClass

decodeAssetClass(assetClass: string): AssetNamespace

Inherited from Adapter.decodeAssetClass
- Defined in adapter.ts:55
Parameters
- assetClass: string
Returns AssetNamespace

Protected encodeAsset

encodeAsset(asset: Asset): AssetStruct

Inherited from Adapter.encodeAsset
- Defined in adapter.ts:42
Parameters
- asset: Asset
Returns AssetStruct

Protected encodeAssetClass

encodeAssetClass(namespace: AssetNamespace): string

Inherited from Adapter.encodeAssetClass
- Defined in adapter.ts:51
Parameters
- namespace: AssetNamespace
Returns string

Protected erc20AssetMetadata

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

Inherited from Adapter.erc20AssetMetadata
- Defined in adapter.ts:63
Parameters
- assetType: AssetType
Returns Promise<{ decimals: number; name: string; symbol: string }>

estimateRent

estimateRent(params: RentingEstimationParams): Promise<RentalFees>

- Defined in adapters/renting-manager.ts:25
Evaluates renting params and returns rental fee breakdown.

Parameters
- params: RentingEstimationParams
Returns Promise<RentalFees>

getChainId

getChainId(): Promise<ChainId>

Inherited from Adapter.getChainId
- Defined in adapter.ts:14
Returns Promise<ChainId>

Protected optionalAccountIdToAddress

optionalAccountIdToAddress(accountId?: AccountId): undefined | string

Inherited from Adapter.optionalAccountIdToAddress
- Defined in adapter.ts:30
Parameters
- Optional accountId: AccountId
Returns undefined | string

rent

rent(params: RentingParams): Promise<ContractTransaction>

- Defined in adapters/renting-manager.ts:34
Performs renting operation.

Parameters
- params: RentingParams
  
  Renting parameters.
Returns Promise<ContractTransaction>

rentalAgreement

rentalAgreement(rentalId: BigNumberish): Promise<RentalAgreement>

- Defined in adapters/renting-manager.ts:45
Returns the rental agreement details.

Parameters
- rentalId: BigNumberish
  
  Rental agreement ID.
Returns Promise<RentalAgreement>
Rental agreement details.

Protected signerData

signerData(): Promise<SignerData>

Inherited from Adapter.signerData
- Defined in adapter.ts:78
Returns Promise<SignerData>

userRentalAgreements

userRentalAgreements(renter: AccountId, offset: BigNumberish, limit: BigNumberish): Promise<RentalAgreement[]>

- Defined in adapters/renting-manager.ts:65
Returns the paginated list of currently registered rental agreements for particular renter account.

Parameters
- renter: AccountId
  
  Renter account ID.
- offset: BigNumberish
  
  Starting index.
- limit: BigNumberish
  
  Max number of items.
Returns Promise<RentalAgreement[]>

userRentalCount

userRentalCount(renter: AccountId): Promise<BigNumber>

- Defined in adapters/renting-manager.ts:55
Returns the number of currently registered rental agreements for particular renter account.

Parameters
- renter: AccountId
  
  Renter account ID.
Returns Promise<BigNumber>
Rental agreement count.

Generated using TypeDoc