Skip to content

Solidity API

PaymentCommitmentFactory

_Factory contract for deploying PaymentCommitment contract using CREATE2.

This implementation provides a way to deterministically deploy PaymentCommitment contract using the CREATE2 opcode.

The caller of deployPaymentCommitmentFromFactory is set as the depositor in the newly deployed payment commitment contract._

PaymentCommitmentCreated

solidity
event PaymentCommitmentCreated(address deployedAddress, bytes32 salt)

Emitted when a new PaymentCommitment contract is created.

Parameters

NameTypeDescription
deployedAddressaddressThe address of the newly deployed PaymentCommitment contract
saltbytes32The salt value used in CREATE2 deployment

Create2Failed

solidity
error Create2Failed()

Error thrown when the CREATE2 deployment fails

deployPaymentCommitmentFromFactory

solidity
function deployPaymentCommitmentFromFactory(address _committer, address _initialOwner, string _erc1155uri, bytes32 salt) public returns (address)

_Deploys a new PaymentCommitment contract using CREATE2.

This function creates a new PaymentCommitment contract with the specified parameters. The address of the deployed contract is deterministic and depends on the salt value.

Requirements:

  • The deployment must not fail
  • The salt value must not have been used before_

Parameters

NameTypeDescription
_committeraddressThe address of account committing payment to committee
_initialOwneraddressThe address of initial Owner of the contract
_erc1155uristringThe uri to be set for the undlying erc-1155 contract of payment commitment contract
saltbytes32A unique value used to determine the contract address

Return Values

NameTypeDescription
[0]addressAddress The address of the newly deployed PaymentCommitment contract