shinami-demo-app

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

shinami-demo-app

★ 10 Open GitHub ↗

Demo app built on Shinami SDKs and services

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Shinami demo app

[![Continuous Integration](https://github.com/shinamicorp/shinami-demo-app/actions/workflows/ci.yaml/badge.svg)](https://github.com/shinamicorp/shinami-demo-app/actions/workflows/ci.yaml)

An _imaginary_ game built on top of [Shinami](https://shinami.com) services and [Sui](https://sui.io/).

This is a [Next.js](https://nextjs.org/) project bootstrapped with the [nextjs-zklogin](https://github.com/shinamicorp/shinami-typescript-sdk/tree/main/examples/nextjs-zklogin) template.
It uses [@shinami/nextjs-zklogin](https://www.npmjs.com/package/@shinami/nextjs-zklogin) to authenticate end users and sign transactions, and [@shinami/clients](https://www.npmjs.com/package/@shinami/clients) to read from and write to the Sui blockchain.

## Highlights

- Social sign in experience, powered by [Shinami wallet services](https://www.shinami.com/invisible-wallet) and [zkLogin](https://docs.sui.io/build/zk_login).
  Notably, the social identity serves both of these purposes:
  - Authenticates and authorizes the player to the demo app backend.
  - Authorizes Sui transactions from a zkLogin address tied to the player's social identity.
- In-game heroes as player-owned on-chain objects, with evolving attributes.
- Sponsored transactions powered by [Shinami gas station](https://www.shinami.com/gas-station), for a frictionless player experience.

## Architecture

![Architecture diagram](https://raw.githubusercontent.com/shinamicorp/shinami-demo-app/main/images/architecture.drawio.svg)

The core app consists of two parts:

- The backend, implemented as [Next.js API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes), is under [pages/api](pages/api/).
  - Runs on a server with Node.js runtime.
  - Authenticates players using OpenID tokens obtained from the zkLogin sign in flow.
  - Communicates with Shinami wallet services for persistent wallet states.
  - Implements "game" logic, constructing and executing Sui transactions that mutate hero states.
  - Communicates with Shinami gas station for Sui transaction sponsorship.
- The frontend, implemented as [Next.js pages](https://nextjs.org/docs/pages/building-your-application/routing/pages-and-layouts) (React components), is everything else under [pages](pages/).
  - Runs in players' browsers.
  - Reads hero states from the Sui blockchain, through [Shinami node service](https://www.shinami.com/node).
  - Integrates with OpenID providers.
  - Maintains local zkLogin state (such as the ephemeral key) and signs player transactions.

Notably, the core app doesn't require its own database to operate, even though many players can sign up and mint and evolve their heroes.
All operating states are maintained by these external infra:

- The Sui blockchain itself, where all hero states are maintained.
- Shinami wallet services, where persitent wallet states are securely kept.
- OpenID providers, where players' sign-in information is maintained.

### Wallet management

There are two types of wallets used in this demo app:

- A single _admin wallet_.
  This manages access to the Sui account used by backend server(s) to run admin operations.
  - This is a backend wallet implemented using Shinami invisible wallet.
- A separate _player wallet_ for each signed-in user.
  They manage ownership of each piece of in-game asset, e.g. heroes.
  - These are zkLogin wallets managed by the app frontend.
  - All transactions from these wallets must be signed by the ephemeral keys that only exist in the players' browsers.
  - They use Shinami wallet services for salt persistence and ZK proof generation.

## Move package design

See [Move README](move/README.md).

## Development

All env variables required to run this demo app are listed in [.env](.env).
You must fill them in `.env.local` file, which should not be committed to git.

Assuming you have published your own copy of the [Move package](move/), you would have known the Sui network, package id, and have received a `sui::package::Publisher` object.
Next thing is to mint a `hero::AdminCap` object.

```bash
# Start the development server
npm run dev

# From another shell, obtain your admin wallet address
# This address is unique per Shinami account
curl http://localhost:3000/api/admin/wallet

# Mint and transfer an admin cap
# Must run from the same Sui address that published the package
sui client call \
  --package "<PACKAGE_ID>" \
  --module hero \
  --function new_admin_cap_to_recipient \
  --args "<PUBLISHER_ID>" "<ADMIN_WALLET_ADDRESS>" \
  --gas-budget 10000000
```

You can grab the admin cap object id from the output and set `ADMIN_CAP` in your `.env.local` file.
Note that this must be a different instance on every development or deployment server you run the backend on, to avoid [equivocation](https://docs.sui.io/sui-glossary#equivocation).

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying [pages/index.tsx](pages/index.tsx).
The page auto-updates as you edit the file.

shinami-demo-app

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README