Add OZ Relayer docs #2071 #2176

+
+### Prerequisites
+
+This guide assumes you have deployed the Increment smart contract example code found [here](https://github.com/stellar/soroban-examples/tree/v22.0.1/increment). See the [Getting Started](https://developers.stellar.org/docs/build/smart-contracts/getting-started) tutorial section 3 and 4 for more information about building and deploying the Increment contract.


let's make the Getting Started link a relative one (the kind that's like ../../path/to/file.mdx)

docs/tools/openzeppelin-relayer.mdx

ElliotFriend · 2026-01-13T21:04:12Z

docs/tools/openzeppelin-relayer.mdx

+
+```js
+// Poll for transaction result
+let txResponse = await rpc.getTransaction(response.hash!);


i think there's something like rpc.pollTransaction() that you could use that takes away the need for the while loop

Co-authored-by: Elliot Voris <elliot@stellar.org>

Copilot

Pull request overview

This PR adds comprehensive documentation for the OpenZeppelin Relayer (also known as Stellar Channels Service) to the Stellar developer documentation. The documentation replaces the discontinued Launchtube service and provides developers with a managed infrastructure solution for submitting Stellar Soroban transactions with automatic parallel processing and fee management.

Changes:

Added new documentation page with detailed guides for smart contract invocation and account transfers using OpenZeppelin Relayer
Integrated OpenZeppelin Relayer into navigation menus, routes, and internationalization files
Updated tools overview page to include the new relayer service

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 19 comments.

Show a summary per file

File	Description
docs/tools/openzeppelin-relayer.mdx	New comprehensive documentation page with code examples for using OpenZeppelin Relayer for contract invocations and token transfers
docs/tools/README.mdx	Added OpenZeppelin Relayer section to the tools overview page
config/theme/navbar.ts	Added OpenZeppelin Relayer navigation item in the Tools dropdown menu
i18n/en/docusaurus-theme-classic/navbar.json	Added internationalization entry for OpenZeppelin Relayer navbar label
static/llms.txt	Added OpenZeppelin Relayer link to the developer tools list
routes.txt	Added route for the new OpenZeppelin Relayer documentation page

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-15T19:21:09Z

docs/tools/openzeppelin-relayer.mdx

+        <label
+          htmlFor="amount"
+          className="block mb-2.5 text-sm font-medium text-heading"
+          >Amount (XML)</label


The label incorrectly refers to "XML" when it should be "XLM" (the native Stellar token). XML is a markup language, while XLM is the Stellar Lumens cryptocurrency.

Suggested change

>Amount (XML)</label

>Amount (XLM)</label

Copilot · 2026-01-15T19:21:09Z

docs/tools/openzeppelin-relayer.mdx

+              <input type="text" id="toAddress" name="toAddress" className="bg-neutral-secondary-medium border border-default-medium text-heading text-sm rounded-base focus:ring-brand focus:border-brand block w-full px-3 py-2.5 shadow-xs placeholder:text-body" placeholder="G.........." required />
+            </div>
+            <div className="mb-5">
+              <label htmlFor="amount" className="block mb-2.5 text-sm font-medium text-heading">Amount (XML)</label>


The label incorrectly refers to "XML" when it should be "XLM" (the native Stellar token). XML is a markup language, while XLM is the Stellar Lumens cryptocurrency.

Suggested change

<label htmlFor="amount" className="block mb-2.5 text-sm font-medium text-heading">Amount (XML)</label>

<label htmlFor="amount" className="block mb-2.5 text-sm font-medium text-heading">Amount (XLM)</label>

Copilot · 2026-01-15T19:21:09Z

docs/tools/openzeppelin-relayer.mdx

+// Poll for transaction result
+let txResponse = await rpc.getTransaction(response.hash!);
+while (txResponse.status === "NOT_FOUND") {
+  await new Promise((r) => setTimeout(r, 2000));
+  txResponse = await rpc.getTransaction(response.hash!);
+}


The polling loop lacks a timeout mechanism. If the transaction never gets confirmed or fails, this will poll indefinitely. Consider adding a maximum number of retries or a timeout to prevent infinite loops.

Suggested change

// Poll for transaction result

let txResponse = await rpc.getTransaction(response.hash!);

while (txResponse.status === "NOT_FOUND") {

await new Promise((r) => setTimeout(r, 2000));

txResponse = await rpc.getTransaction(response.hash!);

}

// Poll for transaction result with a maximum number of attempts to avoid infinite loops

const maxAttempts = 30; // e.g., ~60 seconds total with 2s delay

let attempts = 0;

let txResponse = await rpc.getTransaction(response.hash!);

while (txResponse.status === "NOT_FOUND" && attempts < maxAttempts) {

await new Promise((r) => setTimeout(r, 2000));

txResponse = await rpc.getTransaction(response.hash!);

attempts++;

}

if (txResponse.status === "NOT_FOUND") {

throw new Error("Transaction could not be confirmed within the expected time.");

}

Copilot · 2026-01-15T19:21:10Z

docs/tools/openzeppelin-relayer.mdx

+    });
+
+    return response.hash;
+  } catch (error) {


The catch block simply re-throws the error without adding context or handling. While this may be intentional for demonstration purposes, consider either removing the try-catch entirely or adding meaningful error handling/logging.

Suggested change

} catch (error) {

} catch (error) {

console.error('Failed to submit Stellar transaction via OpenZeppelin Relayer:', error);

Copilot · 2026-01-15T19:21:10Z

docs/tools/openzeppelin-relayer.mdx

+// Return the result
+return txResponse.returnValue._value;


Accessing _value (a private/internal property indicated by the underscore prefix) directly may be fragile and could break with SDK updates. Consider using the proper public API method to extract the return value if available.

Suggested change

// Return the result

return txResponse.returnValue._value;

// Return the result using the public SDK helper

return StellarSDK.scValToNative(txResponse.returnValue);

Copilot · 2026-01-15T19:21:13Z

docs/tools/openzeppelin-relayer.mdx

+</div>
+```
+
+3. The complete code This is the complete code for the client side (frontend):


