client.workflows.prepare
Prepare a discriminated, preflighted Torq workflow.
| Package | @torq-finance/sdk |
|---|
| Signature | client.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 method | Workflow type | Required scopes |
|---|
roles.allocator.vaultAllocate | role.allocator.vaultAllocate | role:allocator workflows:prepare |
roles.allocator.vaultDeallocate | role.allocator.vaultDeallocate | role:allocator workflows:prepare |
roles.allocator.vaultReallocationBatch | role.allocator.vaultReallocationBatch | role:allocator workflows:prepare |
Asset Issuer
| SDK method | Workflow type | Required scopes |
|---|
roles.asset_issuer.assetSubmissionRequestCreate | role.asset_issuer.assetSubmissionRequestCreate | role:asset_issuer workflows:prepare |
Asset Manager
| SDK method | Workflow type | Required scopes |
|---|
roles.asset_manager.distressedRecoveryAcquisitionV3Bid | role.asset_manager.distressedRecoveryAcquisitionV3Bid | role:asset_manager workflows:prepare |
roles.asset_manager.distressedRecoveryFundV3ChannelPolicySet | role.asset_manager.distressedRecoveryFundV3ChannelPolicySet | role:asset_manager workflows:prepare |
roles.asset_manager.distressedRecoveryFundV3SelfLaunch | role.asset_manager.distressedRecoveryFundV3SelfLaunch | role:asset_manager workflows:prepare |
roles.asset_manager.vaultDeploy | role.asset_manager.vaultDeploy | role:asset_manager workflows:prepare |
roles.asset_manager.vaultShareMobilityManagerAction | role.asset_manager.vaultShareMobilityManagerAction | role:asset_manager workflows:prepare |
Borrower
| SDK method | Workflow type | Required scopes |
|---|
roles.borrower.borrowerBorrow | role.borrower.borrowerBorrow | role:borrower workflows:prepare |
roles.borrower.borrowerDepositCollateral | role.borrower.borrowerDepositCollateral | role:borrower workflows:prepare |
roles.borrower.borrowerRepay | role.borrower.borrowerRepay | role:borrower workflows:prepare |
roles.borrower.borrowerWithdrawCollateral | role.borrower.borrowerWithdrawCollateral | role:borrower workflows:prepare |
Curator
| SDK method | Workflow type | Required scopes |
|---|
roles.curator.partnerChannelBlockedUpdate | role.curator.partnerChannelBlockedUpdate | role:curator workflows:prepare |
roles.curator.partnerChannelDeploy | role.curator.partnerChannelDeploy | role:curator workflows:prepare |
roles.curator.vaultMarketListingSave | role.curator.vaultMarketListingSave | role:curator workflows:prepare |
Investor
| SDK method | Workflow type | Required scopes |
|---|
roles.investor.partnerWrapperDeposit | role.investor.partnerWrapperDeposit | role:investor workflows:prepare |
roles.investor.partnerWrapperRedeem | role.investor.partnerWrapperRedeem | role:investor workflows:prepare |
Lender
| SDK method | Workflow type | Required scopes |
|---|
roles.lender.distressedRecoveryFundV3AuctionBid | role.lender.distressedRecoveryFundV3AuctionBid | role:lender workflows:prepare |
roles.lender.distressedRecoveryFundV3RfqCancelBid | role.lender.distressedRecoveryFundV3RfqCancelBid | role:lender workflows:prepare |
roles.lender.distressedRecoveryFundV3RfqClaimRefund | role.lender.distressedRecoveryFundV3RfqClaimRefund | role:lender workflows:prepare |
roles.lender.distressedRecoveryFundV3RfqFinalize | role.lender.distressedRecoveryFundV3RfqFinalize | role:lender workflows:prepare |
roles.lender.distressedRecoveryFundV3RfqPlaceBid | role.lender.distressedRecoveryFundV3RfqPlaceBid | role:lender workflows:prepare |
roles.lender.distressedRecoveryFundV3RfqReplaceBid | role.lender.distressedRecoveryFundV3RfqReplaceBid | role:lender workflows:prepare |
roles.lender.investorFulfillRedeem | role.lender.investorFulfillRedeem | role:lender workflows:prepare |
roles.lender.investorRequestRedeem | role.lender.investorRequestRedeem | role:lender workflows:prepare |
roles.lender.vaultShareMobilityInvestorAction | role.lender.vaultShareMobilityInvestorAction | role:lender workflows:prepare |
Liquidator
| SDK method | Workflow type | Required scopes |
|---|
roles.liquidator.liquidate | role.liquidator.liquidate | role:liquidator workflows:prepare |
roles.liquidator.settleLiquidationClaim | role.liquidator.settleLiquidationClaim | role:liquidator workflows:prepare |
Nav Reporter
| SDK method | Workflow type | Required scopes |
|---|
roles.nav_reporter.navReportSignAndSubmit | role.nav_reporter.navReportSignAndSubmit | role:nav_reporter workflows:prepare |
Partner
| SDK method | Workflow type | Required scopes |
|---|
roles.partner.partnerBorrowerFeeClaim | role.partner.partnerBorrowerFeeClaim | role:partner workflows:prepare |
roles.partner.partnerChannelDeploy | role.partner.partnerChannelDeploy | role:partner workflows:prepare |
roles.partner.partnerFeeSharesClaim | role.partner.partnerFeeSharesClaim | role:partner workflows:prepare |
roles.partner.partnerSubmitApplication | role.partner.partnerSubmitApplication | role:partner workflows:prepare |
roles.partner.partnerWrapperDeposit | role.partner.partnerWrapperDeposit | role:partner workflows:prepare |
roles.partner.partnerWrapperRedeem | role.partner.partnerWrapperRedeem | role:partner workflows:prepare |
Vault Manager
| SDK method | Workflow type | Required scopes |
|---|
roles.vault_manager.partnerChannelDeploy | role.vault_manager.partnerChannelDeploy | role:vault_manager workflows:prepare |
Vault Owner
| SDK method | Workflow type | Required scopes |
|---|
roles.vault_owner.attachMarketToVault | role.vault_owner.attachMarketToVault | role:vault_owner workflows:prepare |
roles.vault_owner.vaultAllocate | role.vault_owner.vaultAllocate | role:vault_owner workflows:prepare |
roles.vault_owner.vaultAllocatorUpdate | role.vault_owner.vaultAllocatorUpdate | role:vault_owner workflows:prepare |
roles.vault_owner.vaultCuratorCapsSettingsSave | role.vault_owner.vaultCuratorCapsSettingsSave | role:vault_owner workflows:prepare |
roles.vault_owner.vaultCuratorFeeSettingsSave | role.vault_owner.vaultCuratorFeeSettingsSave | role:vault_owner workflows:prepare |
roles.vault_owner.vaultDeallocate | role.vault_owner.vaultDeallocate | role:vault_owner workflows:prepare |
roles.vault_owner.vaultFeeConfigUpdate | role.vault_owner.vaultFeeConfigUpdate | role:vault_owner workflows:prepare |
roles.vault_owner.vaultManagementSettingsSave | role.vault_owner.vaultManagementSettingsSave | role:vault_owner workflows:prepare |
roles.vault_owner.vaultOwnerSettingsSave | role.vault_owner.vaultOwnerSettingsSave | role:vault_owner workflows:prepare |
roles.vault_owner.vaultOwnerTransferUpdate | role.vault_owner.vaultOwnerTransferUpdate | role:vault_owner workflows:prepare |
roles.vault_owner.vaultReallocationBatch | role.vault_owner.vaultReallocationBatch | role:vault_owner workflows:prepare |
roles.vault_owner.vaultRoleSettingsSave | role.vault_owner.vaultRoleSettingsSave | role:vault_owner workflows:prepare |
roles.vault_owner.vaultRoutingUpdate | role.vault_owner.vaultRoutingUpdate | role:vault_owner workflows:prepare |
roles.vault_owner.vaultSettingsUpdate | role.vault_owner.vaultSettingsUpdate | role:vault_owner workflows:prepare |
See the API Reference for the governed endpoint contract and the workflow guide for canonical completion semantics.