Payment Upon IoT

payment-upon-iot@0.6.0 Contract ^0.20.0 ae0fbb7876538e4733cb03dc699b7a50c20fe9caf8740fdb1f4125a218acd893

This is a payment contract that pays out a fixed amount each time a button is pressed.

Download Archive Open in Template Studio Open in VSCode Web

Payment upon IoT Button Press

This is template pays out a fixed amount each time a button is pressed.

It responds to:

  • single press : increments a counter by 1
  • double press : decrements a counter by 1
  • long press : pays out based on the current counter and resets the counter to 0

Template Text

Upon long button press, "Dan" shall pay to "Grant" 10 USD for each short button press. A maximum of 5 payments may be made before this contract is COMPLETED.

Note: to undo a short button press the buyer may double-press the button.

 
Upon long button press, "Dan" shall pay to "Grant" 10 USD for each short button press. A maximum of 5 payments may be made before this contract is COMPLETED.

Note: to undo a short button press the buyer may double-press the button.
Upon long button press, {{buyer}} shall pay to {{seller}} {{amountPerUnit}} for each short button press. A maximum of {{paymentCount}} payments may be made before this contract is COMPLETED.

Note: to undo a short button press the buyer may double-press the button.
{
    "$class": "org.accordproject.payment.iot.PaymentUponButtonContract",
    "contractId": "59102618-3e2c-4c0f-b767-4e53acf01648",
    "buyer": {
        "$class": "org.accordproject.cicero.contract.AccordParty",
        "partyId": "Dan"
    },
    "seller": {
        "$class": "org.accordproject.cicero.contract.AccordParty",
        "partyId": "Grant"
    },
    "amountPerUnit": {
        "$class": "org.accordproject.money.MonetaryAmount",
        "doubleValue": 10,
        "currencyCode": "USD"
    },
    "paymentCount": 5
}

Template Model

namespace org.accordproject.payment.iot

import org.accordproject.cicero.contract.* from https://models.accordproject.org/cicero/contract.cto
import org.accordproject.cicero.runtime.* from https://models.accordproject.org/cicero/runtime.cto
import org.accordproject.money.MonetaryAmount from https://models.accordproject.org/money.cto

import org.accordproject.payment.PaymentReceived from https://models.accordproject.org/payment/payment.cto
import org.accordproject.signature.ContractSigned from https://models.accordproject.org/signature/signature.cto

import org.accordproject.iot.SingleButtonPress from https://models.accordproject.org/iot/iot.cto
import org.accordproject.iot.DoubleButtonPress from https://models.accordproject.org/iot/iot.cto
import org.accordproject.iot.LongButtonPress from https://models.accordproject.org/iot/iot.cto

asset CounterState extends AccordContractState {
  o ContractLifecycleStatus status
  o Double counter
  o Double paymentCount
}

enum ContractLifecycleStatus {
  o INITIALIZED
  o RUNNING
  o COMPLETED
}

transaction CounterResponse extends Response {
  o Double counter
  o Double paymentCount
}

transaction MonetaryAmountPayment extends PaymentReceived {
  o MonetaryAmount amount
}

/**
 * The template model
 */
asset PaymentUponButtonContract extends AccordContract {
  o AccordParty buyer
  o AccordParty seller
  o MonetaryAmount amountPerUnit
  o Integer paymentCount
}

Model Dependencies

Template Logic

Find the full logic for this template on on GitHub.

State Types

Type Sample JSON
org.accordproject.payment.iot.CounterState 
{
    "$class": "org.accordproject.payment.iot.CounterState",
    "status": "INITIALIZED",
    "counter": 113.024,
    "paymentCount": 190.02,
    "stateId": "76661444-42fa-11ea-8b78-dde257dbceb0"
}

Request Types

Type Sample JSON
org.accordproject.iot.DoubleButtonPress 
{
    "$class": "org.accordproject.iot.DoubleButtonPress",
    "serialNumber": "Elit eiusmod incididunt labore ut.",
    "batteryVoltage": "Cillum ut do proident.",
    "transactionId": "7665ed30-42fa-11ea-8b78-dde257dbceb0",
    "timestamp": "2020-01-29T19:50:08.387-05:00"
}
org.accordproject.iot.LongButtonPress 
{
    "$class": "org.accordproject.iot.LongButtonPress",
    "serialNumber": "Sunt nostrud.",
    "batteryVoltage": "Cupidatat.",
    "transactionId": "7665ed31-42fa-11ea-8b78-dde257dbceb0",
    "timestamp": "2020-01-29T19:50:08.387-05:00"
}
org.accordproject.iot.SingleButtonPress 
{
    "$class": "org.accordproject.iot.SingleButtonPress",
    "serialNumber": "Aliquip in amet laborum sint.",
    "batteryVoltage": "Aute.",
    "transactionId": "7665c621-42fa-11ea-8b78-dde257dbceb0",
    "timestamp": "2020-01-29T19:50:08.386-05:00"
}
org.accordproject.payment.iot.MonetaryAmountPayment 
{
    "$class": "org.accordproject.payment.iot.MonetaryAmountPayment",
    "amount": {
        "$class": "org.accordproject.money.MonetaryAmount",
        "doubleValue": 69.71,
        "currencyCode": "GYD"
    },
    "transactionId": "7665ed32-42fa-11ea-8b78-dde257dbceb0",
    "timestamp": "2020-01-29T19:50:08.387-05:00"
}
org.accordproject.signature.ContractSigned 
{
    "$class": "org.accordproject.signature.ContractSigned",
    "contract": "resource:org.accordproject.payment.iot.PaymentUponButtonContract#9461",
    "transactionId": "7665c620-42fa-11ea-8b78-dde257dbceb0",
    "timestamp": "2020-01-29T19:50:08.386-05:00"
}

Response Types

Type Sample JSON
org.accordproject.cicero.runtime.Response 
{
    "$class": "org.accordproject.cicero.runtime.Response",
    "transactionId": "7665ed37-42fa-11ea-8b78-dde257dbceb0",
    "timestamp": "2020-01-29T19:50:08.387-05:00"
}

Events Types

Type Sample JSON
org.accordproject.base.Event 
{
    "abstract": "this is an abstract type"
}
org.accordproject.cicero.runtime.PaymentObligation 
{
    "$class": "org.accordproject.cicero.runtime.PaymentObligation",
    "amount": {
        "$class": "org.accordproject.money.MonetaryAmount",
        "doubleValue": 10.701,
        "currencyCode": "GMD"
    },
    "description": "Anim consectetur excepteur.",
    "contract": "resource:org.accordproject.payment.iot.PaymentUponButtonContract#9992",
    "promisor": "resource:org.accordproject.cicero.contract.AccordParty#7125",
    "promisee": "resource:org.accordproject.cicero.contract.AccordParty#5956",
    "deadline": "2020-01-29T19:50:08.388-05:00",
    "eventId": "76661445-42fa-11ea-8b78-dde257dbceb0",
    "timestamp": "2020-01-29T19:50:08.388-05:00"
}

Technical Integration

Please refer to the Cicero documentation for details and examples of how to integrate a call to a Cicero template into your application.

View the Latest code for this template on GitHub.