Class Deploy

Inheritance

object

Deploy

DeployAccepted

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Casper.Network.SDK.Types

Assembly: Casper.Network.SDK.dll

Syntax

public class Deploy

Constructors

Deploy(DeployHeader, ExecutableDeployItem, ExecutableDeployItem)

Declaration

public Deploy(DeployHeader header, ExecutableDeployItem payment, ExecutableDeployItem session)

Parameters

Type	Name	Description
DeployHeader	header
ExecutableDeployItem	payment
ExecutableDeployItem	session

Deploy(string, DeployHeader, ExecutableDeployItem, ExecutableDeployItem, List<Approval>)

Declaration

[JsonConstructor]
public Deploy(string hash, DeployHeader header, ExecutableDeployItem payment, ExecutableDeployItem session, List<Approval> approvals)

Parameters

Type	Name	Description
string	hash
DeployHeader	header
ExecutableDeployItem	payment
ExecutableDeployItem	session
List<Approval>	approvals

Properties

Approvals

List of signers and signatures for this Deploy.

Declaration

[JsonPropertyName("approvals")]
public List<Approval> Approvals { get; }

Property Value

Type	Description
List<Approval>

Hash

A hash over the header of the deploy.

Declaration

[JsonPropertyName("hash")]
public string Hash { get; }

Property Value

Type	Description
string

Header

Contains metadata about the deploy.

Declaration

[JsonPropertyName("header")]
public DeployHeader Header { get; }

Property Value

Type	Description
DeployHeader

Payment

Contains the payment amount for the deploy.

Declaration

[JsonPropertyName("payment")]
[JsonConverter(typeof(ExecutableDeployItemConverter))]
public ExecutableDeployItem Payment { get; }

Property Value

Type	Description
ExecutableDeployItem

Session

Contains the session information for the deploy.

Declaration

[JsonPropertyName("session")]
[JsonConverter(typeof(ExecutableDeployItemConverter))]
public ExecutableDeployItem Session { get; }

Property Value

Type	Description
ExecutableDeployItem

Methods

AddApproval(Approval)

Adds an approval to the deploy. No check is done to the approval signature.

Declaration

public void AddApproval(Approval approval)

Parameters

Type	Name	Description
Approval	approval

GetDeploySizeInBytes()

returns the number of bytes resulting from the binary serialization of the Deploy.

Declaration

public int GetDeploySizeInBytes()

Returns

Type	Description
int

Load(string)

Loads and deserializes a Deploy from a file.

Declaration

public static Deploy Load(string filename)

Parameters

Type	Name	Description
string	filename

Returns

Type	Description
Deploy

Parse(string)

Parses a Deploy from a file.

Declaration

public static Deploy Parse(string json)

Parameters

Type	Name	Description
string	json

Returns

Type	Description
Deploy

Save(string)

Saves a deploy object to a file.

Declaration

public void Save(string filename)

Parameters

Type	Name	Description
string	filename

SerializeToJson()

Returns a json string with the deploy.

Declaration

public string SerializeToJson()

Returns

Type	Description
string

Sign(KeyPair)

Signs the deploy with a private key and adds a new Approval to it.

Declaration

public void Sign(KeyPair keyPair)

Parameters

Type	Name	Description
KeyPair	keyPair

ValidateHashes(out string)

Validates the body and header hashes in the deploy.

Declaration

public bool ValidateHashes(out string message)

Parameters

Type	Name	Description
string	message	output string with a validation error message if validation fails. empty otherwise.

Returns

Type	Description
bool	false if the validation of hashes is not successful

VerifySignatures(out string)

Verifies the signatures in the list of approvals.

Declaration

public bool VerifySignatures(out string message)

Parameters

Type	Name	Description
string	message	an output string with the signer which signature could not be verified. empty if verification succeeds.

Returns

Type	Description
bool	false if the verification of a signature fails.