> ## Documentation Index
> Fetch the complete documentation index at: https://docs.canton.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Splice.SvOnboarding

> Documentation for Splice.SvOnboarding

## Templates

<div id="type-splice-svonboarding-svonboardingconfirmed-6814">
  **template** SvOnboardingConfirmed
</div>

> A confirmation for approval of a candidate SV.
>
> Once this contract is created, the workflows to onboard that SVs node starts.
>
> Signatory: dso
>
> | Field           | Type                                                                                     | Description                         |
> | --------------- | ---------------------------------------------------------------------------------------- | ----------------------------------- |
> | svParty         | [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) |                                     |
> | svName          | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)        |                                     |
> | svRewardWeight  | [Int](/appdev/reference/daml-standard-library/prelude#type-ghc-types-int-37261)          |                                     |
> | svParticipantId | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)        |                                     |
> | reason          | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)        |                                     |
> | dso             | [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) |                                     |
> | expiresAt       | [Time](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-time-63886)   | When this contract can be archived. |
>
> * **Choice** Archive
>
>   Controller: dso
>
>   Returns: ()
>
>   (no fields)
>
> * <div id="type-splice-svonboarding-svonboardingconfirmedexpire-37945">
>     **Choice** SvOnboardingConfirmed\_Expire
>   </div>
>
>   Controller: dso
>
>   Returns: SvOnboardingConfirmed\_ExpireResult
>
>   (no fields)

<div id="type-splice-svonboarding-svonboardingrequest-71856">
  **template** SvOnboardingRequest
</div>

> Template used by the SVs to collect confirmations for the onboarding of an SV candidate. The existence of this contract triggers SV automation that creates confirmation contracts for the candidate if the token is a valid `SvOnboardingToken` and matches an `ApprovedSvIdentity`.
>
> Signatory: dso
>
> | Field                  | Type                                                                                     | Description                                                                          |
> | ---------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
> | candidateName          | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)        | Human-readable name of the SV candidate. Must match the one in `ApprovedSvIdentity`! |
> | candidateParty         | [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) | PartyId of the candidate SV party.                                                   |
> | candidateParticipantId | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)        | ParticipantId of the candidate SV.                                                   |
> | token                  | [Text](/appdev/reference/daml-standard-library/prelude#type-ghc-types-text-51952)        | An encoded and signed `SvOnboardingToken` that confirms the candidate's identity.    |
> | sponsor                | [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) | The established SV node that created this contract.                                  |
> | dso                    | [Party](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-party-57932) |                                                                                      |
> | expiresAt              | [Time](/appdev/reference/daml-standard-library/prelude#type-da-internal-lf-time-63886)   | When this contract can be archived even if the onboarding did not succeed.           |
>
> * **Choice** Archive
>
>   Controller: dso
>
>   Returns: ()
>
>   (no fields)
>
> * <div id="type-splice-svonboarding-svonboardingrequestexpire-23755">
>     **Choice** SvOnboardingRequest\_Expire
>   </div>
>
>   Controller: dso
>
>   Returns: SvOnboardingRequest\_ExpireResult
>
>   (no fields)

## Data Types

<div id="type-splice-svonboarding-svonboardingconfirmedexpireresult-89548">
  **data** SvOnboardingConfirmed\_ExpireResult
</div>

> <div id="constr-splice-svonboarding-svonboardingconfirmedexpireresult-55325">
>   SvOnboardingConfirmed\_ExpireResult
> </div>
>
> **instance** [HasExercise](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasexercise-70422) SvOnboardingConfirmed SvOnboardingConfirmed\_Expire SvOnboardingConfirmed\_ExpireResult
>
> **instance** [HasFromAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasfromanychoice-81184) SvOnboardingConfirmed SvOnboardingConfirmed\_Expire SvOnboardingConfirmed\_ExpireResult
>
> **instance** [HasToAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hastoanychoice-82571) SvOnboardingConfirmed SvOnboardingConfirmed\_Expire SvOnboardingConfirmed\_ExpireResult

<div id="type-splice-svonboarding-svonboardingrequestexpireresult-6542">
  **data** SvOnboardingRequest\_ExpireResult
</div>

> <div id="constr-splice-svonboarding-svonboardingrequestexpireresult-87875">
>   SvOnboardingRequest\_ExpireResult
> </div>
>
> **instance** [HasExercise](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasexercise-70422) SvOnboardingRequest SvOnboardingRequest\_Expire SvOnboardingRequest\_ExpireResult
>
> **instance** [HasFromAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hasfromanychoice-81184) SvOnboardingRequest SvOnboardingRequest\_Expire SvOnboardingRequest\_ExpireResult
>
> **instance** [HasToAnyChoice](/appdev/reference/daml-standard-library/prelude#class-da-internal-template-functions-hastoanychoice-82571) SvOnboardingRequest SvOnboardingRequest\_Expire SvOnboardingRequest\_ExpireResult