Enoki Example App

https://github.com/sui-foundation/enoki-example-app
Admin
A simple, one-page application demonstrating integration with Mysten Lab's Enoki for features like...
Tokens:643
Snippets:7
Trust Score:9.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Project Dependencies with Yarn

Source: https://github.com/sui-foundation/enoki-example-app/blob/main/README.md

This command installs all required project dependencies as specified in the package.json file. It's a standard step to prepare the development environment.

```Shell
yarn install
```

--------------------------------

### Start Local Development Server with Yarn

Source: https://github.com/sui-foundation/enoki-example-app/blob/main/README.md

This command initiates the local development server for the Enoki example application. It allows developers to run and test the application in a local environment.

```Shell
yarn dev
```

--------------------------------

### Configure Public Enoki API Key

Source: https://github.com/sui-foundation/enoki-example-app/blob/main/README.md

This snippet demonstrates how to set the public Enoki API key in the .env file. This key is essential for client-side operations like zkLogin within the Enoki example application.

```dotenv
NEXT_PUBLIC_ENOKI_API_KEY=enoki_public_aa763a9d36bb6aa1e41062dd67df2518
```

--------------------------------

### Configure Private Enoki Secret Key

Source: https://github.com/sui-foundation/enoki-example-app/blob/main/README.md

This snippet shows how to set the private Enoki secret key in the .env file. This key is used on the backend for features such as sponsored transactions within the Enoki example application.

```dotenv
ENOKI_SECRET_KEY=enoki_private_905204de81012fd7422a9902907f112c
```

--------------------------------

### Configure Google Client ID for Authentication

Source: https://github.com/sui-foundation/enoki-example-app/blob/main/README.md

This snippet illustrates how to set the Google Client ID in the .env file. This ID is crucial for integrating Google as an authentication provider with Enoki's zkLogin feature, enabling users to log in via their Google accounts.

```dotenv
NEXT_PUBLIC_GOOGLE_CLIENT_ID=277348171272-epn1s82k6bmumooapalnsdq0lu19d27t.apps.googleusercontent.com
```

--------------------------------

### Sui Smart Contract Package ID Environment Variable

Source: https://github.com/sui-foundation/enoki-example-app/blob/main/README.md

This example demonstrates the format for setting the 'PACKAGE_ID' environment variable in the '.env.local' file. This variable holds the unique identifier of the deployed Sui smart contract, which is essential for the application to interact with the contract's functions.

```Environment Variable
PACKAGE_ID=0x7b6a8f5782e57cd948dc75ee098b73046a79282183d51eefb83d31ec95c312aa
```

--------------------------------

### Enoki Sponsored Transaction Allowed Move Call Targets

Source: https://github.com/sui-foundation/enoki-example-app/blob/main/README.md

This snippet lists the specific Move functions from the 'counter' module that are configured to be supported for sponsored transactions within the Enoki Dev Portal. These include functions for creating, incrementing, and setting the value of a counter, requiring replacement of '{PACKAGE_ID}' with the actual deployed contract ID.

```Sui Move
{PACKAGE_ID}::counter::create
{PACKAGE_ID}::counter::increment
{PACKAGE_ID}::counter::set_value
```
Tokens:
Raw