Class TaxTermsRegistryAdapter

Hierarchy

Adapter
- TaxTermsRegistryAdapter

Constructors

constructor

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

Overrides Adapter.constructor
- Defined in adapters/tax-terms-registry.ts:12
Parameters
- accountId: AccountId
- contractResolver: ContractResolver
- addressTranslator: AddressTranslator
Returns TaxTermsRegistryAdapter

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

areRegisteredProtocolGlobalTaxTerms

areRegisteredProtocolGlobalTaxTerms(taxStrategyId: BytesLike): Promise<boolean>

- Defined in adapters/tax-terms-registry.ts:176
Checks registration of protocol global tax terms.

Parameters
- taxStrategyId: BytesLike
  
  Tax strategy ID.
Returns Promise<boolean>

areRegisteredProtocolUniverseTaxTerms

areRegisteredProtocolUniverseTaxTerms(universeId: BigNumberish, taxStrategyId: BytesLike): Promise<boolean>

- Defined in adapters/tax-terms-registry.ts:185
Checks registration of protocol universe tax terms.

Parameters
- universeId: BigNumberish
  
  Universe ID.
- taxStrategyId: BytesLike
  
  Tax strategy ID.
Returns Promise<boolean>

areRegisteredProtocolWarperTaxTerms

areRegisteredProtocolWarperTaxTerms(warper: AssetType, taxStrategyId: BytesLike): Promise<boolean>

- Defined in adapters/tax-terms-registry.ts:194
Checks registration of global protocol warper tax terms.

Parameters
- warper: AssetType
  
  Warper reference.
- taxStrategyId: BytesLike
  
  Tax strategy ID.
Returns Promise<boolean>

areRegisteredUniverseLocalTaxTerms

areRegisteredUniverseLocalTaxTerms(universeId: BigNumberish, taxStrategyId: BytesLike): Promise<boolean>

- Defined in adapters/tax-terms-registry.ts:168
Checks registration of universe local tax terms.

Parameters
- universeId: BigNumberish
  
  Universe ID.
- taxStrategyId: BytesLike
  
  Tax strategy ID.
Returns Promise<boolean>

areRegisteredUniverseWarperTaxTerms

areRegisteredUniverseWarperTaxTerms(universeId: BigNumberish, warper: AssetType, taxStrategyId: BytesLike): Promise<boolean>

- Defined in adapters/tax-terms-registry.ts:151
Checks registration of universe warper tax terms.

Parameters
- universeId: BigNumberish
  
  Universe ID.
- warper: AssetType
  
  Warper reference.
- taxStrategyId: BytesLike
  
  Tax strategy ID.
Returns Promise<boolean>

Protected assetIdToAddress

assetIdToAddress(assetId: AssetId): string

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

Protected assetTypeToAddress

assetTypeToAddress(assetType: AssetType): string

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

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 }>

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

protocolTaxTerms

protocolTaxTerms(queryParams: TaxTermsQueryParams): Promise<TaxTermsStructOutput>

- Defined in adapters/tax-terms-registry.ts:30
Returns protocol's tax terms.

Parameters
- queryParams: TaxTermsQueryParams
  
  Query parameters.
Returns Promise<TaxTermsStructOutput>

registerProtocolGlobalTaxTerms

registerProtocolGlobalTaxTerms(taxTerms: TaxTermsStruct): Promise<ContractTransaction>

- Defined in adapters/tax-terms-registry.ts:88
Registers protocol global tax terms.

Parameters
- taxTerms: TaxTermsStruct
  
  Tax terms.
Returns Promise<ContractTransaction>

registerProtocolUniverseTaxTerms

registerProtocolUniverseTaxTerms(universeId: BigNumberish, taxTerms: TaxTermsStruct): Promise<ContractTransaction>

- Defined in adapters/tax-terms-registry.ts:105
Registers protocol universe tax terms.

Parameters
- universeId: BigNumberish
  
  Universe ID.
- taxTerms: TaxTermsStruct
  
  Tax terms.
Returns Promise<ContractTransaction>