This heading should be formatted as a markdown heading (#### 3. The complete code) to maintain consistency with other numbered sections like "#### 1. Call server side function" and "#### 2. Markup code".

Suggested change

3. The complete code This is the complete code for the client side (frontend):

#### 3. The complete code

This is the complete code for the client side (frontend):

Copilot · 2026-01-15T19:21:13Z

docs/tools/openzeppelin-relayer.mdx

+  const simulation = await rpc.simulateTransaction(tx);
+  const assembled = StellarSDK.rpc.assembleTransaction(tx, simulation).build();
+  // Extract function and auth XDRs
+  const op = await assembled.operations[0];


The await keyword is unnecessary here since accessing an array element is a synchronous operation. Remove the await keyword as it has no effect and may cause confusion.

Suggested change

const op = await assembled.operations[0];

const op = assembled.operations[0];

Copilot · 2026-01-15T19:21:14Z

docs/tools/openzeppelin-relayer.mdx

+while (txResponse.status === "NOT_FOUND") {
+  await new Promise((r) => setTimeout(r, 2000));
+  txResponse = await rpc.getTransaction(response.hash!);
+}
+// Return the result


The polling loop only checks for "NOT_FOUND" status but doesn't handle other possible transaction statuses like "FAILED". If the transaction fails, this could result in returning an undefined or incorrect value. Consider adding proper status checking and error handling.

Suggested change

while (txResponse.status === "NOT_FOUND") {

await new Promise((r) => setTimeout(r, 2000));

txResponse = await rpc.getTransaction(response.hash!);

}

// Return the result

let attempts = 0;

const maxAttempts = 30;

while (txResponse.status === "NOT_FOUND" && attempts < maxAttempts) {

await new Promise((r) => setTimeout(r, 2000));

txResponse = await rpc.getTransaction(response.hash!);

attempts += 1;

}

if (txResponse.status !== "SUCCESS") {

throw new Error(`Transaction did not complete successfully. Status: ${txResponse.status}`);

}

// Return the result

if (!txResponse.returnValue || typeof txResponse.returnValue._value === "undefined") {

throw new Error("Transaction completed but no return value was found.");

}

Copilot · 2026-01-15T19:21:14Z

docs/tools/openzeppelin-relayer.mdx

+    const args: [] = [];
+    const response = await SendContractTransaction(
+      'GAZQUIHE242WV4CK7LLM5ZV4SM6SLV4CEY4LLAKEYD2O000000000000',
+      'CDAZOG4V2KAPVBBKCAMHUT367AUGYWYEHD652UOJVER5ERNYGSOROBAN',
+      "increment",
+      [],
+    );


The variable args is declared but then an empty array is passed directly to SendContractTransaction instead. This makes the args variable declaration redundant. Consider either using the args variable or removing its declaration.

Copilot · 2026-01-15T19:21:14Z

docs/tools/openzeppelin-relayer.mdx

+}
+```
+
+### OpenZeppelin Relayer documentation


This section is titled "OpenZeppelin Relayer documentation" at the end of a page already about OpenZeppelin Relayer documentation. The title is redundant and should be more specific, such as "Additional Resources" or "Further Reading".

Suggested change

### OpenZeppelin Relayer documentation

### Additional resources

stellar-jenkins · 2026-01-15T19:25:41Z

Preview is available here:
http://developers-pr2176.previews.kube001.services.stellar-ops.com

carstenjacobsen added 2 commits January 9, 2026 01:20

Adding OZ Relayer to docs

6f53d25

Adding OZ Relayer to docs

15e7bbc

Fixing formatting

21170d7

Fixing formatting

99599ed

Fixing formatting

458d15e

carstenjacobsen requested review from ElliotFriend and briwylde08 January 9, 2026 11:04

carstenjacobsen added 2 commits January 9, 2026 08:28

Fixing formatting

c16054a

Fixing formatting

d562994

Fixing formatting

091a14d

carstenjacobsen added 2 commits January 9, 2026 09:05

Fixing formatting

6d452ae

Fixing formatting

df9ab8a

Fixing formatting

5342d6c

Fixing intro text

40ff1b9

janewang reviewed Jan 12, 2026

View reviewed changes

docs/tools/README.mdx Show resolved Hide resolved

Adding link to OZ docs

2f8ad28

carstenjacobsen requested a review from janewang January 13, 2026 03:08

ElliotFriend reviewed Jan 13, 2026

View reviewed changes

Update docs/tools/openzeppelin-relayer.mdx

892a642

Co-authored-by: Elliot Voris <elliot@stellar.org>

Copilot AI review requested due to automatic review settings January 15, 2026 19:15

Copilot started reviewing on behalf of carstenjacobsen January 15, 2026 19:16 View session

Copilot AI reviewed Jan 15, 2026

View reviewed changes


		### Prerequisites

		This guide assumes you have deployed the Increment smart contract example code found [here](https://github.com/stellar/soroban-examples/tree/v22.0.1/increment). See the [Getting Started](https://developers.stellar.org/docs/build/smart-contracts/getting-started) tutorial section 3 and 4 for more information about building and deploying the Increment contract.

	<label htmlFor="amount" className="block mb-2.5 text-sm font-medium text-heading">Amount (XML)</label>
	<label htmlFor="amount" className="block mb-2.5 text-sm font-medium text-heading">Amount (XLM)</label>

	} catch (error) {
	} catch (error) {
	console.error('Failed to submit Stellar transaction via OpenZeppelin Relayer:', error);

	3. The complete code This is the complete code for the client side (frontend):
	#### 3. The complete code
	This is the complete code for the client side (frontend):

	const op = await assembled.operations[0];
	const op = assembled.operations[0];

-while (txResponse.status === "NOT_FOUND") {
-  await new Promise((r) => setTimeout(r, 2000));
-  txResponse = await rpc.getTransaction(response.hash!);
-}
-// Return the result
+let attempts = 0;
+const maxAttempts = 30;
+while (txResponse.status === "NOT_FOUND" && attempts < maxAttempts) {
+  await new Promise((r) => setTimeout(r, 2000));
+  txResponse = await rpc.getTransaction(response.hash!);
+  attempts += 1;
+}
+if (txResponse.status !== "SUCCESS") {
+  throw new Error(`Transaction did not complete successfully. Status: ${txResponse.status}`);
+}
+// Return the result
+if (!txResponse.returnValue || typeof txResponse.returnValue._value === "undefined") {
+  throw new Error("Transaction completed but no return value was found.");
+}

	### OpenZeppelin Relayer documentation
	### Additional resources

Add OZ Relayer docs #2071 #2176

Are you sure you want to change the base?

Add OZ Relayer docs #2071 #2176

Uh oh!

Conversation

carstenjacobsen commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 9, 2026

Uh oh!

stellar-jenkins commented Jan 12, 2026

Uh oh!

Uh oh!

stellar-jenkins commented Jan 13, 2026

Uh oh!

ElliotFriend left a comment

Choose a reason for hiding this comment

Uh oh!

ElliotFriend Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ElliotFriend Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

Uh oh!

stellar-jenkins commented Jan 15, 2026

Uh oh!

Reviewers