Relayer API

GET /receipt/:id

How to read the public fields of one storage receipt, paid or stored.

GET /receipt/:id returns everything public about one storage receipt: what was paid for, the proof's public inputs, the pay transaction and, once stored, the Irys id. A receipt exists once its pay transaction is indexed, which POST /pay waits for. A client reads it to follow a payment through to storage; GET /see/:ref returns the same fields for an Irys id or signature. See Public fields.

Request

HTTP
GET /receipt/0x<receipt id>
Path
idrequired
Field
The receipt id returned by POST /pay as receipt: 0x and 64 lowercase hex characters, a canonical BN254 scalar.

Response

ReceiptResponse
receiptrequired
Field
The receipt id.
ciphertextRootrequired
Hash32
SHA-256 of the padded ciphertext paid for.
bucketrequired
Bucket
The ciphertext's bucket in bytes.
termrequired
Term
30d, 1y or permanent.
relayerrequired
Address
The relayer that submitted the payment. The receipt id does not depend on it; the payment binding does. See The receipt.
rootrequired
Field
The tree root the payment's proof was built against.
nullifiersrequired
[Field, Field]
The nullifiers the payment spent.
outputCommitmentsrequired
[Field, Field]
The two commitments the payment inserted, a zero-valued output included.
publicAmountrequired
Field
The proof's public amount for price plus fee plus networkLamports. See Spending: two in, two out.
bindingHashrequired
Field
The payment binding the proof was bound to. See Binding hashes.
priceLamportsrequired
U64
The storage price paid.
feeLamportsrequired
U64
Geode's fee paid.
networkLamportsrequired
U64
The network refund (the PaidV2 event's relayer_refund) the payment moved to the relayer. See The network refund. "0" for a receipt paid with a Paid event, before the program carried the refund.
signaturerequired
Signature
The pay transaction's signature.
slotrequired
integer
The slot it landed in.
paidAtrequired
Timestamp
The pay transaction's block time, or when the relayer indexed it if the block time is unknown.
statusrequired
'paid' | 'stored'
paid after POST /pay; stored once POST /upload has written the ciphertext.
irysIdrequired
IrysId | null
The ciphertext's Irys id, or null while paid.
storedAtrequired
Timestamp | null
When the ciphertext was stored, or null while paid.
tagsrequired
Tag[]
The Geode tags recorded by POST /pay, each a name (1 to 128 characters) and a value (at most 1024 characters): Geode-Receipt with the receipt id, and Geode-Locator with the locator for a manifest. The upload carries them, with Geode-Term.

Nothing here names the holder, the wallet that shielded, the file or its key. The fields are the ones the pay transaction and the Irys upload already make public.

Errors

Codes are explained in full under Errors.

CodeRaised whenNext
VALIDATION_ERRORid is not a canonical field: not 0x and 64 lowercase hex characters, or not below the BN254 modulus.Pass the receipt value from POST /pay as it is.
NOT_FOUNDNo receipt has this id ("This Geode receipt was not found.").Check the id; a receipt exists from the moment POST /pay succeeds.

Example

HTTP
GET /receipt/0x1ed4e0eca96ce2d60acd1d31a4e9149555a56956e0ce786e969aec15802ef687
Accept: application/json