icp_perun.did

//  Copyright 2021 PolyCrypt GmbH
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.

type Error = nat8;
type L2Account = vec nat8;
type Timestamp = nat64;
type Duration = nat64;
type Hash = vec nat8;
type Nonce = Hash;
type ChannelId = Hash;
type Amount = nat;

type Funding = record { channel: ChannelId; participant: L2Account; };

type Params = record {
	nonce: Nonce;
	participants: vec L2Account;
	challenge_duration: Duration;
};

type State = record {
	channel: ChannelId;
	version: nat64;
	allocation: vec Amount;
	finalized: bool;
};

type FullySignedState = record {
	state: State;
	sigs: vec blob;
};

type WithdrawalRequest = record {
	funding: Funding;
	receiver: principal;
};

type RegisteredState = record {
	state: State;
	timeout: Timestamp;
};

service : {
	"deposit": (Funding) -> (opt Error);
	"query_holdings": (Funding) -> (opt Amount) query;
	"conclude": (Params, FullySignedState) -> (opt Error);
	"dispute": (Params, FullySignedState) -> (opt Error);
	"query_state": (ChannelId) -> (opt RegisteredState);
	"withdraw": (WithdrawalRequest, blob) -> (opt Amount, opt Error);

	"transaction_notification": (nat64) -> ();
}