Wallet

pydantic model empyrealSDK.types.Wallet

A wallet, which is able to make transactions.

Wallets are owned by a specific user, and have individual permissions.

Show JSON schema

{
   "title": "Wallet",
   "description": "A wallet, which is able to make transactions.\n\nWallets are owned by a specific user, and have individual permissions.",
   "type": "object",
   "properties": {
      "id": {
         "format": "uuid",
         "title": "Id",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "address": {
         "title": "Address",
         "type": "string"
      },
      "type": {
         "$ref": "#/$defs/WalletType"
      },
      "groupId": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "title": "Groupid"
      },
      "ownerId": {
         "anyOf": [
            {
               "format": "uuid",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "title": "Ownerid"
      },
      "creatorAppId": {
         "anyOf": [
            {
               "format": "uuid",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "title": "Creatorappid"
      },
      "data": {
         "allOf": [
            {
               "$ref": "#/$defs/WalletAppData"
            }
         ],
         "default": {
            "archived": false,
            "notes": {}
         }
      }
   },
   "$defs": {
      "WalletAppData": {
         "properties": {
            "archived": {
               "default": false,
               "title": "Archived",
               "type": "boolean"
            },
            "notes": {
               "additionalProperties": {
                  "anyOf": [
                     {
                        "type": "string"
                     },
                     {
                        "type": "integer"
                     }
                  ]
               },
               "default": {},
               "title": "Notes",
               "type": "object"
            }
         },
         "title": "WalletAppData",
         "type": "object"
      },
      "WalletType": {
         "enum": [
            "mnemonic",
            "private_key",
            "enclave",
            "noncustodial"
         ],
         "title": "WalletType",
         "type": "string"
      }
   },
   "required": [
      "id",
      "name",
      "address",
      "type",
      "groupId",
      "ownerId",
      "creatorAppId"
   ]
}

Fields:

• address (str)

• creator_app_id (uuid.UUID | None)

• data (empyrealSDK.types.wallet.WalletAppData)

• group_id (str | None)

• id (uuid.UUID)

• name (str)

• owner_id (uuid.UUID | None)

• type (empyrealSDK.types.wallet.WalletType)

field address: str [Required]

field creator_app_id: UUID | None [Required] (alias 'creatorAppId')

field data: WalletAppData = <AppData| archived: False, notes: {}>

field group_id: str | None [Required] (alias 'groupId')

field id: UUID [Required]

field name: str [Required]

field owner_id: UUID | None [Required] (alias 'ownerId')

field type: WalletType [Required]

async classmethod create()

async get_data()

Get app specific data associated with wallet.

async classmethod load(address)

If you load a wallet by address, it will give a noncustodial wallet. This represents a wallet but has none of the capabilities of a wallet with a private key attached to it.

async update_data(archive: bool = False, notes: dict[str, int | str] = {})