registerProtocolWarperTaxTerms

registerProtocolWarperTaxTerms(warper: AssetType, taxTerms: TaxTermsStruct): Promise<ContractTransaction>

- Defined in adapters/tax-terms-registry.ts:129
Registers protocol warper tax terms.

Parameters
- warper: AssetType
  
  Warper reference.
- taxTerms: TaxTermsStruct
  
  Tax terms.
Returns Promise<ContractTransaction>

registerUniverseLocalTaxTerms

registerUniverseLocalTaxTerms(universeId: BigNumberish, taxTerms: TaxTermsStruct): Promise<ContractTransaction>

- Defined in adapters/tax-terms-registry.ts:40
Registers universe local tax terms.

Parameters
- universeId: BigNumberish
  
  Universe ID.
- taxTerms: TaxTermsStruct
  
  Tax terms.
Returns Promise<ContractTransaction>

registerUniverseWarperTaxTerms

registerUniverseWarperTaxTerms(universeId: BigNumberish, warper: AssetType, taxTerms: TaxTermsStruct): Promise<ContractTransaction>

- Defined in adapters/tax-terms-registry.ts:62
Registers universe warper tax terms.

Parameters
- universeId: BigNumberish
  
  Universe ID.
- warper: AssetType
  
  Warper reference.
- taxTerms: TaxTermsStruct
  
  Tax terms.
Returns Promise<ContractTransaction>

removeProtocolGlobalTaxTerms

removeProtocolGlobalTaxTerms(taxStrategyId: BytesLike): Promise<ContractTransaction>

- Defined in adapters/tax-terms-registry.ts:96
Removes protocol global tax terms.

Parameters
- taxStrategyId: BytesLike
  
  Tax strategy ID.
Returns Promise<ContractTransaction>

removeProtocolUniverseTaxTerms

removeProtocolUniverseTaxTerms(universeId: BigNumberish, taxStrategyId: BytesLike): Promise<ContractTransaction>

- Defined in adapters/tax-terms-registry.ts:117
Removes protocol universe tax terms.

Parameters
- universeId: BigNumberish
  
  Universe ID.
- taxStrategyId: BytesLike
  
  Tax strategy ID.
Returns Promise<ContractTransaction>

removeProtocolWarperTaxTerms

removeProtocolWarperTaxTerms(warper: AssetType, taxStrategyId: BytesLike): Promise<ContractTransaction>

- Defined in adapters/tax-terms-registry.ts:141
Removes protocol warper tax terms.

Parameters
- warper: AssetType
  
  Warper reference.
- taxStrategyId: BytesLike
  
  Tax strategy ID.
Returns Promise<ContractTransaction>

removeUniverseLocalTaxTerms

removeUniverseLocalTaxTerms(universeId: BigNumberish, taxStrategyId: BytesLike): Promise<ContractTransaction>

- Defined in adapters/tax-terms-registry.ts:52
Removes universe local tax terms.

Parameters
- universeId: BigNumberish
  
  Universe ID.
- taxStrategyId: BytesLike
  
  Tax strategy ID.
Returns Promise<ContractTransaction>

removeUniverseWarperTaxTerms

removeUniverseWarperTaxTerms(universeId: BigNumberish, warper: AssetType, taxStrategyId: BytesLike): Promise<ContractTransaction>

- Defined in adapters/tax-terms-registry.ts:76
Removes universe warper tax terms.

Parameters
- universeId: BigNumberish
  
  Universe ID.
- warper: AssetType
  
  Warper reference.
- taxStrategyId: BytesLike
  
  Tax strategy ID.
Returns Promise<ContractTransaction>

Protected signerData

signerData(): Promise<SignerData>

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

universeTaxTerms

universeTaxTerms(queryParams: TaxTermsQueryParams): Promise<TaxTermsStructOutput>

- Defined in adapters/tax-terms-registry.ts:21
Returns universe's tax terms.

Parameters
- queryParams: TaxTermsQueryParams
  
  Query parameters.
Returns Promise<TaxTermsStructOutput>

Generated using TypeDoc