@hashgraph/sdk
Version:
86 lines (85 loc) • 2.76 kB
TypeScript
/**
* @namespace proto
* @typedef {import("@hiero-ledger/proto").proto.IGrantedCryptoAllowance} HieroProto.proto.IGrantedCryptoAllowance
* @typedef {import("@hiero-ledger/proto").proto.ICryptoAllowance} HieroProto.proto.ICryptoAllowance
* @typedef {import("@hiero-ledger/proto").proto.IAccountID} HieroProto.proto.IAccountID
*/
/**
* @typedef {import("long")} Long
*/
/**
* @typedef {import("../client/Client.js").default<*, *>} Client
*/
/**
* Represents an HBAR allowance granted to a spender account by an owner account.
* This class manages the permissions for one account to spend HBAR on behalf of another account.
*/
export default class HbarAllowance {
/**
* @internal
* @param {HieroProto.proto.ICryptoAllowance} allowance
* @returns {HbarAllowance}
*/
static _fromProtobuf(allowance: HieroProto.proto.ICryptoAllowance): HbarAllowance;
/**
* @internal
* @param {HieroProto.proto.IGrantedCryptoAllowance} allowance
* @param {AccountId} ownerAccountId
* @returns {HbarAllowance}
*/
static _fromGrantedProtobuf(allowance: HieroProto.proto.IGrantedCryptoAllowance, ownerAccountId: AccountId): HbarAllowance;
/**
* @internal
* @param {object} props
* @param {AccountId | null} props.spenderAccountId
* @param {AccountId | null} props.ownerAccountId
* @param {Hbar | null} props.amount
*/
constructor(props: {
spenderAccountId: AccountId | null;
ownerAccountId: AccountId | null;
amount: Hbar | null;
});
/**
* The account ID of the hbar allowance spender.
*
* @readonly
*/
readonly spenderAccountId: AccountId | null;
/**
* The account ID of the hbar allowance owner.
*
* @readonly
*/
readonly ownerAccountId: AccountId | null;
/**
* The current balance of the spender's allowance in tinybars.
*
* @readonly
*/
readonly amount: Hbar | null;
/**
* @internal
* @returns {HieroProto.proto.ICryptoAllowance}
*/
_toProtobuf(): HieroProto.proto.ICryptoAllowance;
/**
* @param {Client} client
*/
_validateChecksums(client: Client): void;
/**
* @returns {object}
*/
toJSON(): object;
}
export namespace HieroProto {
namespace proto {
type IGrantedCryptoAllowance = import("@hiero-ledger/proto").proto.IGrantedCryptoAllowance;
type ICryptoAllowance = import("@hiero-ledger/proto").proto.ICryptoAllowance;
type IAccountID = import("@hiero-ledger/proto").proto.IAccountID;
}
}
export type Long = import("long");
export type Client = import("../client/Client.js").default<any, any>;
import AccountId from "./AccountId.js";
import Hbar from "../Hbar.js";