Skip to main content

Immersve Payment Protocol

Contract Module that allows users to deposit and lock funds in order to be able to fund one-time-use Immersve virtual cards.

Proxy URLs​

Extensions​

For security reasons, the smart contract implements the following OpenZeppelin Contracts

Proxy​

The Smart Contract implements the OpenZeppelin TransparentUpgradeable proxy. Proxy features:

  • Security: If any bugs are found, or potential security risks, the Smart Contract can be updated to resolve any potential issues
  • Feature Upgradeability: Any new features and bug fixes can be added. The Smart Contract will keep the same state, without the need of expensive migrations
  • Stability: Clients interacting with the Smart Contract will always do so through the same proxy address. The proxy will know the current implementation address and will always keep the same state.

More about upgradeable contracts here: https://blog.openzeppelin.com/the-state-of-smart-contract-upgrades/

graph LR Client -- Trx --> Proxy[(Proxy)] Proxy -- "getImplementation()" --> Proxy Proxy -- old --> v1{{ContractImplV1}} Proxy -- "delegate call" --> v2{{ContractImplV2}}

Functions​

withdraw(uint _amount) external nonReentrant notZeroValue(_amount) whenNotPaused​

CardHolders can withdraw token funds associated to their balance from the Smart Contract using this function. Locked funds cannot be withdrawn until the lock expires, or Immersve revokes the lock.

  • tokenAmount (type uint): token Amount to withdraw in minor units

depositAndLock(uint _amount) external nonReentrant notZeroValue(_amount) whenNotPaused​

CardHolders can deposit an amount of funds and lock it immediately. This will lock the funds for a number of blocks specified by the timeoutBlocks property of the smart contract.

  • _amount (type uint): token Amount to deposit in minor units

extendLockedFund() external whenNotPaused​

Allows user to extend his own lock. This operation will fail if there are no locked funds for the wallet initiating the transaction

getTimeoutHasPassed (address _address, uint _additionalBlocks) public view returns (bool)​

Retrieves whether the timeout has passed for the lock owned by the _address.

  • _address (type address): CardHolder Address
  • _additionalBlocks (type uint): Optional argument to calculate expiration of a locked fund based on an extra amount of blocks

Response​

bool: true if the timeout of the block for _address has passed, false if the lock is still active

getLockedFundBalance (address _address, uint _additionalBlocks) public view returns (bool, uint)​

Retrieves whether the timeout has passed for the lock owned by the _address. Similar to getTimeoutHasPassed but it returns an array indicating if the timeout has passed and the actual balance of the lock for the specified address

  • _address (type address): CardHolder Address
  • _additionalBlocks (type uint): Optional argument to calculate expiration of a locked fund based on an extra amount of blocks

Response​

array:

  • 0 timeoutHasPassed (type bool): true if the timeout of the block for _address has passed, false if the lock is still active
  • 1 lockedFundBalance (type uint): the balance of the locked fund for the specified address

Immersve Card E-Commerce Payment Happy Path​

  • Card Holder locks token funds with Immersve Smart Contract
  • Card Holder receives a valid Credit Card to be used for E-Commerce transaction from Immersve
  • Card Holder uses the Immersve Card to pay for goods purchased on an E-Commerce platform
  • Immersve authorizes the payment with Credit Card network once the locked funds are confirmed
  • Purchase is confirmed by Immersve and E-Commerce merchant
sequenceDiagram participant H as Card Holder participant W as Web3 Wallet participant I as Immersve Backend participant S as Smart Contract participant U as token Smart Contract participant E as E-Commerce website participant M as E-Commerce Merchant H->>I: Create card pre-request I-->>H: Web3 Transaction Details H->>W: Submit Transactions W->>U: Approve Card Total Authorized Amount in token W->>S: Deposit and Lock token funds S->>U: Transfer approved amount from Card Holder wallet to Immersve Smart Contract S-->>S: Add approved amount to Card Holder address balance S-->>S: Create LockedFund to temporarily lock Card Holder funds to be used by Immersve Card S-->>W: Transaction Hash W-->>H: Transaction Hash H->>I: Card Create Request I->>S: Check enough funds for Card creation S-->>I: Locked Funds confirmed I-->>H: Card created H->>E: Use Immersve Card to pay for goods online E-->>M: Validate Credit Card payment M->>I: Merchant request payment authorization through Credit Card network I->>S: Check locked funds and settle payment amount S->>S: Settle payment funds I->>M: Authorize payment