LoanWriter

bizlogic.loan.writer.LoanWriter

Loan Writer.

ipfs filename

loan/borrower_.lender_.loan_/created_

Source code in bizlogic/loan/writer.py
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
class LoanWriter():
    """Loan Writer.

    ipfs filename:
        loan/borrower_<id>.lender_<id>.loan_<id>/created_<timestamp>
    """

    loan_id: str
    borrower: str
    lender: str
    index: Index
    data: Loan
    ipfsclient: Ipfs
    borrower_wallet: str
    lender_wallet: str

    def __init__(
            self: Self,
            ipfs: Ipfs,
            borrower: str,
            lender: str,
            principal_amount: int,
            repayment_schedule: List[LoanPayment],
            offer_expiry: datetime.date,
            secret_manager: SecretManager,
            project: str) -> None:
        """Construct a new unaccepted loan and write it.

        The loan is not accepted until the borrower signs it.

        Args:
            ipfs: the ipfs client
            borrower: the borrower id
            lender: the lender id
            principal_amount: the principal amount of the loan
            repayment_schedule: the repayment schedule of the loan
            offer_expiry: the expiry date of the loan offer
            secret_manager: the secret manager to use for
                storing wallet private keys
            project: the project to use for wallet creation (the project to
                use in Google Secret Manager for storing the private keys
                of the created wallets)
        """
        self.loan_id = str(uuid.uuid4())
        self.borrower = borrower
        self.lender = lender
        self.ipfsclient = ipfs
        timestamp = Timestamp()
        timestamp.FromDatetime(offer_expiry)

        # Create deposit wallets
        self._create_wallets(secret_manager, project)

        self.data = Loan(
            principal_amount=principal_amount,
            repayment_schedule=repayment_schedule,
            offer_expiry=timestamp,
            accepted=False,
            borrower_deposit_wallet=self.borrower_wallet,
            lender_deposit_wallet=self.lender_wallet
        )

    @staticmethod
    def from_data(
            ipfs: Ipfs,
            data: Store,
            wallet_manager: WalletManager,
            secret_manager: SecretManager,
            project: str) -> Self:
        """Construct a new loan from existing data.

        Args:
            ipfs: the ipfs client
            data: the loan data
            wallet_manager: the wallet manager
            secret_manager: the secret manager to use for
                storing wallet private keys
            project: the project to use for wallet creation (the project to
                use in Google Secret Manager for storing the private keys
                of the created wallets)

        Returns:
            LoanWriter: the loan writer
        """
        writer = LoanWriter(
            ipfs=ipfs,
            borrower=data.index["borrower"],
            lender=data.index["lender"],
            principal_amount=data.reader.principal_amount,
            repayment_schedule=data.reader.repayment_schedule,
            offer_expiry=data.reader.offer_expiry,
            wallet_manager=wallet_manager,
            secret_manager=secret_manager,
            project=project
        )

        return writer

    def _create_wallets(
            self: Self,
            secret_manager: SecretManager,
            project: str) -> None:
        """Create deposit wallets for borrower and lender.

        The borrower deposit wallet is for the principal and
        the lender deposit wallet is for the repayments.

        Args:
            secret_manager: the secret manager to use for
                storing wallet private keys
            project: the project to use for wallet creation (the project to
                use in Google Secret Manager for storing the private keys
                of the created wallets)
        """
        # Borrower's deposit wallet
        borrower_wallet_name = f"{self.loan_id}_borrower_deposit_wallet"
        borrower_wallet_id, borrower_account_address = \
            WalletManager(secret_manager).create_wallet(
                project, borrower_wallet_name
            )

        # Lender's deposit wallet
        lender_wallet_name = f"{self.loan_id}_lender_deposit_wallet"
        lender_wallet_id, lender_account_address = \
            WalletManager(secret_manager).create_wallet(
                project, lender_wallet_name
            )

        # Check if wallets created successfully
        if not all([
                borrower_wallet_id,
                lender_wallet_id,
                borrower_account_address,
                lender_account_address]):
            raise Exception("Error during wallets creation. Loan initiation failed.")

        self.borrower_wallet = borrower_account_address
        self.lender_wallet = lender_account_address

    def write(self: Self) -> None:
        """Write the loan to IPFS."""
        self._generate_index()

        store = Store(
            index=self.index,
            ipfs=self.ipfsclient,
            writer=self.data
        )

        store.add()

    def _generate_index(self: Self) -> None:
        """Generate the index for the loan."""
        self.index = Index(
            prefix=PREFIX,
            index={
                "borrower": self.borrower,
                "lender": self.lender,
                "loan": self.loan_id
            },
            subindex=Index(
                index={
                    "created": str(time.time_ns())
                }
            )
        )

    def accept_terms(self: Self) -> None:
        """Accept the loan terms."""
        self.data = Loan(
            principal_amount=self.data.principal_amount,
            repayment_schedule=self.data.repayment_schedule,
            offer_expiry=self.data.offer_expiry,
            accepted=True
        )

    def register_payment(
            self: Self,
            payment_id: str,
            transaction: str) -> None:
        """Register a payment.

        Args:
            payment_id: the payment id
            transaction: the transaction id
        """
        new_repayment_schedule = []
        for payment in self.data.repayment_schedule:
            if payment.payment_id == payment_id:
                new_repayment_schedule.append(LoanPayment(
                    payment_id=payment_id,
                    amount_due=payment.amount_due_each_payment,
                    due_date=payment.timestamp,
                    transaction=transaction
                ))
            else:
                new_repayment_schedule.append(payment)

        self.data = Loan(
            principal_amount=self.data.principal_amount,
            repayment_schedule=self.data.repayment_schedule,
            offer_expiry=self.data.offer_expiry,
            accepted=self.data.accepted
        )

