Type alias AllocationDTO

AllocationDTO: {
    address?: string;
    allocationId: string;
    deposit?: {
        contract: string;
        id: string;
        validate?: Record<string, any>;
    };
    extendTimeout?: number;
    makeDeposit?: boolean;
    paymentPlatform?: string;
    remainingAmount: string;
    spentAmount: string;
    timeout?: string;
    timestamp: string;
    totalAmount: string;
}

An Allocation is a designated sum of money reserved for the purpose of making some particular payments. Allocations are currently purely virtual objects. They exist only in Requestor's database. An Allocation is connected to a payment account (wallet) specified by address and paymentPlatform field. If these fields are not present the default payment platform is used and the address is assumed to be identical to the Requestor's Node ID.

NOTE: timeout and makeDeposit field are currently ignored.

Type declaration

  • Optional address?: string
  • Readonly allocationId: string
  • Optional deposit?: {
        contract: string;
        id: string;
        validate?: Record<string, any>;
    }
    • contract: string
    • id: string
    • Optional validate?: Record<string, any>
  • Optional extendTimeout?: number

    in seconds, the time by which the allocation timeout is extended after it is last used.

  • Optional makeDeposit?: boolean
  • Optional paymentPlatform?: string
  • Readonly remainingAmount: string
  • Readonly spentAmount: string
  • Optional timeout?: string
  • Readonly timestamp: string
  • totalAmount: string

Settings

Member Visibility

Theme