Skip to content

Commit 761417c

Browse files
[Documentation] Feature: Unreal Docs (#5363)
## Problem solved Updated Docs for Unreal Engine <!-- start pr-codex --> --- ## PR-Codex overview This PR primarily updates the `@dirtycajunrice/klee` dependency, enhances the sidebar structure for Unreal Engine blueprints, and adds new functionalities for building hrefs and contract interactions in the application. ### Detailed summary - Updated `@dirtycajunrice/klee` from `^1.0.1` to `^1.0.5`. - Introduced `hrefBuilder` function in `util.ts` to construct href links. - Added `blueprints` and `cpp` link groups in the sidebar. - Updated various blueprint pages with new content and structure. - Enhanced contract interaction nodes for reading and writing contracts. > The following files were skipped due to too many changes: `apps/portal/src/app/unreal-engine/blueprints/engine/nodes.ts`, `apps/portal/src/app/unreal-engine/blueprints/in-app-wallet/nodes.ts`, `apps/portal/src/app/unreal-engine/blueprints/smart-wallet/nodes.ts` > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
1 parent f331f01 commit 761417c

File tree

14 files changed

+739
-757
lines changed

14 files changed

+739
-757
lines changed

apps/portal/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"extract-search-data": "pnpm tsx scripts/extractSearchData.ts"
1717
},
1818
"dependencies": {
19-
"@dirtycajunrice/klee": "^1.0.1",
19+
"@dirtycajunrice/klee": "^1.0.5",
2020
"@mdx-js/loader": "^2.3.0",
2121
"@mdx-js/react": "^2.3.0",
2222
"@next/mdx": "15.0.3",

apps/portal/src/app/unreal-engine/blueprints/engine/nodes.ts

Lines changed: 200 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import { Blueprint } from "../blueprint";
2+
import { getTransactionReceiptNode, getTransactionStatusNode, readContractNode, writeContractNode } from "./nodes";
3+
import { createUnrealEngineMetadata } from "../../util";
4+
5+
export const metadata = createUnrealEngineMetadata({ title: "Engine", description: "Engine Blueprints" });
6+
7+
# Engine
8+
9+
## Contract Interaction
10+
11+
### Read Contract
12+
Call the Read Contract endpoint on an engine instance.
13+
<Blueprint code={readContractNode} className='w-full h-48' />
14+
15+
### Write Contract
16+
Call the Write Contract endpoint on an engine instance.
17+
<Blueprint code={writeContractNode} className='w-full h-64' />
18+
19+
### Get Transaction Status
20+
Get the transaction Status of a queue id from an engine instance.
21+
<Blueprint code={getTransactionStatusNode} className='w-full h-48' />
22+
23+
### Get Transaction Receipt
24+
Get the transaction receipt of a transaction hash from a chain.
25+
<Blueprint code={getTransactionReceiptNode} className='w-full h-48' />

apps/portal/src/app/unreal-engine/blueprints/in-app-wallet/nodes.ts

Lines changed: 97 additions & 358 deletions
Large diffs are not rendered by default.

apps/portal/src/app/unreal-engine/blueprints/in-app-wallet/page.mdx

Lines changed: 15 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
11
import { Blueprint } from "../blueprint";
22
import {
3-
createAuthEndpointWalletNode,
4-
createEmailWalletNode,
5-
createGuestWalletNode,
6-
createJwtWalletNode,
7-
createOAuthWalletNode,
8-
createPhoneWalletNode, disconnectNode,
3+
createWalletNode,
4+
disconnectNode,
95
fetchOAuthLoginLinkNode,
106
isConnectedNode,
7+
linkWalletNode,
118
sendOtpNode,
12-
signInWithGuestNode,
13-
signInWithJwtNode,
14-
signInWithOAuthNode,
15-
verifyOtpNode,
9+
signInNode,
1610
} from "./nodes";
1711
import { createUnrealEngineMetadata } from "../../util";
1812

@@ -23,64 +17,30 @@ export const metadata = createUnrealEngineMetadata({
2317

2418
# In-App Wallets
2519

26-
## OTP
20+
### Create Wallet
21+
Creates an in-app wallet based on inputs.
22+
<Blueprint code={createWalletNode} className='w-full h-48' />
23+
24+
### Sign In
25+
Sign in, passing the required input if OTP, JWT, or Auth Endpoint
26+
<Blueprint code={signInNode} className='w-full h-40' />
2727

28-
### Create Email Wallet
29-
Creates an in-app email wallet.
30-
<Blueprint code={createEmailWalletNode} className='w-full h-48' />
28+
### Link Wallet
29+
Link a new auth method with a created - but never signed in - wallet
30+
<Blueprint code={linkWalletNode} className='w-full h-40' />
3131

32-
### Create Phone Wallet
33-
Creates an in-app phone wallet.
34-
<Blueprint code={createPhoneWalletNode} className='w-full h-48' />
32+
## OTP
3533

3634
### Send OTP
3735
Sends an OTP for the in-app wallet.
3836
<Blueprint code={sendOtpNode} className='w-full h-40' />
3937

40-
### Verify OTP
41-
Verifies an OTP for the in-app wallet.
42-
<Blueprint code={verifyOtpNode} className='w-full h-40' />
43-
4438
## OAuth
4539

46-
### Create OAuth Wallet
47-
Creates an in-app OAuth wallet using the specified provider.
48-
<Blueprint code={createOAuthWalletNode} className='w-full h-48' />
49-
5040
### Fetch OAuth login link
5141
Fetches the OAuth login link for the in-app wallet.
5242
<Blueprint code={fetchOAuthLoginLinkNode} className='w-full h-40' />
5343

54-
### Sign In With OAuth
55-
Sign in with the OAuth payload from your login flow.
56-
<Blueprint code={signInWithOAuthNode} className='w-full h-32' />
57-
58-
## Custom
59-
60-
### Create JWT Wallet
61-
Creates an in-app JWT wallet.
62-
<Blueprint code={createJwtWalletNode} className='w-full h-48' />
63-
64-
### Sign In With JWT
65-
Sign in with the OAuth payload from your login flow.
66-
<Blueprint code={signInWithJwtNode} className='w-full h-32' />
67-
68-
### Create Auth Endpoint Wallet
69-
Creates an in-app Auth Endpoint wallet.
70-
<Blueprint code={createAuthEndpointWalletNode} className='w-full h-48' />
71-
72-
### Sign In With Auth Endpoint
73-
Sign in with the OAuth payload from your login flow.
74-
<Blueprint code={signInWithJwtNode} className='w-full h-32' />
75-
76-
### Create Guest Wallet
77-
Creates an in-app Guest wallet.
78-
<Blueprint code={createGuestWalletNode} className='w-full h-48' />
79-
80-
### Sign In With Guest
81-
Sign in with the OAuth payload from your login flow.
82-
<Blueprint code={signInWithGuestNode} className='w-full h-32' />
83-
8444
## Utilities
8545

8646
### Is Connected
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
import { hrefBuilder } from "@/app/unreal-engine/util";
2+
import type { LinkGroup } from "@/components/others/Sidebar";
3+
4+
export const blueprints: LinkGroup = hrefBuilder("/blueprints", {
5+
name: "Blueprints",
6+
isCollapsible: true,
7+
links: [
8+
{
9+
name: "Overview",
10+
href: "",
11+
},
12+
{
13+
name: "In App Wallets",
14+
href: "/in-app-wallet",
15+
},
16+
{
17+
name: "Smart Wallets",
18+
href: "/smart-wallet",
19+
},
20+
{
21+
name: "Engine",
22+
href: "/engine",
23+
},
24+
{
25+
name: "Utilities",
26+
href: "/utilities",
27+
},
28+
],
29+
});

apps/portal/src/app/unreal-engine/blueprints/smart-wallet/nodes.ts

Lines changed: 255 additions & 243 deletions
Large diffs are not rendered by default.

apps/portal/src/app/unreal-engine/blueprints/smart-wallet/page.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,32 +25,32 @@ Creates an in-app email wallet.
2525

2626
### Is Deployed
2727
Checks if the smart wallet is deployed.
28-
<Blueprint code={isDeployedNode} className='w-full h-40' />
28+
<Blueprint code={isDeployedNode} className='w-full h-48' />
2929

3030
### Create Session Key
3131
Creates a session key for the smart wallet.
3232
<Blueprint code={createSessionKeyNode} className='w-full h-60' />
3333

3434
### Get Admins
3535
Retrieves the list of admins for the smart wallet.
36-
<Blueprint code={getAdminsNode} className='w-full h-40' />
36+
<Blueprint code={getAdminsNode} className='w-full h-48' />
3737

3838
### Get Active Signers
3939
Retrieves the list of active signers for the smart wallet.
40-
<Blueprint code={getActiveSignersNode} className='w-full h-40' />
40+
<Blueprint code={getActiveSignersNode} className='w-full h-48' />
4141

4242
### Is Active Signer
4343
Checks to see if a specific signer is valid
44-
<Blueprint code={isActiveSignerNode} className='w-full h-32' />
44+
<Blueprint code={isActiveSignerNode} className='w-full h-48' />
4545

4646
### Revoke Session Key
4747
Revokes a session key for a smart wallet signer.
48-
<Blueprint code={revokeSessionKeyNode} className='w-full h-32' />
48+
<Blueprint code={revokeSessionKeyNode} className='w-full h-48' />
4949

5050
### Add Admin
5151
Adds an admin signer to the smart wallet.
52-
<Blueprint code={addAdminNode} className='w-full h-32' />
52+
<Blueprint code={addAdminNode} className='w-full h-48' />
5353

5454
### Remove Admin
5555
Removes an admin signer from the smart wallet.
56-
<Blueprint code={removeAdminNode} className='w-full h-32' />
56+
<Blueprint code={removeAdminNode} className='w-full h-48' />

0 commit comments

Comments
 (0)