__init__(ipfs, borrower, lender, principal_amount, repayment_schedule, offer_expiry, secret_manager, project)

Construct a new unaccepted loan and write it.

The loan is not accepted until the borrower signs it.

Parameters:
  • ipfs (Ipfs) –

    the ipfs client

  • borrower (str) –

    the borrower id

  • lender (str) –

    the lender id

  • principal_amount (int) –

    the principal amount of the loan

  • repayment_schedule (List[LoanPayment]) –

    the repayment schedule of the loan

  • offer_expiry (date) –

    the expiry date of the loan offer

  • secret_manager (SecretManager) –

    the secret manager to use for storing wallet private keys

  • project (str) –

    the project to use for wallet creation (the project to use in Google Secret Manager for storing the private keys of the created wallets)

bizlogic/loan/writer.py
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def __init__(
        self: Self,
        ipfs: Ipfs,
        borrower: str,
        lender: str,
        principal_amount: int,
        repayment_schedule: List[LoanPayment],
        offer_expiry: datetime.date,
        secret_manager: SecretManager,
        project: str) -> None:
    """Construct a new unaccepted loan and write it.

    The loan is not accepted until the borrower signs it.

    Args:
        ipfs: the ipfs client
        borrower: the borrower id
        lender: the lender id
        principal_amount: the principal amount of the loan
        repayment_schedule: the repayment schedule of the loan
        offer_expiry: the expiry date of the loan offer
        secret_manager: the secret manager to use for
            storing wallet private keys
        project: the project to use for wallet creation (the project to
            use in Google Secret Manager for storing the private keys
            of the created wallets)
    """
    self.loan_id = str(uuid.uuid4())
    self.borrower = borrower
    self.lender = lender
    self.ipfsclient = ipfs
    timestamp = Timestamp()
    timestamp.FromDatetime(offer_expiry)

    # Create deposit wallets
    self._create_wallets(secret_manager, project)

    self.data = Loan(
        principal_amount=principal_amount,
        repayment_schedule=repayment_schedule,
        offer_expiry=timestamp,
        accepted=False,
        borrower_deposit_wallet=self.borrower_wallet,
        lender_deposit_wallet=self.lender_wallet
    )

from_data(ipfs, data, wallet_manager, secret_manager, project) staticmethod

Construct a new loan from existing data.

Parameters:
  • ipfs (Ipfs) –

    the ipfs client

  • data (Store) –

    the loan data

  • wallet_manager (WalletManager) –

    the wallet manager

  • secret_manager (SecretManager) –

    the secret manager to use for storing wallet private keys

  • project (str) –

    the project to use for wallet creation (the project to use in Google Secret Manager for storing the private keys of the created wallets)

Returns:
  • LoanWriter( Self ) –

    the loan writer

