@aleph-sdk/monorepo
    Preparing search index...

    Class TEZOSAccount

    XTZAccount implements the Account class for the Tezos protocol. It is used to represent a Tezos account when publishing a message on the Aleph network.

    Hierarchy

    • Account
      • TEZOSAccount
    Index

    Constructors

    Properties

    Methods

    Constructors

    • Parameters

      • publicKey: string

        The public key encoded in base58. Needed due to asynchronous getter of the public key.

      • wallet: BeaconWallet | InMemorySigner

        The signer containing the private key used to sign the message.

      • OptionaldAppUrl: string

        The URL of the dApp that is publishing the message. Defaults to "aleph.im". Used by wallets to display the requester of the signature.

      Returns TEZOSAccount

    Properties

    address: string
    dAppUrl: string

    Methods

    • The Sign method provides a way to sign a given Aleph message using a Tezos account. The full message is not used as the payload, only fields of the BaseMessage type are.

      nacl is used to sign the payload with the account's private key. The final message's signature is composed of the signed payload and the user's public key.

      Parameters

      • message: SignableMessage

        The Aleph message to sign, using some of its fields.

      Returns Promise<string>