Repository navigation
fix(sdk): keep API response endpoints on the configured baseApiUrl - #1165
ted-uneven merged 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Claude finished @ted-uneven's task in 1m 45s —— View job 📝 Docs Drift Check — Confidence: MEDIUM What changed: The SDK now requires Docs impact: The Affected pages (paths inside
Draft: > Replace section: `## Options`
## Options
| Property | Description | Required |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| **baseApiUrl** | The base API url to use when making requests. You can use the `MAINNET_RELAY_API` or the `TESTNET_RELAY_API` constants exported by the package, or pass in your own proxy API url to protect your API key on the client. Only set this to the Relay API or a proxy you control. | ✅ |
| **apiKey** | A Relay API key to use when making requests. Only pass in this property when the Relay client instance is used exclusively server-side. Otherwise you'll leak your key to the client. | ❌ |
| **chains** | A list of Relay Chains, by default a list of backup chains is configured | ❌ |
| **source** | The source to associate your onchain activity with, should map to a domain | ❌ |
| **logLevel** | The level at which to log, refer to the `LogLevel` enum exported by the package | ❌ |
| **pollingInterval** | How often to poll status and check apis, this value is in milliseconds | ❌ |
| **maxPollingAttemptsBeforeTimeout** | The source to associate your onchain activity with, should be set to a domain | ❌ |
<Warning>
Only set **`baseApiUrl`** to the Relay API or a proxy you control. The SDK resolves the step endpoints returned in API responses against this origin and rejects any that resolve to a different host, so your API key is only ever sent to the configured origin.
</Warning>Needs human input:
To publish as a draft PR in
A separate workflow will open a draft PR attributed to you. Edit the draft freely before marking it ready for review. |
|
Claude finished @ted-uneven's task in 1m 31s —— View job Code Review — No issues found.Reviewed 7 files, 55/-11 lines changed. Checked correctness, security, error handling, and repo guidelines compliance. This is a clean, well-targeted fix for the SSRF / API-key-leak vector (SDK executing API-response step endpoints that resolve off the configured
No regression for proxy setups: a path-prefixed |
[Medium impact] The PR appears safe to merge; no new actionable issue was found.
|
e977d3a to
f88e257
Compare
|
Claude finished @ted-uneven's task in 1m 26s —— View job Code Review — No issues found.Reviewed 8 files, 83/-21 lines changed. Checked correctness, security, error handling, and repo guidelines compliance. This is a clean fix for the SSRF / API-key-leak vector. I focused on whether the three findings from the earlier Greptile pass are resolved in the current commit (
Security of the origin check holds up: the userinfo ( Two minor non-blocking notes (not worth changing):
The changeset also follows the repo's changelog guidance — it leads with the reader-facing outcome. |
|
Claude finished @ted-uneven's task in 1m 17s —— View job 📝 Docs Drift Check — Confidence: MEDIUM What changed: The SDK now treats the step endpoints returned in API responses as resolving against the configured Docs impact: The Affected pages (paths inside
Draft: > Replace section: `## Options`
## Options
| Property | Description | Required |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| **baseApiUrl** | The base API url to use when making requests. You can use the `MAINNET_RELAY_API` or the `TESTNET_RELAY_API` constants exported by the package, or pass in your own proxy API url to protect your API key on the client. Only set this to the Relay API or a proxy you control. | ✅ |
| **apiKey** | A Relay API key to use when making requests. Only pass in this property when the Relay client instance is used exclusively server-side. Otherwise you'll leak your key to the client. | ❌ |
| **chains** | A list of Relay Chains, by default a list of backup chains is configured | ❌ |
| **source** | The source to associate your onchain activity with, should map to a domain | ❌ |
| **logLevel** | The level at which to log, refer to the `LogLevel` enum exported by the package | ❌ |
| **pollingInterval** | How often to poll status and check apis, this value is in milliseconds | ❌ |
| **maxPollingAttemptsBeforeTimeout** | The source to associate your onchain activity with, should be set to a domain | ❌ |
<Warning>
Only set **`baseApiUrl`** to the Relay API or a proxy you control. The SDK resolves the endpoints returned in API responses against this origin and rejects any that resolve to a different host, so your API key is only ever sent to the configured origin.
</Warning>Needs human input:
To publish as a draft PR in
A separate workflow will open a draft PR attributed to you. Edit the draft freely before marking it ready for review. |
f88e257 to
2806ba8
Compare
|
Claude finished @ted-uneven's task in 1m 48s —— View job Code Review — No issues found.Reviewed 7 files, 55/-11 lines changed. Checked correctness, security, error handling, and repo guidelines compliance. This is a clean, well-targeted fix for the SSRF / API-key-leak vector (SDK executing API-response step endpoints that resolve off the configured
No regression for path-prefixed proxies ( |
|
Claude finished @ted-uneven's task in 49s —— View job 📝 Docs Drift Check — Confidence: MEDIUM What changed: The SDK now resolves the step endpoints returned in API responses against the configured Docs impact: The Affected pages (paths inside
Draft: > Replace section: `## Options`
## Options
| Property | Description | Required |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| **baseApiUrl** | The base API url to use when making requests. You can use the `MAINNET_RELAY_API` or the `TESTNET_RELAY_API` constants exported by the package, or pass in your own proxy API url to protect your API key on the client. Only set this to the Relay API or a proxy you control. | ✅ |
| **apiKey** | A Relay API key to use when making requests. Only pass in this property when the Relay client instance is used exclusively server-side. Otherwise you'll leak your key to the client. | ❌ |
| **chains** | A list of Relay Chains, by default a list of backup chains is configured | ❌ |
| **source** | The source to associate your onchain activity with, should map to a domain | ❌ |
| **logLevel** | The level at which to log, refer to the `LogLevel` enum exported by the package | ❌ |
| **pollingInterval** | How often to poll status and check apis, this value is in milliseconds | ❌ |
| **maxPollingAttemptsBeforeTimeout** | The source to associate your onchain activity with, should be set to a domain | ❌ |
<Warning>
Only set **`baseApiUrl`** to the Relay API or a proxy you control. The SDK resolves the endpoints returned in API responses against this origin and rejects any that resolve to a different host, so your API key is only ever sent to the configured origin.
</Warning>Needs human input:
To publish as a draft PR in
A separate workflow will open a draft PR attributed to you. Edit the draft freely before marking it ready for review. |
|
/publish-docs-pr |
|
🚚 Docs Draft PR — starting publish to |
|
Claude finished @ted-uneven's task in 55s —— View job Docs update materialized ✅Applied the drift-check draft to the cloned
Files changed
Conformance checks
Notes for the reviewer
|
|
✅ Docs Draft PR opened: relayprotocol/relay-docs#536 @ted-uneven is assigned on the draft PR. Review and mark ready when it's good. |
…bility-report-sdk-executes-unbound-api-steps
|
Claude finished @ted-uneven's task in 40s —— View job Code Review -- No issues found. Reviewed 7 files, 67/-21 lines changed. Checked for correctness, security, error handling, and repo guidelines compliance. What I checked:
|
|
Claude finished @ted-uneven's task in 26s —— View job 📝 Docs Drift Check — Confidence: MEDIUM What changed: The SDK now resolves step endpoints from API responses against the configured Docs impact: The Affected pages (paths inside
Draft: > Replace section: `## Options` (keep the existing `typescript` example below the table unchanged)
## Options
| Property | Description | Required |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| **baseApiUrl** | The base API url to use when making requests. You can use the `MAINNET_RELAY_API` or the `TESTNET_RELAY_API` constants exported by the package, or pass in your own proxy API url to protect your API key on the client. Only set this to the Relay API or a proxy you control. | ✅ |
| **apiKey** | A Relay API key to use when making requests. Only pass in this property when the Relay client instance is used exclusively server-side. Otherwise you'll leak your key to the client. | ❌ |
| **chains** | A list of Relay Chains, by default a list of backup chains is configured | ❌ |
| **source** | The source to associate your onchain activity with, should map to a domain | ❌ |
| **logLevel** | The level at which to log, refer to the `LogLevel` enum exported by the package | ❌ |
| **pollingInterval** | How often to poll status and check apis, this value is in milliseconds | ❌ |
| **maxPollingAttemptsBeforeTimeout** | The source to associate your onchain activity with, should be set to a domain | ❌ |
<Warning>
Only set **`baseApiUrl`** to the Relay API or a proxy you control. The SDK resolves the endpoints returned in API responses against this origin and rejects any that resolve to a different host, so your API key is only ever sent to the configured origin.
</Warning>Needs human input:
To publish as a draft PR in
A separate workflow will open a draft PR attributed to you. Edit the draft freely before marking it ready for review. |
No description provided.