Skip to content
← Open Cap Table Protocol OCP Canton SDK

Reference

PaymentStreams.partyMigrationProposal

Approve a party migration proposal, migrate active or proposed payment streams onto new parties, or archive the migration proposal.

Party migration is a dedicated DAML workflow (PartyMigrationProposal) for moving payment-stream roles between parties. Builders cover approval and migration exercises against active or proposed stream contracts plus archival of the proposal when done.

Receiver

ocp.PaymentStreams.partyMigrationProposal

buildApproveCommand

  • migrationProposalContractId (required)
  • actor (required)

Returns: Command — PartyMigrationProposal_Approve.

buildMigrateActivePaymentStreamCommand

  • migrationProposalContractId (required)
  • actor (required)
  • activePaymentStreamCid (required)

Returns: Command — PartyMigrationProposal_MigrateActivePaymentStream.

buildMigrateProposedPaymentStreamCommand

  • migrationProposalContractId (required)
  • actor (required)
  • proposedPaymentStreamCid (required)

Returns: Command — PartyMigrationProposal_MigrateProposedPaymentStream.

buildArchiveCommand

  • migrationProposalContractId (required)
  • actor (required)
  • description (optional) — passed through when set (see SDK implementation)

Returns: Command — PartyMigrationProposal_Archive.

Errors

Builders do not throw Ocp*. Preconditions (every party signed, contracts in the right state) are enforced on the ledger.

See also

Source