Utility.Collateral.App.Service.User

Templates

template UserService

User service for the Collateral App.

Signatory: operator, user

Field	Type	Description
operator	Party	The utility operator.
user	Party	The user.

• Choice Archive

  Controller: operator, user

  Returns: ()

  (no fields)

• Choice UserService\_AcceptCollateralAgreementChangeRequest

  Accept a collateral agreement change request.

  Controller: user

  Returns: CollateralAgreementChangeRequest\_Accept\_Result

  Field	Type	Description
  cid	ContractId CollateralAgreementChangeRequest	The request cid.
  payload	CollateralAgreementChangeRequest\_Accept	The request payload.

• Choice UserService\_AcceptCollateralAgreementRequest

  Accept a collateral agreement request.

  Controller: user

  Returns: CollateralAgreementRequest\_Accept\_Result

  Field	Type	Description
  cid	ContractId CollateralAgreementRequest	The request cid.
  payload	CollateralAgreementRequest\_Accept	The request payload.

• Choice UserService\_CancelCollateralAgreementChangeRequest

  Cancel a collateral agreement change request.

  Controller: user

  Returns: CollateralAgreementChangeRequest\_Cancel\_Result

  Field	Type	Description
  cid	ContractId CollateralAgreementChangeRequest	The request cid.
  payload	CollateralAgreementChangeRequest\_Cancel	The request payload.

• Choice UserService\_CancelCollateralAgreementRequest

  Cancel a collateral agreement request.

  Controller: user

  Returns: CollateralAgreementRequest\_Cancel\_Result

  Field	Type	Description
  cid	ContractId CollateralAgreementRequest	The request cid.
  payload	CollateralAgreementRequest\_Cancel	The request payload.

• Choice UserService\_CancelInstructedCollateral

  Cancel an instructed collateral.

  Controller: user

  Returns: InstructedCollateral\_Cancel\_Result

  Field	Type	Description
  cid	ContractId InstructedCollateral	The Instructed collateral contract.
  allocations	[ContractId Allocation]	The allocations to settle.
  extraArgs	[ExtraArgs]	For each allocation, the arguments to Allocation_Cancel choice.

• Choice UserService\_ExecuteTransfer

  Settle an instructed collateral transfer. This choice is compatible with external signing as long as collateralStateCid is stable (i.e. no other transfer for the same collateral agreement gets settled during the signing window for this choice).

  Controller: user

  Returns: InstructedCollateral\_ExecuteTransfer\_Result

  Field	Type	Description
  cid	ContractId InstructedCollateral	The Instructed Collateral contract.
  allocations	[ContractId Allocation]	The allocations to settle.
  executeTransferArgs	[ExtraArgs]	For each allocation, the arguments to the Allocation_ExecuteTransfer choice.
  collateralStateCid	ContractId CollateralState	Collateral State contract to update.

• Choice UserService\_ProposeCollateralAgreementChange

  Request a modification to an existing collateral agreement.

  Controller: user

  Returns: CollateralAgreement\_ProposeChange\_Result

  Field	Type	Description
  cid	ContractId CollateralAgreement	The collateral agreement to change.
  updatedTerms	Terms	Updated terms.

• Choice UserService\_RejectCollateralAgreementChangeRequest

  Reject a collateral agreement change request.

  Controller: user

  Returns: CollateralAgreementChangeRequest\_Reject\_Result

  Field	Type	Description
  cid	ContractId CollateralAgreementChangeRequest	The request cid.
  payload	CollateralAgreementChangeRequest\_Reject	The request payload.

• Choice UserService\_RejectCollateralAgreementRequest

  Reject a collateral agreement request.

  Controller: user

  Returns: CollateralAgreementRequest\_Reject\_Result

  Field	Type	Description
  cid	ContractId CollateralAgreementRequest	The request cid.
  payload	CollateralAgreementRequest\_Reject	The request payload.

• Choice UserService\_RequestCollateralAgreement

  Request a collateral agreement.

  Controller: user

  Returns: UserService\_RequestCollateralAgreement\_Result

  Field	Type	Description
  counterparty	Party	The counterparty to the request.
  id	Text	Agreement id.
  requestorIsPartyA	Bool	Whether the requestor is PartyA in the CSA.
  terms	Terms	Terms of the collateral agreement.

• Choice UserService\_Terminate

  Terminates the user service.

  Controller: actor

  Returns: UserService\_Terminate\_Result

  Field	Type	Description
  actor	Party	Party initiating the termination of the UserService contract.

• Choice UserService\_TerminateCollateralAgreement

  Terminate a collateral agreement.

  Controller: user

  Returns: CollateralAgreement\_Terminate\_Result

  Field	Type	Description
  cid	ContractId CollateralAgreement	The collateral agreement cid.
  payload	CollateralAgreement\_Terminate	The request payload.

• Choice UserService\_TransferCollateral

  Initiate process to transfer collateral to a counterparty.

  Controller: user

  Returns: CollateralAgreement\_TransferCollateral\_Result

  Field	Type	Description
  cid	ContractId CollateralAgreement	The Collateral Agreement contract.
  positions	{ref}[InstrumentQuantity <type-utility-collateral-app-types-instrumentquantity-32826>]	The positions that will be pledged.
  reference	Text	Textual reference, used for deduplication. Please, ensure this is unique.
  createdAt	Time	Time at which this request is created.
  allocateBefore	Time	Until when (exclusive) the senders are given time to allocate their assets.
  settleBefore	Time	Until when (exclusive) the executor is given time to execute the settlement. TODO consider if this should be provided via OperatorConfiguration.

template UserServiceRequest

A user service request.

Signatory: user

Field	Type	Description
operator	Party	Service operator.
user	Party	User.

• Choice Archive

  Controller: user

  Returns: ()

  (no fields)

• Choice UserServiceRequest\_Accept

  Accept UserService request.

  Controller: operator

  Returns: UserServiceRequest\_Accept\_Result

  Field	Type	Description
  operatorConfigurationCid	ContractId OperatorConfiguration	Operator configuration.
  credentialCids	[ContractId Credential]	User credentials.

• Choice UserServiceRequest\_Cancel

  Cancel UserService request.

  Controller: user

  Returns: UserServiceRequest\_Cancel\_Result

  (no fields)

• Choice UserServiceRequest\_Reject

  Reject UserService request.

  Controller: operator

  Returns: UserServiceRequest\_Reject\_Result

  Field	Type	Description
  reason	Text	Rejection reason.

Data Types

data UserServiceRequest\_Accept\_Result

Result of UserServiceRequest_Accept.

UserServiceRequest\_Accept\_Result

Field	Type	Description
userServiceCid	ContractId UserService	User Service contract id.

data UserServiceRequest\_Cancel\_Result

Result of UserServiceRequest_Cancel.

UserServiceRequest\_Cancel\_Result

(no fields)

data UserServiceRequest\_Reject\_Result

Result of UserServiceRequest_Reject.

UserServiceRequest\_Reject\_Result

Field	Type	Description
reason	Text	Rejection reason.

data UserService\_RequestCollateralAgreement\_Result

Result of UserServiceRequest_RequestCollateralAgreement.

UserService\_RequestCollateralAgreement\_Result

Field	Type	Description
collateralAgreementRequestCid	ContractId CollateralAgreementRequest	Collateral agreement request.

data UserService\_Terminate\_Result

Result of UserService_Terminate.

UserService\_Terminate\_Result

(no fields)