useSorobanForm

​

Core Features

• Runtime Validation: Fetches your contract’s spec and builds a Zod schema for the specific method you are calling.
• Zero Configuration: You do not need to manually write Zod objects or TypeScript interfaces for your form fields.
• Async Resolution: Since the schema is derived from the blockchain, the hook handles the asynchronous loading of the validation rules internally.
• Standard Integration: Returns a standard useForm object, making it compatible with existing UI libraries like shadcn/ui or MUI.

​

Basic Usage

import { useSorobanForm } from "@sorokit/contract";

function TransferForm({ contractId }: { contractId: string }) {
  const { register, handleSubmit, formState } = useSorobanForm({
    contractId,
    method: "transfer",
  });

  const onSubmit = (values: Record<string, unknown>) => {
    console.log("Validated form data:", values);
  };

  return (
    <form onSubmit={handleSubmit(onSubmit)}>
      <label>Recipient Address</label>
      <input {...register("to")} placeholder="G..." />
      {formState.errors.to && <span>{String(formState.errors.to.message)}</span>}

      <button type="submit">Prepare Transfer</button>
    </form>
  );
}

​

Handling BigInt Values

• Use the setValueAs property within the register function.
• This ensures the string input is transformed into a bigint before the Zod schema runs its check, avoiding precision loss from standard JavaScript numbers.

<input
  type="text"
  {...register("amount", {
    setValueAs: (value) => (value === "" ? undefined : BigInt(value)),
  })}
/>

​

Integration with useContractSend

• Form layer (useSorobanForm): Validates that an address is well-formatted and that an amount is a valid number.
• Action layer (useContractSend): Takes the validated data and handles simulation, signing, and submission.
• Shared cache: Both hooks use the same contract spec cache, so there are no redundant network requests.

​

Parameters

​

Return Value