Add Bridge.Onramp functions + port old functions

.changeset/tidy-seas-sing.md

@@ -0,0 +1,79 @@
+---
+"thirdweb": patch
+---
+
+Added Bridge.Onramp.prepare and Bridge.Onramp.status functions
+
+## Bridge.Onramp.prepare
+
+Prepares an onramp transaction, returning a link from the specified provider to onramp to the specified token.
+
+```typescript
+import { Bridge } from "thirdweb";
+import { ethereum } from "thirdweb/chains";
+import { NATIVE_TOKEN_ADDRESS, toWei } from "thirdweb/utils";
+
+const preparedOnramp = await Bridge.Onramp.prepare({
+  client: thirdwebClient,
+  onramp: "stripe",
+  chainId: ethereum.id,
+  tokenAddress: NATIVE_TOKEN_ADDRESS,
+  receiver: "0x...", // receiver's address
+  amount: toWei("10"), // 10 of the destination token
+  // Optional params:
+  // sender: "0x...", // sender's address
+  // onrampTokenAddress: NATIVE_TOKEN_ADDRESS, // token to initially onramp to
+  // onrampChainId: 1, // chain to initially onramp to
+  // currency: "USD",
+  // maxSteps: 2,
+  // purchaseData: { customId: "123" }
+});
+
+console.log(preparedOnramp.link); // URL to redirect the user to
+console.log(preparedOnramp.destinationAmount); // Amount of token user will receive
+```
+
+## Bridge.Onramp.status
+
+Retrieves the status of an Onramp session created via Bridge.Onramp.prepare.
+
+```typescript
+import { Bridge } from "thirdweb";
+
+const onrampStatus = await Bridge.Onramp.status({
+  id: "022218cc-96af-4291-b90c-dadcb47571ec",
+  client: thirdwebClient,
+});
+
+// Possible results:
+// {
+//   status: "CREATED",
+//   transactions: [],
+//   purchaseData: {
+//     orderId: "abc-123",
+//   },
+// }
+//
+// or
+// {
+//   status: "PENDING",
+//   transactions: [],
+//   purchaseData: {
+//     orderId: "abc-123",
+//   },
+// }
+//
+// or
+// {
+//   status: "COMPLETED",
+//   transactions: [
+//     {
+//       chainId: 1,
+//       transactionHash: "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
+//     },
+//   ],
+//   purchaseData: {
+//     orderId: "abc-123",
+//   },
+// }
+```

apps/portal/src/app/pay/customization/payembed/page.mdx

