> ## Documentation Index
> Fetch the complete documentation index at: https://cantonfoundation-feature-integrate-google-analytics.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Splice.Api.FeaturedAppRightV2

> Documentation for Splice.Api.FeaturedAppRightV2

The API for featured apps to record their activity. This package extends FeaturedAppRightV1 with support for specifying a weight when creating a marker to improve efficiency.

## Interfaces

<div id="type-splice-api-featuredapprightv2-featuredappactivitymarker-59464">
  **interface** FeaturedAppActivityMarker
</div>

> A marker created by a featured application for activity generated from that app. This is used to record activity other than amulet transfers, which have built-in support for recording featured app activity.
>
> **viewtype** FeaturedAppActivityMarkerView
>
> * **Choice** Archive
>
>   Controller: Signatories of implementing template
>
>   Returns: ()
>
>   (no fields)

<div id="type-splice-api-featuredapprightv2-featuredappright-28172">
  **interface** FeaturedAppRight
</div>

> An interface for contracts allowing application providers to record their featured activity. Note that most instances of amulet will likely define some fair usage constraints.
>
> **viewtype** FeaturedAppRightView
>
> * **Choice** Archive
>
>   Controller: Signatories of implementing template
>
>   Returns: ()
>
>   (no fields)
>
> * <div id="type-splice-api-featuredapprightv2-featuredapprightcreateactivitymarker-77229">
>     **Choice** FeaturedAppRight\_CreateActivityMarker
>   </div>
>
>   Record activity due to a featured app.
>
>   Controller: (DA.Internal.Record.getField @"provider" (view this))
>
>   Returns: FeaturedAppRight\_CreateActivityMarkerResult
>
>   | Field         | Type                                                                                                                                                                                      | Description                                                                                                                                                                                                                                                                                      |
>   | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
>   | beneficiaries | \[AppRewardBeneficiary]                                                                                                                                                                   | The set of beneficiaries and weights that define how the rewards should be split up between the beneficiary parties. Implementations SHOULD check that the weights are positive and add up to 1.0. Implementations MAY also impose a limit on the maximum number of beneficiaries.               |
>   | weight        | [Optional](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-prelude-optional-37153) [Decimal](https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135) | A weight for the resulting markers. None defaults to a weight of 1.0. Specifying a weight of 5 for example makes the resulting markers equivalent to 5 markers of weight 1 in terms of rewards they generate. The weight must be >= 1.0 Implementations MAY impose an upper limit on the weight. |
>
> * **Method featuredAppRight\_CreateActivityMarkerImpl :** [ContractId](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282) FeaturedAppRight -> FeaturedAppRight\_CreateActivityMarker -> [Update](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-update-68072) FeaturedAppRight\_CreateActivityMarkerResult

## Data Types

<div id="type-splice-api-featuredapprightv2-apprewardbeneficiary-35536">
  **data** AppRewardBeneficiary
</div>

