Inputs

Inputs are the mechanism by which Warps collect data from users, the environment, or the URL to execute actions.

Input Structure

{
  "name": "Amount",
  "as": "amount",
  "label": "Enter Amount",
  "description": "The amount to transfer",
  "bot": "AI-only hint for this input",
  "type": "uint256",
  "position": "arg:1",
  "source": "field",
  "required": true,
  "min": 1,
  "max": 1000000,
  "pattern": "^[0-9]+$",
  "patternDescription": "Must be a positive number",
  "options": ["100", "500", "1000"],
  "modifier": "scale:18",
  "default": "100"
}

Properties

Property	Type	Required	Description
name	string	✅	Display name / query param key
type	string	✅	Data type (see below)
source	string	✅	Where value comes from
as	string	❌	Variable name for interpolation
label	WarpText	❌	Localized label
description	WarpText	❌	Help text
bot	string	❌	AI-only context
position	string	❌	Where value is used in the action
required	boolean	❌	Mandatory field
min	number	❌	Minimum value (numbers) or length (strings)
max	number	❌	Maximum value (numbers) or length (strings)
pattern	string	❌	Regex validation pattern
patternDescription	WarpText	❌	Error message for pattern mismatch
options	array/object	❌	Dropdown options
modifier	string	❌	Value transformation
default	any	❌	Default value

Sources

field

Renders a form field for user input.

{ "source": "field", "label": "Your Name" }

query

Reads from the URL query parameters.

// URL: ?token=USDC
{ "name": "token", "source": "query" }

user:wallet

Auto-fills with the connected user's wallet address.

{ "name": "sender", "type": "address", "source": "user:wallet" }

hidden

A hardcoded internal value, not shown to the user.

{ "name": "version", "source": "hidden", "default": "1.0.0" }

Input Types

Base Types

• string: Plain text.
• uint8 - uint256: Unsigned integers.
• biguint: Arbitrary precision integers.
• bool: true or false.
• address: Blockchain specific address format.
• hex: Hexadecimal string data.
• token: Token identifier (e.g., USDC-123).

Special UI Types

• nft: Renders an NFT picker.
• asset: Renders a generic asset/token selector.

Positions

Positions dictate where the input value is applied in the action.

Transaction Positions

• receiver: The recipient of a transfer.
• value: The amount of native currency to send.
• transfer: The token/asset object to transfer.
• data: The transaction data payload.
• chain: The target blockchain identifier.

Contract Arguments

• arg:1 ... arg:10: Maps to the Nth argument of the function call.

HTTP Positions

• destination: The HTTP endpoint to send to.
• payload:path: Maps to a nested JSON path in the request body (e.g. payload:data.customer).
• local: Value is available for {{interpolation}} in subsequent actions but is not included in the HTTP request body. Use for inputs needed by a prompt action but not by the API destination.

Object Positions

For complex inputs like assets, you can map fields to multiple arguments:

{
  "position": {
    "token": "arg:1",
    "amount": "arg:2"
  }
}

Validation & Options

Pattern (Regex)

{
  "pattern": "^[A-Z]+-[a-f0-9]{6}$",
  "patternDescription": "Must be a valid token ID"
}

Options

Simple Array:

{ "options": ["1 day", "1 week"] }

Labeled Object:

{
  "options": {
    "ethereum": "Ethereum Mainnet",
    "base": "Base Network"
  }
}

Modifiers

Modifiers transform the value after collection but before execution.

Scale

Multiplies the number by 10^decimals.

// Input: 1.5 -> Output: 1500000000000000000
{ "modifier": "scale:18" }

Dynamic Scale: Reference another input variable for the decimals.

{ "modifier": "scale:{{decimals}}" }

Transform (JS)

Execute simple JavaScript to transform an input. The first argument is the current input's native value. Use it alone when the transform does not need sibling inputs.

{
  "modifier": "transform:(value) => value.toUpperCase()"
}

When sibling context is necessary, the second argument contains all inputs, keyed by as or name:

{
  "modifier": "transform:(value, inputs) => inputs.currency === 'USD' ? value * 100 : value"
}

Transforms that use neither argument may remain zero-argument callbacks, such as transform:() => Math.random().