@@ -92,7 +92,7 @@ You can specify which onramp provider to present to your users. By default, we c
 <PayEmbed
 	client={client}
 	payOptions={{
-		preferredProvider: "STRIPE" | "KADO" | "TRANSAK",
+		preferredProvider: "COINBASE" | "STRIPE" | "TRANSAK",
 	}}
 />
 ```

apps/portal/src/app/pay/customization/send-transaction/page.mdx

@@ -88,7 +88,7 @@ You can specify which onramp provider to present to your users. By default, we c
 ```tsx
 const { mutate: sendTransaction } = useSendTransaction({
 	payModal: {
-		preferredProvider: "STRIPE" | "KADO" | "TRANSAK",
+		preferredProvider: "COINBASE" | "STRIPE" | "TRANSAK",
 	},
 });
 ```

apps/portal/src/app/pay/testing-pay/page.mdx

@@ -16,7 +16,7 @@ Developers can turn on Test Mode to test both fiat-to-crypto transactions and cr
 
 ## Buy With Fiat
 
-By setting `testMode` to `true` for Buy With Fiat, you can enable test experiences for our underlying providers (Stripe, Kado, and Transak).
+By setting `testMode` to `true` for Buy With Fiat, you can enable test experiences for our underlying providers (Coinbase, Stripe, and Transak).
 
 <Tabs defaultValue="connectbutton">
 

packages/thirdweb/src/bridge/Onramp.test.ts

@@ -0,0 +1,118 @@
+import { toWei } from "src/utils/units.js";
+import { describe, expect, it } from "vitest";
+import { TEST_CLIENT } from "~test/test-clients.js";
+import * as Onramp from "./Onramp.js";
+
+// Use the same receiver address as other bridge tests
+const RECEIVER_ADDRESS = "0x2a4f24F935Eb178e3e7BA9B53A5Ee6d8407C0709";
+const NATIVE_TOKEN_ADDRESS = "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+
+/**
+ * These tests call the real Bridge Onramp API. They are executed only when a
+ * `TW_SECRET_KEY` environment variable is present, mirroring the behaviour of
+ * the other bridge tests in this package.
+ */
+describe.runIf(process.env.TW_SECRET_KEY)("Bridge.Onramp.prepare", () => {
+  it("should prepare an onramp successfully", async () => {
+    const prepared = await Onramp.prepare({
+      client: TEST_CLIENT,
+      onramp: "stripe",
+      chainId: 1,
+      tokenAddress: NATIVE_TOKEN_ADDRESS,
+      receiver: RECEIVER_ADDRESS,
+      amount: toWei("0.01"),
+    });
+
+    expect(prepared).toBeDefined();
+
+    // The destinationAmount should be a bigint and greater than zero
+    expect(typeof prepared.destinationAmount).toBe("bigint");
+    expect(prepared.destinationAmount > 0n).toBe(true);
+
+    // A redirect link for the user should be provided
+    expect(prepared.link).toBeDefined();
+    expect(typeof prepared.link).toBe("string");
+
+    // Intent must be present and reference the correct receiver
+    expect(prepared.intent).toBeDefined();
+    expect(prepared.intent.receiver.toLowerCase()).toBe(
+      RECEIVER_ADDRESS.toLowerCase(),
+    );
+
+    // Steps array should be defined (it may be empty if the provider supports the destination token natively)
+    expect(Array.isArray(prepared.steps)).toBe(true);
+  });
+
+  it("should surface any errors", async () => {
+    await expect(
+      Onramp.prepare({
+        client: TEST_CLIENT,
+        onramp: "stripe",
+        chainId: 444, // Unsupported chain ID
+        tokenAddress: NATIVE_TOKEN_ADDRESS,
+        receiver: RECEIVER_ADDRESS,
+        amount: toWei("0.01"),
+      }),
+    ).rejects.toThrowError();
+  });
+
+  it("should prepare a Coinbase onramp successfully", async () => {
+    const prepared = await Onramp.prepare({
+      client: TEST_CLIENT,
+      onramp: "coinbase",
+      chainId: 1,
+      tokenAddress: NATIVE_TOKEN_ADDRESS,
+      receiver: RECEIVER_ADDRESS,
+      amount: toWei("0.01"),
+    });
+
+    expect(prepared).toBeDefined();
+
+    // The destinationAmount should be a bigint and greater than zero
+    expect(typeof prepared.destinationAmount).toBe("bigint");
+    expect(prepared.destinationAmount > 0n).toBe(true);
+
+    // A redirect link for the user should be provided
+    expect(prepared.link).toBeDefined();
+    expect(typeof prepared.link).toBe("string");
+
+    // Intent must be present and reference the correct receiver
+    expect(prepared.intent).toBeDefined();
+    expect(prepared.intent.receiver.toLowerCase()).toBe(
+      RECEIVER_ADDRESS.toLowerCase(),
+    );
+
+    // Steps array should be defined (it may be empty if the provider supports the destination token natively)
+    expect(Array.isArray(prepared.steps)).toBe(true);
+  });
+
+  it("should prepare a Transak onramp successfully", async () => {
+    const prepared = await Onramp.prepare({
+      client: TEST_CLIENT,
+      onramp: "transak",
+      chainId: 1,
+      tokenAddress: NATIVE_TOKEN_ADDRESS,
+      receiver: RECEIVER_ADDRESS,
+      amount: toWei("0.01"),
+    });
+
+    expect(prepared).toBeDefined();
+
+    // The destinationAmount should be a bigint and greater than zero
+    expect(typeof prepared.destinationAmount).toBe("bigint");
+    expect(prepared.destinationAmount > 0n).toBe(true);
+
+    // A redirect link for the user should be provided
+    expect(prepared.link).toBeDefined();
+    expect(typeof prepared.link).toBe("string");
+
+    // Intent must be present and reference the correct receiver
+    expect(prepared.intent).toBeDefined();
+    expect(prepared.intent.receiver.toLowerCase()).toBe(
+      RECEIVER_ADDRESS.toLowerCase(),
+    );
+
+    // Steps array should be defined (it may be empty if the provider supports the destination token natively)
+    expect(Array.isArray(prepared.steps)).toBe(true);
+  });
+});