Docs

client.workflows.prepare

Prepare a discriminated, preflighted Torq workflow.

Package@torq-finance/sdk
Signatureclient.workflows.prepare(request, { idempotencyKey? })

Behavior

Creates an explicit workflow with ordered transaction intents, snapshot hash, expiry, preflight requirements, blocked reasons, and expected postconditions.

Example

const workflow = await torq.workflows.prepare({
  workflowType: 'role.vault_owner.vaultAllocatorUpdate',
  chainId: 11155111,
  input: allocationInput,
});

Security boundary

State-changing preparation uses an idempotency key. Never submit an arbitrary contract call in place of a registered workflow type.

Complete typed workflow catalogue

This table is rendered from the same generated capability-method registry imported by the SDK. Presence documents a maintained adapter; it does not grant the calling application or wallet that role, scope, entity authority, or production access.

Allocator

SDK methodWorkflow typeRequired scopes
roles.allocator.vaultAllocaterole.allocator.vaultAllocaterole:allocator workflows:prepare
roles.allocator.vaultDeallocaterole.allocator.vaultDeallocaterole:allocator workflows:prepare
roles.allocator.vaultReallocationBatchrole.allocator.vaultReallocationBatchrole:allocator workflows:prepare

Asset Issuer

SDK methodWorkflow typeRequired scopes
roles.asset_issuer.assetSubmissionRequestCreaterole.asset_issuer.assetSubmissionRequestCreaterole:asset_issuer workflows:prepare

Asset Manager

SDK methodWorkflow typeRequired scopes
roles.asset_manager.distressedRecoveryAcquisitionV3Bidrole.asset_manager.distressedRecoveryAcquisitionV3Bidrole:asset_manager workflows:prepare
roles.asset_manager.distressedRecoveryFundV3ChannelPolicySetrole.asset_manager.distressedRecoveryFundV3ChannelPolicySetrole:asset_manager workflows:prepare
roles.asset_manager.distressedRecoveryFundV3SelfLaunchrole.asset_manager.distressedRecoveryFundV3SelfLaunchrole:asset_manager workflows:prepare
roles.asset_manager.vaultDeployrole.asset_manager.vaultDeployrole:asset_manager workflows:prepare
roles.asset_manager.vaultShareMobilityManagerActionrole.asset_manager.vaultShareMobilityManagerActionrole:asset_manager workflows:prepare

Borrower

SDK methodWorkflow typeRequired scopes
roles.borrower.borrowerBorrowrole.borrower.borrowerBorrowrole:borrower workflows:prepare
roles.borrower.borrowerDepositCollateralrole.borrower.borrowerDepositCollateralrole:borrower workflows:prepare
roles.borrower.borrowerRepayrole.borrower.borrowerRepayrole:borrower workflows:prepare
roles.borrower.borrowerWithdrawCollateralrole.borrower.borrowerWithdrawCollateralrole:borrower workflows:prepare

Curator

SDK methodWorkflow typeRequired scopes
roles.curator.partnerChannelBlockedUpdaterole.curator.partnerChannelBlockedUpdaterole:curator workflows:prepare
roles.curator.partnerChannelDeployrole.curator.partnerChannelDeployrole:curator workflows:prepare
roles.curator.vaultMarketListingSaverole.curator.vaultMarketListingSaverole:curator workflows:prepare

Investor

SDK methodWorkflow typeRequired scopes
roles.investor.partnerWrapperDepositrole.investor.partnerWrapperDepositrole:investor workflows:prepare
roles.investor.partnerWrapperRedeemrole.investor.partnerWrapperRedeemrole:investor workflows:prepare

Lender

SDK methodWorkflow typeRequired scopes
roles.lender.distressedRecoveryFundV3AuctionBidrole.lender.distressedRecoveryFundV3AuctionBidrole:lender workflows:prepare
roles.lender.distressedRecoveryFundV3RfqCancelBidrole.lender.distressedRecoveryFundV3RfqCancelBidrole:lender workflows:prepare
roles.lender.distressedRecoveryFundV3RfqClaimRefundrole.lender.distressedRecoveryFundV3RfqClaimRefundrole:lender workflows:prepare
roles.lender.distressedRecoveryFundV3RfqFinalizerole.lender.distressedRecoveryFundV3RfqFinalizerole:lender workflows:prepare
roles.lender.distressedRecoveryFundV3RfqPlaceBidrole.lender.distressedRecoveryFundV3RfqPlaceBidrole:lender workflows:prepare
roles.lender.distressedRecoveryFundV3RfqReplaceBidrole.lender.distressedRecoveryFundV3RfqReplaceBidrole:lender workflows:prepare
roles.lender.investorFulfillRedeemrole.lender.investorFulfillRedeemrole:lender workflows:prepare
roles.lender.investorRequestRedeemrole.lender.investorRequestRedeemrole:lender workflows:prepare
roles.lender.vaultShareMobilityInvestorActionrole.lender.vaultShareMobilityInvestorActionrole:lender workflows:prepare

