Skip to content

Commit d410854

Browse files
Enhancements to Unity/Unreal Ecosystem Setup steps (#207)
* enhancements to unity/unreal ecosystem setup steps * chore(i18n): update translations [en] Sync file structure, format locales. Branch: 207/merge --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 18127c7 commit d410854

File tree

7 files changed

+244
-44
lines changed

7 files changed

+244
-44
lines changed

es/sdk/unity/wallets/ecosystem-wallet/setup.mdx

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,48 @@ sidebarTitle: Configuración
88
<Step title={"Configure your Unity Project"}>
99
Inicie sesión y cree un proyecto en [Sequence Builder](https://sequence.build).
1010

11-
Descargue su archivo de configuración desde Builder como se muestra a continuación.
11+
A continuación, cree un ScriptableObject SequenceConfig en Unity: `Assets` > `Create` > `Sequence` > `SequenceConfig` y colóquelo dentro de su directorio `Resources`.
1212

13-
<Frame>
14-
<img src="/images/unity/builder_config_file.png" />
15-
</Frame>
16-
17-
Asegúrese de tener los campos requeridos:
13+
Asegúrese de ingresar los campos requeridos:
1814

1915
- **Builder API Key:** Su clave de acceso al proyecto desde su [proyecto en Builder.](https://sequence.build/)
2016
- **Wallet App Url:** La URL del Ecosistema al que desea conectarse. Si no está seguro, use `https://v3.sequence-dev.app` como valor predeterminado.
2117
</Step>
2218

23-
<Step title={"Try our Built-In Demo"}>
24-
Importe el ejemplo `Ecosystem Wallet Demo` desde el Package Manager de Unity. Además, revise nuestro script base
25-
`SequenceEcosystemWalletWindow` para ver detalles de integración.
19+
<Step title={"Create your own Sign-In flow"}>
20+
Opcionalmente, puede obtener los proveedores de autenticación configurados directamente desde el Ecosystem y verificar si su método de autenticación objetivo, como Email o Google, está soportado.
21+
Ahora, llamemos a un método de autenticación como Google. Esto redirigirá al usuario a un navegador externo para autenticarse con el Ecosystem.
22+
23+
Tiene dos opciones para autenticarse. Puede crear una sesión implícita o explícita. Se crea una sesión implícita dejando vacío el campo `Permissions`.
24+
La sesión implícita solo permitirá transacciones a contratos del Ecosystem. Para este demo, en su lugar, creemos una sesión explícita para un contrato específico.
25+
26+
```csharp
27+
// Let's create the permissions object
28+
Chain chain = Chain.TestnetAbitrumSepolia;
29+
Address contractAddress = new Address("0x33985d320809E26274a72E03268c8a29927Bc6dA");
30+
BigInteger deadline = new BigInteger(DateTimeOffset.UtcNow.ToUnixTimeSeconds() * 1000 + 1000 * 60 * 5000);
31+
BigInteger valueLimit = 0;
32+
33+
IPermissions permissions = new ContractPermissions(chain, contractAddress, deadline, valueLimit);
34+
35+
// Let's call the Sign-In method
36+
SequenceConnect connect = new SequenceConnect();
37+
IWallet wallet = await connect.SignInWithGoogle(permissions);
38+
39+
// Optionally, get the Ecosystem config to check your auth providers
40+
EcosystemConfig config = await connect.GetEcosystemConfig();
41+
```
42+
</Step>
43+
44+
<Step title={"Try our Built-In Demo (optional)"}>
45+
Importe el ejemplo `Demo` desde el Package Manager de Unity. Además, revise nuestro script base
46+
[EcosystemWalletLoginWindow](https://github.com/0xsequence/sequence-unity/blob/master/Packages/Sequence-Unity/Sequence/SequenceBoilerplates/Scripts/EcosystemWallet/EcosystemWalletLoginWindow.cs) para detalles de integración.
47+
48+
Puede usar este Boilerplate dentro de su proyecto después de importar los Demo Samples. Luego, simplemente llame a esta función:
49+
`BoilerplateFactory.OpenEcosystemWalletLogin(parent)`
2650

27-
Si ha instalado el SDK como un archivo `.unitypackage`, por favor ubique la escena Demo en la ventana `Project` de Unity, bajo `Packages > Sequence Embedded Wallet SDK > Sequence > Samples > Demo`
51+
Si ha instalado el SDK como un archivo `.unitypackage`, por favor ubique la escena Demo dentro de
52+
la ventana `Project` de Unity bajo `Packages > Sequence SDK > Sequence > Samples > Demo`
2853

2954
<Frame>
3055
<img src="/images/unity/ecosystem-wallet-demo.png" />

es/sdk/unreal/wallets/ecosystem-wallet/setup.mdx

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,19 @@ sidebarTitle: Configuración
88
<Step title={"Configure your Unreal Project"}>
99
Cree un proyecto en [Sequence Builder](https://sequence.build) y descargue su archivo de configuración como se muestra a continuación.
1010

11-
<Frame>
12-
<img src="/images/unreal/builder_config_file.png" />
13-
</Frame>
11+
A continuación, cree un archivo `SequenceConfig.ini` y colóquelo dentro del directorio `Config` de su proyecto de Unreal. Pegue el siguiente contenido en el archivo SequenceConfig.ini:
12+
13+
```
14+
[/Script/Sequence.Config]
15+
DefaultChain = "421614" // Arbitrum Sepolia
16+
ProjectAccessKey = "<Get your access key from https://sequence.build/>"
17+
WalletAppUrl = "https://v3.sequence-dev.app"
18+
UrlScheme = "your-scheme"
19+
```
1420

1521
Asegúrese de que su archivo de configuración incluya los campos requeridos:
1622

23+
- **DefaultChain:** El chain id que desea usar por defecto. También puede [cambiar el chain id en tiempo de ejecución](/sdk/unreal/indexer/read-from-blockchain#set-chain-by-id) más adelante.
1724
- **ProjectAccessKey:** Su Project Access Key de su [proyecto en Builder.](https://sequence.build/)
1825
- **WalletAppUrl:** La URL del Ecosistema al que desea conectarse. Si no está seguro, use `https://v3.sequence-dev.app` como valor predeterminado.
1926

@@ -22,8 +29,44 @@ sidebarTitle: Configuración
2229
- **UrlScheme:** También debe configurar esto en su Android Manifest y en su proyecto de Xcode.
2330
</Step>
2431

25-
<Step title={"Try our Built-In Demo"}>
26-
El Unreal SDK incluye un conjunto de widgets prediseñados para que pueda comenzar rápidamente.
32+
<Step title={"Create your own Sign-In flow"}>
33+
Opcionalmente, puede obtener los proveedores de autenticación configurados directamente desde el Ecosystem y verificar si su método de autenticación objetivo, como Email o Google, está soportado.
34+
Ahora, llamemos a un método de autenticación como Google. Esto redirigirá al usuario a un navegador externo para autenticarse con el Ecosystem.
35+
36+
Tiene dos opciones para autenticarse. Puede crear una sesión implícita o explícita. Se crea una sesión implícita dejando vacío el campo `Permissions`.
37+
La sesión implícita solo permitirá transacciones a contratos del Ecosystem. Para este demo, en su lugar, creemos una sesión explícita para un contrato específico.
38+
39+
<Tabs>
40+
<Tab title="Blueprint">
41+
<Frame>
42+
<img src="/images/unreal/ecosystem/ecosystem_auth_demo.png" />
43+
</Frame>
44+
</Tab>
45+
46+
<Tab title="C++">
47+
```cpp
48+
// Create the permissions object
49+
const FString Target = TEXT("0x33985d320809E26274a72E03268c8a29927Bc6dA");
50+
const int64 ChainId = 421614;
51+
const int64 Deadline = 1856724472000;
52+
const int64 ValueLimit = 0;
53+
54+
UContractPermissions* Permissions = UContractPermissions::CreateContractPermissions(ChainId, Target, Deadline, ValueLimit);
55+
56+
// Let's call the Sign-in method
57+
const TSuccessCallback<bool> SuccessCallback = [OnSuccess](const bool& Result) { };
58+
const FFailureCallback FailureCallback = [OnFailure](const FSequenceError& Error) { };
59+
60+
USequenceConnect* Connect = NewObject<USequenceConnect>();
61+
Connect->GetEcosystemConfig(...);
62+
Connect->SignInWithGoogle(Permissions, SuccessCallback, FailureCallback);
63+
```
64+
</Tab>
65+
</Tabs>
66+
</Step>
67+
68+
<Step title={"Try our Built-In Demo (optional)"}>
69+
El SDK de Unreal incluye un conjunto de [widgets base](/sdk/unreal/bootstrap) para que pueda comenzar rápidamente.
2770
Asegúrese de habilitar `Enable Plugin Content` en la configuración de su Content Browser.
2871

2972
<Frame>
368 KB
Loading

ja/sdk/unity/wallets/ecosystem-wallet/setup.mdx

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,46 @@ sidebarTitle: セットアップ
88
<Step title={"Configure your Unity Project"}>
99
[Sequence Builder](https://sequence.build) にサインインし、プロジェクトを作成します。
1010

11-
下記の手順で Builder から設定ファイルをダウンロードしてください
11+
次に、UnityでSequenceConfigのScriptableObjectを作成します:`Assets` > `Create` > `Sequence` > `SequenceConfig` を選択し、`Resources` ディレクトリ内に配置してください
1212

13-
<Frame>
14-
<img src="/images/unity/builder_config_file.png" />
15-
</Frame>
16-
17-
必要なフィールドが揃っていることを確認してください。
13+
必要な項目を必ず入力してください:
1814

1915
- **Builder API キー:** [Builder プロジェクト](https://sequence.build/)から取得したプロジェクトアクセスキー。
2016
- **Wallet App Url:** 接続したいエコシステムの URL。不明な場合は、デフォルトで `https://v3.sequence-dev.app` をご利用ください。
2117
</Step>
2218

23-
<Step title={"Try our Built-In Demo"}>
24-
Unity のパッケージマネージャーから `Ecosystem Wallet Demo` サンプルをインポートしてください。また、統合の詳細については、ボイラープレートスクリプト `SequenceEcosystemWalletWindow` もご参照ください。
19+
<Step title={"Create your own Sign-In flow"}>
20+
必要に応じて、Ecosystemから設定済みの認証プロバイダーを取得し、EmailやGoogleなど、目的の認証方法がサポートされているか確認できます。
21+
次に、Googleなどの認証方法を呼び出してみましょう。これにより、ユーザーは外部ブラウザにリダイレクトされ、Ecosystemで認証されます。
22+
23+
認証方法は2つあります。暗黙的セッションまたは明示的セッションを作成できます。`Permissions` フィールドにノードを渡さないことで暗黙的セッションを作成します。
24+
暗黙的セッションでは、Ecosystem内のコントラクトへのトランザクションのみ許可されます。このデモでは、特定のコントラクト用に明示的セッションを作成してみましょう。
25+
26+
```csharp
27+
// Let's create the permissions object
28+
Chain chain = Chain.TestnetAbitrumSepolia;
29+
Address contractAddress = new Address("0x33985d320809E26274a72E03268c8a29927Bc6dA");
30+
BigInteger deadline = new BigInteger(DateTimeOffset.UtcNow.ToUnixTimeSeconds() * 1000 + 1000 * 60 * 5000);
31+
BigInteger valueLimit = 0;
32+
33+
IPermissions permissions = new ContractPermissions(chain, contractAddress, deadline, valueLimit);
34+
35+
// Let's call the Sign-In method
36+
SequenceConnect connect = new SequenceConnect();
37+
IWallet wallet = await connect.SignInWithGoogle(permissions);
38+
39+
// Optionally, get the Ecosystem config to check your auth providers
40+
EcosystemConfig config = await connect.GetEcosystemConfig();
41+
```
42+
</Step>
43+
44+
<Step title={"Try our Built-In Demo (optional)"}>
45+
Unityのパッケージマネージャーから`Demo`サンプルをインポートしてください。また、統合の詳細については、弊社のボイラープレートスクリプト [EcosystemWalletLoginWindow](https://github.com/0xsequence/sequence-unity/blob/master/Packages/Sequence-Unity/Sequence/SequenceBoilerplates/Scripts/EcosystemWallet/EcosystemWalletLoginWindow.cs) もご覧ください。
46+
47+
Demoサンプルをインポートした後、このボイラープレートをプロジェクト内で利用できます。次の関数を呼び出すだけです:
48+
`BoilerplateFactory.OpenEcosystemWalletLogin(parent)`
2549

26-
SDKを`.unitypackage`ファイルとしてインストールした場合は、Unityの`Project`ウィンドウで`Packages > Sequence Embedded Wallet SDK > Sequence > Samples > Demo`内にあるデモシーンを探してください
50+
SDKを`.unitypackage`ファイルとしてインストールした場合は、Unityの`Project`ウィンドウで `Packages > Sequence SDK > Sequence > Samples > Demo` 内にあるDemoシーンを探してください
2751

2852
<Frame>
2953
<img src="/images/unity/ecosystem-wallet-demo.png" />

ja/sdk/unreal/wallets/ecosystem-wallet/setup.mdx

Lines changed: 49 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,19 @@ sidebarTitle: セットアップ
88
<Step title={"Configure your Unreal Project"}>
99
[Sequence Builder](https://sequence.build)でプロジェクトを作成し、下記のように設定ファイルをダウンロードしてください。
1010

11-
<Frame>
12-
<img src="/images/unreal/builder_config_file.png" />
13-
</Frame>
11+
次に、`SequenceConfig.ini`ファイルを作成し、Unrealプロジェクトの`Config`ディレクトリ内に配置します。以下の内容をSequenceConfig.iniファイルに貼り付けてください:
12+
13+
```
14+
[/Script/Sequence.Config]
15+
DefaultChain = "421614" // Arbitrum Sepolia
16+
ProjectAccessKey = "<Get your access key from https://sequence.build/>"
17+
WalletAppUrl = "https://v3.sequence-dev.app"
18+
UrlScheme = "your-scheme"
19+
```
1420

1521
設定ファイルに必要な項目が含まれていることを確認してください。
1622

23+
- **DefaultChain:** デフォルトで使用したいチェーンIDです。後から[実行時にチェーンIDを変更](/sdk/unreal/indexer/read-from-blockchain#set-chain-by-id)することも可能です。
1724
- **ProjectAccessKey:** [Builder プロジェクト](https://sequence.build/)から取得したプロジェクトアクセスキーです。
1825
- **WalletAppUrl:** 接続したいエコシステムのURLです。不明な場合は、デフォルトとして `https://v3.sequence-dev.app` をご利用ください。
1926

@@ -22,9 +29,45 @@ sidebarTitle: セットアップ
2229
- **UrlScheme:** これはAndroidのマニフェストとXcodeプロジェクトの両方で設定する必要があります。
2330
</Step>
2431

25-
<Step title={"Try our Built-In Demo"}>
26-
Unreal SDK には、すぐに使えるウィジェットがセットで付属しています。
27-
Content Browser の設定で「Enable Plugin Content」を有効にしてください。
32+
<Step title={"Create your own Sign-In flow"}>
33+
必要に応じて、Ecosystemから設定済みの認証プロバイダーを取得し、EmailやGoogleなど、目的の認証方法がサポートされているか確認できます。
34+
次に、Googleなどの認証方法を呼び出してみましょう。これにより、ユーザーは外部ブラウザにリダイレクトされ、Ecosystemで認証されます。
35+
36+
認証方法は2つあります。暗黙的セッションまたは明示的セッションを作成できます。`Permissions` フィールドにノードを渡さないことで暗黙的セッションを作成します。
37+
暗黙的セッションでは、Ecosystem内のコントラクトへのトランザクションのみ許可されます。このデモでは、特定のコントラクト用に明示的セッションを作成してみましょう。
38+
39+
<Tabs>
40+
<Tab title="ブループリント">
41+
<Frame>
42+
<img src="/images/unreal/ecosystem/ecosystem_auth_demo.png" />
43+
</Frame>
44+
</Tab>
45+
46+
<Tab title="C++">
47+
```cpp
48+
// Create the permissions object
49+
const FString Target = TEXT("0x33985d320809E26274a72E03268c8a29927Bc6dA");
50+
const int64 ChainId = 421614;
51+
const int64 Deadline = 1856724472000;
52+
const int64 ValueLimit = 0;
53+
54+
UContractPermissions* Permissions = UContractPermissions::CreateContractPermissions(ChainId, Target, Deadline, ValueLimit);
55+
56+
// Let's call the Sign-in method
57+
const TSuccessCallback<bool> SuccessCallback = [OnSuccess](const bool& Result) { };
58+
const FFailureCallback FailureCallback = [OnFailure](const FSequenceError& Error) { };
59+
60+
USequenceConnect* Connect = NewObject<USequenceConnect>();
61+
Connect->GetEcosystemConfig(...);
62+
Connect->SignInWithGoogle(Permissions, SuccessCallback, FailureCallback);
63+
```
64+
</Tab>
65+
</Tabs>
66+
</Step>
67+
68+
<Step title={"Try our Built-In Demo (optional)"}>
69+
Unreal SDKには、すぐに使える[ボイラープレートウィジェット](/sdk/unreal/bootstrap)が用意されています。
70+
Content Browserの設定で`Enable Plugin Content`を有効にしてください。
2871

2972
<Frame>
3073
<img src="/images/unreal/ecosystem/ecosystem-wallet-demo.png" />

sdk/unity/wallets/ecosystem-wallet/setup.mdx

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,46 @@ sidebarTitle: Setup
88
<Step title={"Configure your Unity Project"}>
99
Sign in and create a project on [Sequence Builder](https://sequence.build).
1010

11-
Download your config file from Builder as shown below.
12-
<Frame>
13-
<img src="/images/unity/builder_config_file.png" />
14-
</Frame>
11+
Next, create a SequenceConfig ScriptableObject in Unity: `Assets` > `Create` > `Sequence` > `SequenceConfig` and place it inside your `Resources` directory.
1512

16-
Make sure you have the required fields:
13+
Make sure you insert the required fields:
1714

1815
- **Builder API Key:** Your Project Access Key from your [Builder project.](https://sequence.build/)
1916
- **Wallet App Url:** The URL of the Ecosystem you want to connect to. If you are unsure, use `https://v3.sequence-dev.app` as a default.
2017
</Step>
21-
<Step title={"Try our Built-In Demo"}>
22-
Import the `Ecosystem Wallet Demo` sample from Unity's Package Manager. Additionally, checkout our boilerplate
23-
script `SequenceEcosystemWalletWindow` for integration details.
18+
<Step title={"Create your own Sign-In flow"}>
19+
You can optionally get the configured auth providers from the Ecosystem directly and check if your target auth method, like Email or Google, is supported.
20+
Next, let's call an auth method like Google. This will redirect the user to an external browser to authenticate against the Ecosystem.
21+
22+
You have two options to authenticate. You either create an implicit- or explicit session. You create an implicit session by passing no node to the `Permissions` field.
23+
Implicit session will only allow transactions to contracts from the Ecosystem. For this demo, let's instead create an explicit session for a specific contract.
24+
25+
```csharp
26+
// Let's create the permissions object
27+
Chain chain = Chain.TestnetAbitrumSepolia;
28+
Address contractAddress = new Address("0x33985d320809E26274a72E03268c8a29927Bc6dA");
29+
BigInteger deadline = new BigInteger(DateTimeOffset.UtcNow.ToUnixTimeSeconds() * 1000 + 1000 * 60 * 5000);
30+
BigInteger valueLimit = 0;
31+
32+
IPermissions permissions = new ContractPermissions(chain, contractAddress, deadline, valueLimit);
33+
34+
// Let's call the Sign-In method
35+
SequenceConnect connect = new SequenceConnect();
36+
IWallet wallet = await connect.SignInWithGoogle(permissions);
37+
38+
// Optionally, get the Ecosystem config to check your auth providers
39+
EcosystemConfig config = await connect.GetEcosystemConfig();
40+
```
41+
</Step>
42+
<Step title={"Try our Built-In Demo (optional)"}>
43+
Import the `Demo` sample from Unity's Package Manager. Additionally, checkout our boilerplate
44+
script [EcosystemWalletLoginWindow](https://github.com/0xsequence/sequence-unity/blob/master/Packages/Sequence-Unity/Sequence/SequenceBoilerplates/Scripts/EcosystemWallet/EcosystemWalletLoginWindow.cs) for integration details.
45+
46+
You can use this Boilerplate inside your project after importing the Demo Samples. Then, simply call this function:
47+
`BoilerplateFactory.OpenEcosystemWalletLogin(parent)`
2448

2549
If you have installed the SDK as a `.unitypackage` file, please locate the Demo scene inside
26-
Unity's `Project` window under `Packages > Sequence Embedded Wallet SDK > Sequence > Samples > Demo`
50+
Unity's `Project` window under `Packages > Sequence SDK > Sequence > Samples > Demo`
2751

2852
<Frame>
2953
<img src="/images/unity/ecosystem-wallet-demo.png" />

0 commit comments

Comments
 (0)