bus

Form a new contract

Changed on

Forms a new contract with the provided metadata. This endpoint is usually called by the autopilot but also allows to form contracts manually.

post/bus/contracts/form

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

endHeightinteger

The block height at which the contract will end.

hostCollateralstring

The amount of collateral the host is committing.

hostKeystring

The public key of the host.

renterFundsstring

The funds the renter is committing.

renterAddressstring

The renter's address

Example request

{
  "endHeight": 92813
}

Response

Contract formed successfully

idstring

The unique identifier for the file contract.

hostKeystring

The public key of the host.

v2boolean

Indicates if the contract is a V2 contract.

proofHeightinteger

The height at which the storage proof needs to be submitted

renewedFromstring

The ID of the contract this one was renewed from

revisionHeightinteger

The block height of the latest revision

revisionNumberinteger

The current revision number of the contract

sizeinteger

The size of the contract in bytes

startHeightinteger

The block height at which the contract created

state'pending' | 'active' | 'complete' | 'failed'

The state of the contract

usability'good' | 'bad'

The usability status of the contract

windowStartinteger

The block height when the contract's proof window starts.

windowEndinteger

The block height when the contract's proof window ends.

contractPricestring

The price of forming the contract.

initialRenterFundsstring

The initial funds provided by the renter.

archivalReason'renewed' | 'removed' | 'hostpruned'

The reason for archiving the contract, if applicable.

renewedTostring

The ID of the contract this one was renewed to, if applicable.

Example response

{
  "proofHeight": 92813,
  "revisionHeight": 92813,
  "revisionNumber": 246,
  "startHeight": 92813,
  "windowStart": 92813,
  "windowEnd": 92813
}

Changes