Class Deploy

Represents a deploy in the blockchain, including the header, payment, session, and approvals. A Deploy object is used to package the logic for executing a contract, payment, or transfer on the blockchain.

Hierarchy

Deploy

Index

Constructors

constructor

new Deploy(hash: Hash, header: DeployHeader, payment: ExecutableDeployItem, session: ExecutableDeployItem, approvals: Approval[]): Deploy
Constructs a Deploy object.
Parameters
- hash: Hash
  
  The deploy hash identifying this deploy.
- header: DeployHeader
  
  The deploy header containing metadata.
- payment: ExecutableDeployItem
  
  The executable deploy item representing the payment logic.
- session: ExecutableDeployItem
  
  The executable deploy item representing the session logic.
- approvals: Approval[]
  
  An array of signatures and accounts who have approved this deploy.
Returns Deploy
- Defined in src/types/Deploy.ts:218

Properties

approvals

approvals: Approval[] = []

A list of approvals, including signatures from accounts that have approved the deploy.

hash

hash: Hash

The unique hash that identifies this deploy. This hash is used to verify the integrity of the deploy.

header

header: DeployHeader

The header of the deploy, which contains metadata such as the account, gas price, timestamp, and TTL.

payment

payment: ExecutableDeployItem

The executable item representing the payment logic of the deploy.

session

session: ExecutableDeployItem

The executable item representing the session logic of the deploy.

Methods

isStandardPayment

isStandardPayment(): boolean
Identifies whether this Deploy represents a standard payment, like a gas payment.

Returns
true if the deploy is a standard payment, otherwise false.

Returns boolean
- Defined in src/types/Deploy.ts:510

isTransfer

isTransfer(): boolean
Identifies whether this Deploy represents a transfer of CSPR.

Returns
true if the deploy is a transfer, otherwise false.

Returns boolean
- Defined in src/types/Deploy.ts:501

sign

sign(keys: PrivateKey): void
Signs the deploy with a given private key and adds the signature to the approvals list.
Parameters
- keys: PrivateKey
  
  The private key used to sign the deploy.
Returns void
- Defined in src/types/Deploy.ts:272

toBytes

toBytes(): Uint8Array
Converts the deploy object into a byte array for transmission or storage.

Returns
A Uint8Array representing the deploy in byte format.

Returns Uint8Array
- Defined in src/types/Deploy.ts:283

validate

validate(): boolean
Validates the deploy by checking its body hash, deploy hash, and approval signatures.

Returns
true if the deploy is valid, otherwise throws an error.

Returns boolean
- Defined in src/types/Deploy.ts:237

`Static` addArgToDeploy

addArgToDeploy(deploy: Deploy, name: string, value: CLValue): Deploy
Adds a runtime argument to a Deploy object

Returns
The original Deploy with the additional runtime argument

Remarks
Will fail if the Deploy has already been signed
Parameters
- deploy: Deploy
  
  The Deploy object for which to add the runtime argument
- name: string
  
  The name of the runtime argument
- value: CLValue
  
  The value of the runtime argument
Returns Deploy
- Defined in src/types/Deploy.ts:338

`Static` createNew

createNew(hash: Hash, header: DeployHeader, payment: ExecutableDeployItem, session: ExecutableDeployItem, approvals?: Approval[]): Deploy
Creates a new Deploy instance with the provided parameters.

Returns
A new Deploy object.
Parameters
- hash: Hash
  
  The deploy hash identifying this deploy.
- header: DeployHeader
  
  The deploy header.
- payment: ExecutableDeployItem
  
  The executable deploy item for the payment logic.
- session: ExecutableDeployItem
  
  The executable deploy item for the session logic.
- approvals: Approval[] = []
  
  An array of approvals for the deploy.
Returns Deploy
- Defined in src/types/Deploy.ts:320

`Static` fromJSON

fromJSON(json: any): Deploy
Converts a JSON representation of a deploy to a Deploy object.

Returns
A Deploy object if successful, or throws an error if parsing fails.
Parameters
- json: any
  
  The JSON representation of a Deploy.
Returns Deploy
- Defined in src/types/Deploy.ts:452

`Static` getDeploySizeInBytes

getDeploySizeInBytes(deploy: Deploy): number
Gets the byte-size of a deploy

Returns
The size of the Deploy in its serialized representation
Parameters
- deploy: Deploy
  
  The Deploy for which to calculate the size
Returns number
- Defined in src/types/Deploy.ts:522

`Static` makeDeploy

makeDeploy(deployHeader: DeployHeader, payment: ExecutableDeployItem, session: ExecutableDeployItem): Deploy
Creates a Deploy instance from the deploy header and session/payment logic.

Returns
A new Deploy object.
Parameters
- deployHeader: DeployHeader
  
  The deploy header.
- payment: ExecutableDeployItem
  
  The payment logic of the deploy.
- session: ExecutableDeployItem
  
  The session logic of the deploy.
Returns Deploy
- Defined in src/types/Deploy.ts:361

`Static` newTransactionFromDeploy

newTransactionFromDeploy(deploy: Deploy): Transaction
Converts the Deploy into a Transaction object. This method creates a transaction based on the deploy, including its payment and session logic.

Returns
A new Transaction object created from the deploy.
Parameters
- deploy: Deploy
  
  The deploy object.
Returns Transaction
- Defined in src/types/Deploy.ts:381

`Static` setSignature

setSignature(deploy: Deploy, signature: Uint8Array, publicKey: PublicKey): Deploy
Sets an already generated signature for the deploy.

Returns
A new Deploy instance with the added signature.
Parameters
- deploy: Deploy
  
  The deploy instance.
- signature: Uint8Array
  
  The Ed25519 or Secp256K1 signature.
- publicKey: PublicKey
  
  The public key used to generate the signature.
Returns Deploy
- Defined in src/types/Deploy.ts:300

`Static` toJSON

toJSON(deploy: Deploy): JsonTypes
Converts the Deploy object into a JSON representation.

Returns
A JSON representation of the deploy.
Parameters
- deploy: Deploy
  
  The deploy object to convert to JSON.
Returns JsonTypes
- Defined in src/types/Deploy.ts:491

Class Deploy

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

hash: Hash

header: DeployHeader

payment: ExecutableDeployItem

session: ExecutableDeployItem

approvals: Approval[]

Returns Deploy

Properties

approvals

hash

header

payment

session

Methods

isStandardPayment

Returns

Returns boolean

isTransfer

Returns

Returns boolean

sign

Parameters

keys: PrivateKey

Returns void

toBytes

Returns

Returns Uint8Array

validate

Returns

Returns boolean

Static addArgToDeploy

Returns

Remarks

Parameters

deploy: Deploy

name: string

value: CLValue

Returns Deploy

Static createNew

Returns

Parameters

hash: Hash

header: DeployHeader

payment: ExecutableDeployItem

session: ExecutableDeployItem

approvals: Approval[] = []

Returns Deploy

Static fromJSON

Returns

Parameters

json: any

Returns Deploy

Static getDeploySizeInBytes

Returns

Parameters

deploy: Deploy

Returns number

Static makeDeploy

Returns

Parameters

deployHeader: DeployHeader

payment: ExecutableDeployItem

session: ExecutableDeployItem

Returns Deploy

Static newTransactionFromDeploy

Returns

Parameters

deploy: Deploy

Returns Transaction

Static setSignature

Returns

Parameters

`Static` addArgToDeploy

`Static` createNew

`Static` fromJSON

`Static` getDeploySizeInBytes

`Static` makeDeploy

`Static` newTransactionFromDeploy

`Static` setSignature

`Static` toJSON