> Specification of a beneficiary of featured app rewards.
>
> <div id="constr-splice-api-featuredapprightv2-apprewardbeneficiary-41661">
>   AppRewardBeneficiary
> </div>
>
> > | Field       | Type                                                                                    | Description                                                                                  |
> > | ----------- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
> > | beneficiary | [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932) | The party that is granted the right to mint the weighted amount of reward for this activity. |
> > | weight      | [Decimal](https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135)  | A weight between 0.0 and 1.0 that defines how much of the reward this beneficiary can mint.  |
>
> **instance** [Eq](https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-eq-22713) AppRewardBeneficiary
>
> **instance** [Ord](https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-ord-6395) AppRewardBeneficiary
>
> **instance** [Show](https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-show-show-65360) AppRewardBeneficiary
>
> **instance** [GetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979) "beneficiaries" FeaturedAppRight\_CreateActivityMarker \[AppRewardBeneficiary]
>
> **instance** [GetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979) "beneficiary" AppRewardBeneficiary [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [GetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979) "weight" AppRewardBeneficiary [Decimal](https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135)
>
> **instance** [SetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311) "beneficiaries" FeaturedAppRight\_CreateActivityMarker \[AppRewardBeneficiary]
>
> **instance** [SetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311) "beneficiary" AppRewardBeneficiary [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [SetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311) "weight" AppRewardBeneficiary [Decimal](https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135)

<div id="type-splice-api-featuredapprightv2-featuredappactivitymarkerview-70739">
  **data** FeaturedAppActivityMarkerView
</div>

> <div id="constr-splice-api-featuredapprightv2-featuredappactivitymarkerview-19000">
>   FeaturedAppActivityMarkerView
> </div>
>
> > | Field       | Type                                                                                    | Description                                                                                  |
> > | ----------- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
> > | dso         | [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932) | The DSO party.                                                                               |
> > | provider    | [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932) | The featured app provider.                                                                   |
> > | beneficiary | [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932) | The party that is granted the right to mint the weighted amount of reward for this activity. |
> > | weight      | [Decimal](https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135)  | A weight between 0.0 and 1.0 that defines how much of the reward this beneficiary can mint.  |
>
> **instance** [Eq](https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-eq-22713) FeaturedAppActivityMarkerView
>
> **instance** [Show](https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-show-show-65360) FeaturedAppActivityMarkerView
>
> **instance** [HasFromAnyView](https://docs.daml.com/daml/stdlib/DA-Internal-Interface-AnyView.html#class-da-internal-interface-anyview-hasfromanyview-30108) FeaturedAppActivityMarker FeaturedAppActivityMarkerView
>
> **instance** [HasInterfaceView](https://docs.daml.com/daml/stdlib/Prelude.html#class-da-internal-interface-hasinterfaceview-4492) FeaturedAppActivityMarker FeaturedAppActivityMarkerView
>
> **instance** [GetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979) "beneficiary" FeaturedAppActivityMarkerView [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [GetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979) "dso" FeaturedAppActivityMarkerView [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [GetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979) "provider" FeaturedAppActivityMarkerView [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [GetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979) "weight" FeaturedAppActivityMarkerView [Decimal](https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135)
>
> **instance** [SetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311) "beneficiary" FeaturedAppActivityMarkerView [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [SetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311) "dso" FeaturedAppActivityMarkerView [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [SetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311) "provider" FeaturedAppActivityMarkerView [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [SetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311) "weight" FeaturedAppActivityMarkerView [Decimal](https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135)

<div id="type-splice-api-featuredapprightv2-featuredapprightview-58075">
  **data** FeaturedAppRightView
</div>

> <div id="constr-splice-api-featuredapprightv2-featuredapprightview-48166">
>   FeaturedAppRightView
> </div>
>
> > | Field    | Type                                                                                    | Description                |
> > | -------- | --------------------------------------------------------------------------------------- | -------------------------- |
> > | dso      | [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932) | The DSO party.             |
> > | provider | [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932) | The featured app provider. |
>
> **instance** [Eq](https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-classes-eq-22713) FeaturedAppRightView
>
> **instance** [Show](https://docs.daml.com/daml/stdlib/Prelude.html#class-ghc-show-show-65360) FeaturedAppRightView
>
> **instance** [HasFromAnyView](https://docs.daml.com/daml/stdlib/DA-Internal-Interface-AnyView.html#class-da-internal-interface-anyview-hasfromanyview-30108) FeaturedAppRight FeaturedAppRightView
>
> **instance** [HasInterfaceView](https://docs.daml.com/daml/stdlib/Prelude.html#class-da-internal-interface-hasinterfaceview-4492) FeaturedAppRight FeaturedAppRightView
>
> **instance** [GetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979) "dso" FeaturedAppRightView [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [GetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979) "provider" FeaturedAppRightView [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [SetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311) "dso" FeaturedAppRightView [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)
>
> **instance** [SetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311) "provider" FeaturedAppRightView [Party](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932)

<div id="type-splice-api-featuredapprightv2-featuredapprightcreateactivitymarkerresult-27928">
  **data** FeaturedAppRight\_CreateActivityMarkerResult
</div>

> Result of calling the `FeaturedAppRight_CreateActivityMarker` choice.
>
> <div id="constr-splice-api-featuredapprightv2-featuredapprightcreateactivitymarkerresult-95607">
>   FeaturedAppRight\_CreateActivityMarkerResult
> </div>
>
> > | Field              | Type                                                                                                                           | Description                                        |
> > | ------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
> > | activityMarkerCids | \[[ContractId](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282) FeaturedAppActivityMarker] | The set of activity markers created by the choice. |
>
> **instance** HasMethod FeaturedAppRight "featuredAppRight\_CreateActivityMarkerImpl" ([ContractId](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282) FeaturedAppRight -> FeaturedAppRight\_CreateActivityMarker -> [Update](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-update-68072) FeaturedAppRight\_CreateActivityMarkerResult)
>
> **instance** [GetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-getfield-53979) "activityMarkerCids" FeaturedAppRight\_CreateActivityMarkerResult \[[ContractId](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282) FeaturedAppActivityMarker]
>
> **instance** [SetField](https://docs.daml.com/daml/stdlib/DA-Record.html#class-da-internal-record-setfield-4311) "activityMarkerCids" FeaturedAppRight\_CreateActivityMarkerResult \[[ContractId](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282) FeaturedAppActivityMarker]
>
> **instance** [HasExercise](https://docs.daml.com/daml/stdlib/Prelude.html#class-da-internal-template-functions-hasexercise-70422) FeaturedAppRight FeaturedAppRight\_CreateActivityMarker FeaturedAppRight\_CreateActivityMarkerResult
>
> **instance** [HasExerciseGuarded](https://docs.daml.com/daml/stdlib/Prelude.html#class-da-internal-template-functions-hasexerciseguarded-97843) FeaturedAppRight FeaturedAppRight\_CreateActivityMarker FeaturedAppRight\_CreateActivityMarkerResult
>
> **instance** [HasFromAnyChoice](https://docs.daml.com/daml/stdlib/Prelude.html#class-da-internal-template-functions-hasfromanychoice-81184) FeaturedAppRight FeaturedAppRight\_CreateActivityMarker FeaturedAppRight\_CreateActivityMarkerResult
>
> **instance** [HasToAnyChoice](https://docs.daml.com/daml/stdlib/Prelude.html#class-da-internal-template-functions-hastoanychoice-82571) FeaturedAppRight FeaturedAppRight\_CreateActivityMarker FeaturedAppRight\_CreateActivityMarkerResult

## Functions

<div id="function-splice-api-featuredapprightv2-featuredapprightcreateactivitymarkerimpl-7767">
  featuredAppRight\_CreateActivityMarkerImpl
  : FeaturedAppRight -> [ContractId](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282) FeaturedAppRight -> FeaturedAppRight\_CreateActivityMarker -> [Update](https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-update-68072) FeaturedAppRight\_CreateActivityMarkerResult
</div>