User

pydantic model empyrealSDK.types.User

A User of an application. This is mainly used to organize wallets and actions to a single owner. Currently the telegram id identity is used to manage users, but they can be created without an originating telegram account, and it is mainly used as a convenience for tracking.

Show JSON schema

{
   "title": "User",
   "description": "A User of an application.  This is mainly used to organize wallets\nand actions to a single owner.  Currently the telegram id identity is\nused to manage users, but they can be created without an originating\ntelegram account, and it is mainly used as a convenience for tracking.",
   "type": "object",
   "properties": {
      "id": {
         "format": "uuid",
         "title": "Id",
         "type": "string"
      },
      "type": {
         "anyOf": [
            {
               "$ref": "#/$defs/UserType"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "telegramId": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "title": "Telegramid"
      },
      "isNewUser": {
         "title": "Isnewuser",
         "type": "boolean"
      },
      "metadata": {
         "default": {},
         "title": "Metadata",
         "type": "object"
      }
   },
   "$defs": {
      "UserType": {
         "enum": [
            1,
            2
         ],
         "title": "UserType",
         "type": "integer"
      }
   },
   "required": [
      "id",
      "name",
      "telegramId",
      "isNewUser"
   ]
}

Fields:

• id (uuid.UUID)

• is_new_user (bool)

• metadata (dict[Any, Any])

• name (str)

• telegram_id (str | None)

• type (empyrealSDK.types.user.UserType | None)

field id: UUID [Required]

field is_new_user: bool [Required] (alias 'isNewUser')

field metadata: dict[Any, Any] = {}

field name: str [Required]

field telegram_id: str | None [Required] (alias 'telegramId')

field type: UserType | None = None

async classmethod create(name: str)

async get_app_wallets()

async classmethod load(telegram_id: str | int)

async make_wallet(name: str, private_key: HexStr | None = None)