docs: sync Polymarket docs - 2026-04-23
- v2-migration.md: add builder API key clarification note - relayer/submit-a-transaction.md: document POST /submit now returns immediately without transactionHash - relayer/get-a-transaction-by-id.md: add note to poll for onchain transactionHash after submission
This commit is contained in:
@@ -6,6 +6,8 @@
|
|||||||
|
|
||||||
> Gets a transaction submitted to the Relayer. Takes in a required transaction ID as a query parameter.
|
> Gets a transaction submitted to the Relayer. Takes in a required transaction ID as a query parameter.
|
||||||
|
|
||||||
|
Poll this endpoint with the `transactionID` returned from `POST /submit` to retrieve the onchain `transactionHash` once the transaction has been broadcast.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -50,6 +52,11 @@ paths:
|
|||||||
description: >
|
description: >
|
||||||
Gets a transaction submitted to the Relayer. Takes in a required
|
Gets a transaction submitted to the Relayer. Takes in a required
|
||||||
transaction ID as a query parameter.
|
transaction ID as a query parameter.
|
||||||
|
|
||||||
|
|
||||||
|
Poll this endpoint with the `transactionID` returned from `POST /submit`
|
||||||
|
to retrieve the onchain `transactionHash` once the transaction has been
|
||||||
|
broadcast.
|
||||||
parameters:
|
parameters:
|
||||||
- name: id
|
- name: id
|
||||||
in: query
|
in: query
|
||||||
|
|||||||
@@ -6,6 +6,8 @@
|
|||||||
|
|
||||||
> Submit a transaction request to the Relayer. Authenticated using Builder API Keys or Relayer API Keys.
|
> Submit a transaction request to the Relayer. Authenticated using Builder API Keys or Relayer API Keys.
|
||||||
|
|
||||||
|
Returns immediately with the `transactionID` and a `state` of `STATE_NEW`. The onchain transaction hash is **not** included in this response — poll `GET /transaction` with the returned `transactionID` to retrieve the `transactionHash` once the transaction has been broadcast.
|
||||||
|
|
||||||
**Builder API Key auth headers:**
|
**Builder API Key auth headers:**
|
||||||
- `POLY_BUILDER_API_KEY`
|
- `POLY_BUILDER_API_KEY`
|
||||||
- `POLY_BUILDER_TIMESTAMP`
|
- `POLY_BUILDER_TIMESTAMP`
|
||||||
@@ -62,6 +64,12 @@ paths:
|
|||||||
API Keys or Relayer API Keys.
|
API Keys or Relayer API Keys.
|
||||||
|
|
||||||
|
|
||||||
|
Returns immediately with the `transactionID` and a `state` of
|
||||||
|
`STATE_NEW`. The onchain transaction hash is **not** included in this
|
||||||
|
response — poll `GET /transaction` with the returned `transactionID` to
|
||||||
|
retrieve the `transactionHash` once the transaction has been broadcast.
|
||||||
|
|
||||||
|
|
||||||
**Builder API Key auth headers:**
|
**Builder API Key auth headers:**
|
||||||
|
|
||||||
- `POLY_BUILDER_API_KEY`
|
- `POLY_BUILDER_API_KEY`
|
||||||
@@ -146,7 +154,6 @@ paths:
|
|||||||
$ref: '#/components/schemas/SubmitResponse'
|
$ref: '#/components/schemas/SubmitResponse'
|
||||||
example:
|
example:
|
||||||
transactionID: 0190b317-a1d3-7bec-9b91-eeb6dcd3a620
|
transactionID: 0190b317-a1d3-7bec-9b91-eeb6dcd3a620
|
||||||
transactionHash: ''
|
|
||||||
state: STATE_NEW
|
state: STATE_NEW
|
||||||
'400':
|
'400':
|
||||||
description: Bad Request - Invalid transaction payload, fields, or signature
|
description: Bad Request - Invalid transaction payload, fields, or signature
|
||||||
@@ -247,10 +254,6 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
description: Unique identifier for the submitted transaction
|
description: Unique identifier for the submitted transaction
|
||||||
example: 0190b317-a1d3-7bec-9b91-eeb6dcd3a620
|
example: 0190b317-a1d3-7bec-9b91-eeb6dcd3a620
|
||||||
transactionHash:
|
|
||||||
type: string
|
|
||||||
description: Onchain transaction hash (empty on initial submission)
|
|
||||||
example: ''
|
|
||||||
state:
|
state:
|
||||||
type: string
|
type: string
|
||||||
description: Current state of the transaction
|
description: Current state of the transaction
|
||||||
|
|||||||
@@ -387,6 +387,10 @@ V2 replaces the old builder authentication flow (HMAC headers + separate signing
|
|||||||
`BuilderConfig` still exists, but its shape changed. In V1 it wrapped HMAC credentials from `@polymarket/builder-signing-sdk`. In V2 it's just `{ builderCode: string }`.
|
`BuilderConfig` still exists, but its shape changed. In V1 it wrapped HMAC credentials from `@polymarket/builder-signing-sdk`. In V2 it's just `{ builderCode: string }`.
|
||||||
</Note>
|
</Note>
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
**Your builder API key isn't retired.** The HMAC-based builder API key is still used to authenticate with the [Relayer](/trading/gasless) for gasless transactions. Only the order-signing flow moves to the `builderCode` field — your relayer integration keeps the same credentials.
|
||||||
|
</Note>
|
||||||
|
|
||||||
<CodeGroup>
|
<CodeGroup>
|
||||||
```typescript Before (V1) theme={null}
|
```typescript Before (V1) theme={null}
|
||||||
import { BuilderConfig, BuilderApiKeyCreds } from "@polymarket/builder-signing-sdk";
|
import { BuilderConfig, BuilderApiKeyCreds } from "@polymarket/builder-signing-sdk";
|
||||||
|
|||||||
Reference in New Issue
Block a user