altcoinj/core/src/storedclientpaymentchannel.proto

/** Copyright 2013 Google Inc.
 *
 * 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.
 */

/*
 * Authors: Mike Hearn, Matt Corallo
 */
 
/* Notes:
 * - Endianness: All byte arrays that represent numbers (such as hashes and private keys) are Big Endian
 * - To regenerate after editing, run mvn clean package -DupdateProtobuf
 */

package paymentchannels;

option java_package = "org.bitcoinj.protocols.channels";
option java_outer_classname = "ClientState";


// A set of StoredPaymentChannel's
message StoredClientPaymentChannels {
    repeated StoredClientPaymentChannel channels = 1;
}

// A client-side payment channel in serialized form, which can be reloaded later if the client restarts and wants to
// reopen an existing channel
message StoredClientPaymentChannel {
	required bytes id = 1;
	required bytes contractTransaction = 2;
	required bytes refundTransaction = 3;
	required bytes myPublicKey = 8;
	// Deprecated, key is already stored in the wallet, and found using myPublicKey;
	required bytes myKey = 4;
	required uint64 valueToMe = 5;
	// Fees required to refund the transaction.
	required uint64 refundFees = 6;
	// When set, the hash of the transaction that was presented by the server for closure of the channel.
	// It spends the contractTransaction and is expected to be broadcast to the network by the server.
	// It's supposed to be in the wallet already.
	optional bytes closeTransactionHash = 7;
	optional uint32 majorVersion = 9 [default = 1];
	// The expiry time of the CLTV lock. Only used in protocol v2.
	optional uint64 expiryTime = 10;
	// The server's public key. Only used in protocol v2.
	optional bytes serverKey = 11;
}