Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Simple example

The simple example shows how to wire up a basic Relay layout with a header, sidebar, and footer so you can see how the pieces fit together before customizing anything. It pulls in the sample SimpleExample component along with the related layout fragments below, which together demonstrate the standard structure for a Relay application page.

Header
Status: Idle

Sidebar

Footer

relays.ts

import { createRelay } from "@0xhq/relay";
 
/**
 * @dev MyRelay.
 */
type MyRelayConfig = {};
 
type MyRelayStepBase = {
	label: string;
};
 
type MyRelayStepTransactionSuccess = {
	type: "transaction";
	txHash: string;
	blockNumber: number;
};
 
type MyRelayStepApiCallSuccess = {
	type: "apicall";
};
 
type MyRelayStepSuccess = MyRelayStepTransactionSuccess | MyRelayStepApiCallSuccess;
 
type MyRelayStepError = {
	message: string;
};
 
const myRelay = createRelay<MyRelayConfig, MyRelayStepBase, MyRelayStepSuccess, MyRelayStepError>("my-relay");
 
export { myRelay };

index.tsx

import { App } from "./app";
 
import { Footer } from "./footer";
import { Header } from "./header";
import { Sidebar } from "./sidebar";
 
/**
 * @dev Simple Example.
 */
const SimpleExample = () => {
	return (
		<div className="bg-black/50 p-2 rounded flex flex-col gap-10">
			<Header />
 
			<div className="flex justify-between">
				<App />
				<Sidebar />
			</div>
 
			<Footer />
		</div>
	);
};
 
export { SimpleExample };

header.tsx

import { myRelay } from "./relays";
 
/**
 * @dev Header.
 */
const Header = () => {
	const { isRunning } = myRelay.useRelay();
 
	return (
		<div className="bg-white/10 px-2 rounded">
			<div className="flex justify-between">
				<div>Header</div>
				<div>Status: {isRunning ? "Running" : "Idle"}</div>
			</div>
		</div>
	);
};
 
export { Header };

sidebar.tsx

import { myRelay } from "./relays";
 
/**
 * @dev Sidebar.
 */
const Sidebar = () => {
	const { stepsBase, stepsState } = myRelay.useRelay();
 
	return (
		<div className="bg-slate-600">
			<h4 className="underline">Sidebar</h4>
 
			{stepsBase.map((item, index) => {
				const state = stepsState[index];
 
				return (
					<div className="flex gap-2" key={item.id}>
						<div>{item.label}</div>
 
						{(() => {
							if (state.status === "success") {
								const payload = state.payload;
 
								if (payload.type === "apicall") {
									return <div>Success</div>;
								}
 
								if (payload.type === "transaction") {
									return (
										<div className="flex gap-2">
											<div>{payload.txHash}</div>
											<div>{payload.blockNumber}</div>
										</div>
									);
								}
							}
 
							if (state.status === "error") {
								return <div>{state.payload.message}</div>;
							}
 
							return <div>{state.status}</div>;
						})()}
					</div>
				);
			})}
		</div>
	);
};
 
export { Sidebar };

app.tsx

import { myRelay } from "./relays";
 
/**
 * @dev Create steps.
 */
const steps = [
	myRelay.createRelayStep({
		id: "id-0",
		label: "API call",
		fn: async () => {
			await new Promise((resolve) => setTimeout(resolve, 1000));
			return myRelay.StepSuccess({ type: "apicall" });
		},
	}),
	myRelay.createRelayStep({
		id: "id-1",
		label: "Send Tx",
		fn: async () => {
			await new Promise((resolve) => setTimeout(resolve, 1000));
			return myRelay.StepSuccess({
				type: "transaction",
				txHash: "0x",
				blockNumber: 100_000_000,
			});
		},
	}),
	myRelay.createRelayStep({
		id: "id-2",
		label: "API call",
		fn: async () => {
			await new Promise((resolve) => setTimeout(resolve, 1000));
			return myRelay.StepSuccess({ type: "apicall" });
		},
	}),
];
 
/**
 * @dev App.
 */
const App = () => {
	const { initialize, start, reset, canStart, canInitialize } = myRelay.useRelay();
 
	return (
		<div className="flex gap-4">
			<div className={!canInitialize ? "opacity-50 pointer-events-none" : ""}>
				<button
					type="button"
					className="bg-cyan-500/20 text-cyan-500 rounded px-2"
					onClick={() => {
						initialize(steps);
					}}
				>
					Initialize
				</button>
			</div>
 
			<div className={!canStart ? "opacity-50 pointer-events-none" : ""}>
				<button
					type="button"
					className="bg-amber-500/20 text-amber-500 rounded px-2"
					onClick={() => {
						start();
					}}
				>
					Start
				</button>
			</div>
 
			<div>
				<button
					type="button"
					className="bg-purple-500/20 text-purple-500 rounded px-2"
					onClick={() => {
						reset();
					}}
				>
					Reset
				</button>
			</div>
		</div>
	);
};
 
export { App };

footer.tsx

/**
 * @dev Footer.
 */
const Footer = () => {
	return <div className="bg-white/10 px-2 rounded">Footer</div>;
};
 
export { Footer };