Liquidator

SDK methodWorkflow typeRequired scopes
roles.liquidator.liquidaterole.liquidator.liquidaterole:liquidator workflows:prepare
roles.liquidator.settleLiquidationClaimrole.liquidator.settleLiquidationClaimrole:liquidator workflows:prepare

Nav Reporter

SDK methodWorkflow typeRequired scopes
roles.nav_reporter.navReportSignAndSubmitrole.nav_reporter.navReportSignAndSubmitrole:nav_reporter workflows:prepare

Partner

SDK methodWorkflow typeRequired scopes
roles.partner.partnerBorrowerFeeClaimrole.partner.partnerBorrowerFeeClaimrole:partner workflows:prepare
roles.partner.partnerChannelDeployrole.partner.partnerChannelDeployrole:partner workflows:prepare
roles.partner.partnerFeeSharesClaimrole.partner.partnerFeeSharesClaimrole:partner workflows:prepare
roles.partner.partnerSubmitApplicationrole.partner.partnerSubmitApplicationrole:partner workflows:prepare
roles.partner.partnerWrapperDepositrole.partner.partnerWrapperDepositrole:partner workflows:prepare
roles.partner.partnerWrapperRedeemrole.partner.partnerWrapperRedeemrole:partner workflows:prepare

Vault Manager

SDK methodWorkflow typeRequired scopes
roles.vault_manager.partnerChannelDeployrole.vault_manager.partnerChannelDeployrole:vault_manager workflows:prepare

Vault Owner

SDK methodWorkflow typeRequired scopes
roles.vault_owner.attachMarketToVaultrole.vault_owner.attachMarketToVaultrole:vault_owner workflows:prepare
roles.vault_owner.vaultAllocaterole.vault_owner.vaultAllocaterole:vault_owner workflows:prepare
roles.vault_owner.vaultAllocatorUpdaterole.vault_owner.vaultAllocatorUpdaterole:vault_owner workflows:prepare
roles.vault_owner.vaultCuratorCapsSettingsSaverole.vault_owner.vaultCuratorCapsSettingsSaverole:vault_owner workflows:prepare
roles.vault_owner.vaultCuratorFeeSettingsSaverole.vault_owner.vaultCuratorFeeSettingsSaverole:vault_owner workflows:prepare
roles.vault_owner.vaultDeallocaterole.vault_owner.vaultDeallocaterole:vault_owner workflows:prepare
roles.vault_owner.vaultFeeConfigUpdaterole.vault_owner.vaultFeeConfigUpdaterole:vault_owner workflows:prepare
roles.vault_owner.vaultManagementSettingsSaverole.vault_owner.vaultManagementSettingsSaverole:vault_owner workflows:prepare
roles.vault_owner.vaultOwnerSettingsSaverole.vault_owner.vaultOwnerSettingsSaverole:vault_owner workflows:prepare
roles.vault_owner.vaultOwnerTransferUpdaterole.vault_owner.vaultOwnerTransferUpdaterole:vault_owner workflows:prepare
roles.vault_owner.vaultReallocationBatchrole.vault_owner.vaultReallocationBatchrole:vault_owner workflows:prepare
roles.vault_owner.vaultRoleSettingsSaverole.vault_owner.vaultRoleSettingsSaverole:vault_owner workflows:prepare
roles.vault_owner.vaultRoutingUpdaterole.vault_owner.vaultRoutingUpdaterole:vault_owner workflows:prepare
roles.vault_owner.vaultSettingsUpdaterole.vault_owner.vaultSettingsUpdaterole:vault_owner workflows:prepare

See the API Reference for the governed endpoint contract and the workflow guide for canonical completion semantics.