60 lines
3.3 KiB
SQL
60 lines
3.3 KiB
SQL
--
|
|
-- This file is part of TALER
|
|
-- Copyright (C) 2014--2022 Taler Systems SA
|
|
--
|
|
-- TALER is free software; you can redistribute it and/or modify it under the
|
|
-- terms of the GNU General Public License as published by the Free Software
|
|
-- Foundation; either version 3, or (at your option) any later version.
|
|
--
|
|
-- TALER is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
-- WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
-- A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
--
|
|
-- You should have received a copy of the GNU General Public License along with
|
|
-- TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
|
|
--
|
|
|
|
-- FIXME: this table should be sharded!
|
|
|
|
CREATE TABLE policy_details
|
|
(policy_details_serial_id BIGINT GENERATED BY DEFAULT AS IDENTITY UNIQUE
|
|
,policy_hash_code BYTEA PRIMARY KEY CHECK(LENGTH(policy_hash_code)=16)
|
|
,policy_json VARCHAR
|
|
,deadline INT8 NOT NULL
|
|
,commitment_val INT8 NOT NULL
|
|
,commitment_frac INT4 NOT NULL
|
|
,accumulated_total_val INT8 NOT NULL
|
|
,accumulated_total_frac INT4 NOT NULL
|
|
,fee_val INT8 NOT NULL
|
|
,fee_frac INT4 NOT NULL
|
|
,transferable_val INT8 NOT NULL
|
|
,transferable_frac INT8 NOT NULL
|
|
,fulfillment_state smallint NOT NULL CHECK(fulfillment_state between 0 and 5)
|
|
,fulfillment_id BIGINT NULL REFERENCES policy_fulfillments (fulfillment_id) ON DELETE CASCADE
|
|
);
|
|
COMMENT ON TABLE policy_details
|
|
IS 'Policies that were provided with deposits via policy extensions.';
|
|
COMMENT ON COLUMN policy_details.policy_hash_code
|
|
IS 'ID (GNUNET_HashCode) that identifies a policy. Will be calculated by the policy extension based on the content';
|
|
COMMENT ON COLUMN policy_details.policy_json
|
|
IS 'JSON object with options set that the exchange needs to consider when executing a deposit. Supported details depend on the policy extensions supported by the exchange.';
|
|
COMMENT ON COLUMN policy_details.deadline
|
|
IS 'Deadline until the policy must be marked as fulfilled (maybe "forever")';
|
|
COMMENT ON COLUMN policy_details.commitment_val
|
|
IS 'The amount that this policy commits to. Invariant: commitment >= fee';
|
|
COMMENT ON COLUMN policy_details.accumulated_total_val
|
|
IS 'The sum of all contributions of all deposit that reference this policy. Invariant: The fulfilment_state must be Insufficient as long as accumulated_total < commitment';
|
|
COMMENT ON COLUMN policy_details.fee_val
|
|
IS 'The fee for this policy, due when the policy is fulfilled or timed out';
|
|
COMMENT ON COLUMN policy_details.transferable_val
|
|
IS 'The amount that on fulfillment or timeout will be transferred to the payto-URI''s of the corresponding deposit''s. The policy fees must have been already deducted from it. Invariant: fee+transferable <= accumulated_total. The remaining amount (accumulated_total - fee - transferable) can be refreshed by the owner of the coins when the state is Timeout or Success.';
|
|
COMMENT ON COLUMN policy_details.fulfillment_state
|
|
IS 'State of the fulfillment:
|
|
- 0 (Failure)
|
|
- 1 (Insufficient)
|
|
- 2 (Ready)
|
|
- 4 (Success)
|
|
- 5 (Timeout)';
|
|
COMMENT ON COLUMN policy_details.fulfillment_id
|
|
IS 'Reference to the proof of the fulfillment of this policy, if it exists. Invariant: If not NULL, this entry''s .hash_code MUST be part of the corresponding policy_fulfillments.policy_hash_codes array.';
|