bizlogic/loan/writer.py
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
@staticmethod
def from_data(
        ipfs: Ipfs,
        data: Store,
        wallet_manager: WalletManager,
        secret_manager: SecretManager,
        project: str) -> Self:
    """Construct a new loan from existing data.

    Args:
        ipfs: the ipfs client
        data: the loan data
        wallet_manager: the wallet manager
        secret_manager: the secret manager to use for
            storing wallet private keys
        project: the project to use for wallet creation (the project to
            use in Google Secret Manager for storing the private keys
            of the created wallets)

    Returns:
        LoanWriter: the loan writer
    """
    writer = LoanWriter(
        ipfs=ipfs,
        borrower=data.index["borrower"],
        lender=data.index["lender"],
        principal_amount=data.reader.principal_amount,
        repayment_schedule=data.reader.repayment_schedule,
        offer_expiry=data.reader.offer_expiry,
        wallet_manager=wallet_manager,
        secret_manager=secret_manager,
        project=project
    )

    return writer

_create_wallets(secret_manager, project)

Create deposit wallets for borrower and lender.

The borrower deposit wallet is for the principal and the lender deposit wallet is for the repayments.

Parameters:
  • secret_manager (SecretManager) –

    the secret manager to use for storing wallet private keys

  • project (str) –

    the project to use for wallet creation (the project to use in Google Secret Manager for storing the private keys of the created wallets)

bizlogic/loan/writer.py
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
def _create_wallets(
        self: Self,
        secret_manager: SecretManager,
        project: str) -> None:
    """Create deposit wallets for borrower and lender.

    The borrower deposit wallet is for the principal and
    the lender deposit wallet is for the repayments.

    Args:
        secret_manager: the secret manager to use for
            storing wallet private keys
        project: the project to use for wallet creation (the project to
            use in Google Secret Manager for storing the private keys
            of the created wallets)
    """
    # Borrower's deposit wallet
    borrower_wallet_name = f"{self.loan_id}_borrower_deposit_wallet"
    borrower_wallet_id, borrower_account_address = \
        WalletManager(secret_manager).create_wallet(
            project, borrower_wallet_name
        )

    # Lender's deposit wallet
    lender_wallet_name = f"{self.loan_id}_lender_deposit_wallet"
    lender_wallet_id, lender_account_address = \
        WalletManager(secret_manager).create_wallet(
            project, lender_wallet_name
        )

    # Check if wallets created successfully
    if not all([
            borrower_wallet_id,
            lender_wallet_id,
            borrower_account_address,
            lender_account_address]):
        raise Exception("Error during wallets creation. Loan initiation failed.")

    self.borrower_wallet = borrower_account_address
    self.lender_wallet = lender_account_address

write()

Write the loan to IPFS.

bizlogic/loan/writer.py
159
160
161
162
163
164
165
166
167
168
169
def write(self: Self) -> None:
    """Write the loan to IPFS."""
    self._generate_index()

    store = Store(
        index=self.index,
        ipfs=self.ipfsclient,
        writer=self.data
    )

    store.add()

_generate_index()

Generate the index for the loan.

bizlogic/loan/writer.py
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
def _generate_index(self: Self) -> None:
    """Generate the index for the loan."""
    self.index = Index(
        prefix=PREFIX,
        index={
            "borrower": self.borrower,
            "lender": self.lender,
            "loan": self.loan_id
        },
        subindex=Index(
            index={
                "created": str(time.time_ns())
            }
        )
    )

accept_terms()

Accept the loan terms.

bizlogic/loan/writer.py
187
188
189
190
191
192
193
194
def accept_terms(self: Self) -> None:
    """Accept the loan terms."""
    self.data = Loan(
        principal_amount=self.data.principal_amount,
        repayment_schedule=self.data.repayment_schedule,
        offer_expiry=self.data.offer_expiry,
        accepted=True
    )

register_payment(payment_id, transaction)

Register a payment.

Parameters:
  • payment_id (str) –

    the payment id

  • transaction (str) –

    the transaction id

bizlogic/loan/writer.py
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def register_payment(
        self: Self,
        payment_id: str,
        transaction: str) -> None:
    """Register a payment.

    Args:
        payment_id: the payment id
        transaction: the transaction id
    """
    new_repayment_schedule = []
    for payment in self.data.repayment_schedule:
        if payment.payment_id == payment_id:
            new_repayment_schedule.append(LoanPayment(
                payment_id=payment_id,
                amount_due=payment.amount_due_each_payment,
                due_date=payment.timestamp,
                transaction=transaction
            ))
        else:
            new_repayment_schedule.append(payment)

    self.data = Loan(
        principal_amount=self.data.principal_amount,
        repayment_schedule=self.data.repayment_schedule,
        offer_expiry=self.data.offer_expiry,
        accepted=self.data.accepted
    )