@propxchain/core-client 0.2.1 → 0.3.0-canary.24

package/src/canisters/transaction_manager/transaction_manager.did

@@ -1,3 +1,14 @@
+type WarrantyItem = 
+ record {
+   document: TA6Document;
+   present: TA6Answer;
+ };
+type Urgency = 
+ variant {
+   blocking;
+   later;
+   soon;
+ };
 type TransactionTimeline = 
  record {
    blockchainCompletedAt: opt int;
@@ -115,55 +126,48 @@ type TA7LeaseholdInformation =
    serviceChargePaymentFrequency: text;
    sublettingAllowed: bool;
  };
+type TA6Response = 
+ record {
+   answer: TA6Answer;
+   details: opt text;
+ };
 type TA6PropertyInformation = 
  record {
-   alterations: opt TA6Alterations;
-   boundaries: text;
-   boundaryDisputes: opt TA6BoundaryDisputes;
    completedAt: opt int;
    completedBy: principal;
-   connectionAgreements: text;
-   disputes: opt TA6Disputes;
-   environmentalDetails: text;
-   environmentalIssues: vec text;
-   estateManagement: opt TA6EstateManagement;
-   guarantees: text;
-   insurance: text;
+   formVersion: text;
+   jurisdiction: Jurisdiction;
    lastModifiedAt: int;
    lastModifiedBy: principal;
-   notices: opt TA6Notices;
-   otherInformation: text;
-   parkingDetails: text;
-   parkingSpaces: nat;
-   rightsAndEasements: text;
-   services: text;
- };
-type TA6Notices = 
- record {
-   details: text;
-   noticeType: text;
- };
-type TA6EstateManagement = 
- record {
-   annualCharge: nat;
-   isManaged: bool;
-   managementCompany: text;
- };
-type TA6Disputes = 
- record {
-   details: text;
-   disputeType: text;
- };
-type TA6BoundaryDisputes = 
- record {
-   details: text;
-   hasDisputes: bool;
+   section1: Section1PropertyAndSeller;
+   section10: Section10Parking;
+   section11: Section11Services;
+   section12: Section12Connections;
+   section13: Section13Transaction;
+   section14: Section14Completion;
+   section15: Section15AdditionalInfo;
+   section2: Section2Boundaries;
+   section3: Section3Disputes;
+   section4: Section4Notices;
+   section5: Section5Alterations;
+   section6: Section6Guarantees;
+   section7: Section7Insurance;
+   section8: Section8Environmental;
+   section9: Section9Rights;
+ };
+type TA6Document = 
+ variant {
+   Attached: nat;
+   NotApplicable;
+   NotAvailable;
+   ToFollow;
  };
-type TA6Alterations = 
- record {
-   details: text;
-   hasAlterations: bool;
-   requiresPermission: bool;
+type TA6Answer = 
+ variant {
+   No;
+   NotApplicable;
+   NotKnown;
+   Yes;
  };
 type TA10Room = 
  record {
@@ -228,6 +232,198 @@ type SolicitorRecord =
    tasks: vec SolicitorTask;
    verified: bool;
  };
+type SolicitorContact = 
+ record {
+   address: text;
+   contactName: text;
+   email: opt text;
+   firmName: text;
+   phone: opt text;
+   postcode: text;
+ };
+type SolarPower = 
+ record {
+   electricityBill: TA6Document;
+   fitOrSegAgreement: TA6Document;
+   installDate: opt text;
+   mcsCertificate: TA6Document;
+   ownedOutright: opt bool;
+   supplyAgreement: TA6Document;
+ };
+type SewerageSystem = 
+ record {
+   dischargeType: opt DischargeType;
+   infiltrationSystem: TA6Answer;
+   lastServiceDate: opt text;
+   location: opt text;
+   otherDetails: opt text;
+   regulationCompliant: TA6Answer;
+   source: SewerageSource;
+ };
+type SewerageSource = 
+ variant {
+   Cesspool;
+   Mains;
+   Other;
+   SepticTank;
+   SewageTreatmentPlant;
+ };
+type SellerRole = 
+ variant {
+   Administrator;
+   Attorney;
+   Executor;
+   Seller;
+   Trustee;
+ };
+type SellerParty = 
+ record {
+   fullName: text;
+   ownershipOrAuthorityDate: opt text;
+   role: SellerRole;
+ };
+type Section9Rights = 
+ record {
+   q9_1Rights: vec Right;
+   q9_1RightsExercised: TA6Response;
+   q9_2Amount: opt nat;
+   q9_2Contributions: TA6Response;
+   q9_3Disagreements: TA6Response;
+   q9_4OthersRights: TA6Response;
+   q9_4Rights: vec Right;
+   q9_5Amount: opt nat;
+   q9_5ContributionsReceived: TA6Response;
+   q9_6Disagreements: TA6Response;
+   q9_7CrossingOtherProperty: TA6Response;
+   q9_8LeadingToOthers: TA6Response;
+   q9_9Arrangement: opt Arrangement;
+ };
+type Section8Environmental = 
+ record {
+   q8_1Flooded: TA6Response;
+   q8_2FloodDefences: TA6Response;
+   q8_3RadonTest: TA6Response;
+   q8_4RadonMeasures: TA6Response;
+   q8_5CurrentBill: TA6Document;
+   q8_5GreenDeal: TA6Response;
+   q8_6JapaneseKnotweed: TA6Response;
+   q8_7KnotweedSurvey: TA6Answer;
+   q8_7SurveyDocument: TA6Document;
+ };
+type Section7Insurance = 
+ record {
+   q7_1DoYouInsure: TA6Answer;
+   q7_1WhoInsuresIfNot: opt text;
+   q7_2DifficultOrSpecialConditions: TA6Response;
+   q7_3Claims: TA6Response;
+ };
+type Section6Guarantees = 
+ record {
+   q6_1CentralHeating: WarrantyItem;
+   q6_1DampProofing: WarrantyItem;
+   q6_1ElectricalWork: WarrantyItem;
+   q6_1NewHomeWarranty: WarrantyItem;
+   q6_1Other: WarrantyItem;
+   q6_1OtherDetails: opt text;
+   q6_1Roofing: WarrantyItem;
+   q6_1TimberTreatment: WarrantyItem;
+   q6_1Underpinning: WarrantyItem;
+   q6_1WindowsDoors: WarrantyItem;
+   q6_2Claims: TA6Response;
+   q6_3Breaches: TA6Response;
+ };
+type Section5Alterations = 
+ record {
+   q5_1Alterations: AlterationTypes;
+   q5_2Documents: vec TA6Document;
+   q5_3NonResidentialUse: TA6Response;
+   q5_4Breaches: TA6Response;
+   q5_5UnresolvedIssues: TA6Response;
+   q5_6Solar: opt SolarPower;
+   q5_7ListedBuilding: TA6Response;
+   q5_8ConservationArea: TA6Response;
+   q5_9TreePreservationOrder: TA6Response;
+ };
+type Section4Notices = 
+ record {
+   q4_1NoticesReceived: TA6Response;
+   q4_2NearbyDevelopment: TA6Response;
+   q4_3NearbyUseChange: TA6Response;
+ };
+type Section3Disputes = 
+ record {
+   q3_1ExistingDisputes: TA6Response;
+   q3_2PotentialDisputes: TA6Response;
+ };
+type Section2Boundaries = 
+ record {
+   q2_1Features: vec BoundaryFeature;
+   q2_2IrregularDescription: opt text;
+   q2_3MovedOrAltered: TA6Response;
+ };
+type Section1PropertyAndSeller = 
+ record {
+   postcode: text;
+   propertyAddress: text;
+   sellerCompany: opt CompanySeller;
+   sellers: vec SellerParty;
+   solicitor: SolicitorContact;
+   uprn: opt text;
+ };
+type Section15AdditionalInfo = 
+ record {
+   additionalNotes: opt text;
+   consentsAttachedList: opt text;
+   consentsNotAvailableList: opt text;
+   consentsToFollowList: opt text;
+   q15_1ConsentsAttached: vec TA6Document;
+ };
+type Section14Completion = 
+ record {
+   q14_1ProceedsClearCharges: TA6Response;
+   q14_2Commitments: CompletionCommitments;
+ };
+type Section13Transaction = 
+ record {
+   q13_1DependentPurchase: TA6Response;
+   q13_2MovingDateRequirements: TA6Response;
+   q13_3SellerLivesAtProperty: TA6Answer;
+   q13_4OtherOccupiers17Plus: TA6Response;
+   q13_5: TA6Response;
+   q13_6: TA6Response;
+   q13_7Occupiers: vec Occupier;
+ };
+type Section12Connections = 
+ record {
+   q12_1Connections: TA6Response;
+   q12_1Documents: vec TA6Document;
+ };
+type Section11Services = 
+ record {
+   q11_1ElectricalWorks: TA6Response;
+   q11_2Document: TA6Document;
+   q11_2ElectricalCertificates: TA6Answer;
+   q11_3Date: opt text;
+   q11_3Eicr: TA6Answer;
+   q11_3Report: TA6Document;
+   q11_4HeatingSystems: vec HeatingSystem;
+   q11_5MainsConnections: MainsConnections;
+   q11_6SewerageSource: SewerageSource;
+   q11_7SewerageSystem: opt SewerageSystem;
+ };
+type Section10Parking = 
+ record {
+   q10_1Arrangements: vec ParkingType;
+   q10_1Details: opt text;
+   q10_2PermitRequired: TA6Response;
+   q10_3EvChargingPoint: TA6Response;
+   q10_3InstallConsent: TA6Document;
+ };
+type Right = 
+ record {
+   description: text;
+   overProperty: opt text;
+ };
 type Result_9 = 
  variant {
    err: text;
@@ -266,12 +462,20 @@ type Result_3 =
    err: text;
    ok: OfficialSearchResult;
  };
+type Result_20 = 
+ variant {
+   err: text;
+   ok: record {
+         registrations: nat;
+         transactions: nat;
+       };
+ };
 type Result_2 = 
  variant {
    err: text;
    ok: TransactionParty;
  };
-type Result_18 = 
+type Result_19 = 
  variant {
    err: text;
    ok: record {
@@ -279,11 +483,16 @@ type Result_18 =
          text;
        };
  };
-type Result_17 = 
+type Result_18 = 
  variant {
    err: text;
    ok: Phase;
  };
+type Result_17 = 
+ variant {
+   err: text;
+   ok: NextStepRecommendation;
+ };
 type Result_16 = 
  variant {
    err: text;
@@ -371,6 +580,16 @@ type PartyProgress =
    parties: vec TransactionParty;
    totalParties: nat;
  };
+type ParkingType = 
+ variant {
+   Allocated;
+   Driveway;
+   Garage;
+   None;
+   OnRoad;
+   Other;
+   Permit;
+ };
 type OfficialSearchResult = 
  record {
    advisoryEntries: vec text;
@@ -380,6 +599,12 @@ type OfficialSearchResult =
    priorityExpiry: text;
    registerChanged: bool;
  };
+type Occupier = 
+ record {
+   age: opt nat;
+   consentToSale: TA6Document;
+   fullName: text;
+ };
 type Notification = 
  record {
    createdAt: Time;
@@ -392,6 +617,30 @@ type Notification =
    transactionId: text;
    uploadedBy: principal;
  };
+type NextStepRecommendation = 
+ record {
+   blocker: text;
+   blockerLabel: text;
+   options: vec NextStepOption;
+   partial: bool;
+   urgency: Urgency;
+   why: text;
+ };
+type NextStepOption = 
+ record {
+   action: text;
+   displayLabel: text;
+   estimatedDelayIfSkipped: opt nat;
+   whyThis: text;
+ };
+type MainsConnections = 
+ record {
+   broadband: TA6Answer;
+   electricity: TA6Answer;
+   gas: TA6Answer;
+   sewerage: TA6Answer;
+   water: TA6Answer;
+ };
 type LandRegistryStatus = 
  variant {
    application_received;
@@ -441,6 +690,62 @@ type LandRegistryIntegration =
    submittedToLRAt: opt int;
    totalLRCosts: nat;
  };
+type Jurisdiction = 
+ variant {
+   England;
+   Wales;
+ };
+type HeatingType = 
+ variant {
+   DistrictHeating;
+   Electric;
+   GasCentral;
+   HeatPumpAir;
+   HeatPumpGround;
+   Lpg;
+   Oil;
+   Other;
+   SolarThermal;
+   SolidFuel;
+ };
+type HeatingSystem = 
+ record {
+   certificate: TA6Document;
+   heatingType: HeatingType;
+   installDate: opt text;
+   lastServiceDate: opt text;
+   otherDetails: opt text;
+ };
+type DischargeType = 
+ variant {
+   GroundWater;
+   SurfaceWater;
+ };
+type CompletionCommitments = 
+ record {
+   leaveServiceInfo: TA6Answer;
+   removeSellersItems: TA6Answer;
+   vacantPossession: TA6Answer;
+ };
+type CompanySeller = 
+ record {
+   companyName: text;
+   companyNumber: text;
+   countryOfIncorporation: text;
+   director: text;
+ };
+type BoundaryOwnership = 
+ variant {
+   NotKnown;
+   OwnedByNeighbour;
+   OwnedBySeller;
+   Shared;
+ };
+type BoundaryFeature = 
+ record {
+   ownership: BoundaryOwnership;
+   position: text;
+ };
 type BotConnection = 
  record {
    addedAt: int;
@@ -448,6 +753,12 @@ type BotConnection =
    name: text;
    "principal": principal;
  };
+type Arrangement = 
+ record {
+   contributionAmount: opt nat;
+   description: text;
+   document: TA6Document;
+ };
 type ApplicationStatusUpdate = 
  record {
    applicationReference: text;
@@ -457,6 +768,19 @@ type ApplicationStatusUpdate =
    previousStatus: LandRegistryStatus;
    statusChanged: bool;
  };
+type AlterationTypes = 
+ record {
+   changeOfUse: bool;
+   conservatory: bool;
+   extension: bool;
+   garageConversion: bool;
+   internalWallsRemoved: bool;
+   loftConversion: bool;
+   other: bool;
+   otherDetails: opt text;
+   structuralRoofWorks: bool;
+   windowsPost2002: bool;
+ };
 type AMLStatus = 
  variant {
    not_started;
@@ -473,6 +797,7 @@ service : {
    (Result);
   assignSolicitorRecord: (transactionId: text, solicitorRecord:
    SolicitorRecord) -> (Result_1);
+  backfillTransactionMembers: () -> (Result_20);
   bootstrapDocumentStorageCanister: (canisterId: principal) -> (Result);
   canAccessTransaction: (transactionId: text) -> (bool) query;
   connectBot: (transactionId: text, botPrincipal: principal, botName:
@@ -492,7 +817,7 @@ service : {
    postcode: text, titleNumber: text, seller: principal, previousOwner: 
    text, amount: nat64, transactionType: text, userRole: text, propertyType:
    text, propertyCategory: text, mode: text, deposit: nat64, mortgageAmount:
-   nat64, completionDate: text) -> (Result_18);
+   nat64, completionDate: text) -> (Result_19);
   deleteTransaction: (transactionId: text) -> (Result);
   disconnectBot: (transactionId: text, botPrincipal: principal) -> (Result_1);
   doesTransactionExist: (transactionId: text) -> (bool) query;
@@ -501,17 +826,20 @@ service : {
                                   text;
                                 }) query;
   getAllTransactions: () -> (vec Transaction) query;
-  getCurrentPhase: (transactionId: text) -> (Result_17) query;
+  getCurrentPhase: (transactionId: text) -> (Result_18) query;
   getCycles: () -> (nat) query;
   getDocumentStorageCanister: () -> (opt principal) query;
   getExpiringSearches: (withinDays: nat) -> (vec Transaction) query;
   getFlowState: (transactionId: text) -> (opt text) query;
   getInviteCode: (transactionId: text) -> (Result) query;
+  getLandRegistryCanister: () -> (text) query;
   getLandRegistryDetail: (transactionID: text) ->
    (opt LandRegistryIntegration) query;
+  getLedgerManagerCanister: () -> (text) query;
   getListingData: (transactionId: text) -> (opt text) query;
   getMyNotifications: () -> (vec Notification) query;
   getMyTransactions: () -> (vec Transaction) query;
+  getNextStep: (id: text) -> (Result_17) composite_query;
   getOutstandingRequisitions: () -> (vec record {
                                            text;
                                            Requisition;
@@ -519,6 +847,7 @@ service : {
   getPartyProgress: (transactionId: text) -> (Result_16) query;
   getPendingLRApplications: () -> (vec Transaction) query;
   getPhaseMilestones: (transactionId: text) -> (Result_15) query;
+  getPropertyRegistryCanister: () -> (text) query;
   getSolicitorStatus: (transactionId: text) -> (Result_14) query;
   getTA10: (txId: text) -> (Result_13) query;
   getTA6: (txId: text) -> (Result_12) query;
@@ -542,27 +871,83 @@ service : {
    (opt TransactionTimeline) query;
   initiate_blockchain_completion: (transactionID: text, buyerFundsHash: 
    text, completionStatementHash: text) -> (Result);
+  joinAsBotByInviteCode: (inviteCode: text, botName: text) -> (Result_6);
   joinTransactionByInviteCode: (inviteCode: text) -> (Result_6);
+  joinTransactionByInviteCodeAsBuyer: (inviteCode: text) -> (Result_6);
+  /// Caller-initiated removal from a transaction they joined but didn't
+  /// create. Counterpart to `removeParty` (which is seller/admin-driven and
+  /// gated against primary parties) — this is the "I want out" path for a
+  /// joined buyer or any other access-list member.
+  /// 
+  /// Gates:
+  ///   - Anonymous callers rejected outright.
+  ///   - Seller / createdBy cannot leave their own transaction (they
+  ///     dispose via deleteTransaction).
+  ///   - Caller must currently have access to the transaction.
+  ///   - Locked after contract exchange (same posture as assignBuyer):
+  ///     once the deal is signed nobody walks away by toggling a button.
+  /// 
+  /// Effects:
+  ///   - Caller is removed from `accessList`.
+  ///   - If the caller is the assigned buyer (`txn.buyer == msg.caller`),
+  ///     the buyer slot is reset to the seller placeholder, matching the
+  ///     sentinel state that `assignBuyer` checks for. The transaction
+  ///     re-enters the "Awaiting buyer" state and the invite code is
+  ///     reusable by a new joiner.
+  ///   - Audit event `buyer_left` (or `party_left` for non-buyer leavers)
+  ///     is logged via the existing ledger pattern.
+  /// 
+  /// Concurrency: uses the same acquireTxLock/finally releaseTxLock
+  /// posture as assignBuyer so a leave can't race against an in-flight
+  /// stage write.
+  leaveTransaction: (transactionId: text) -> (Result);
   linkTransactionToChain: (myTransactionId: text, buyingTransactionId:
    text) -> (Result_1);
   markAllNotificationsRead: () -> (nat);
   markContractDrafted: (transactionId: text) -> (Result_1);
   markNotificationRead: (notificationId: nat) -> (Result_1);
   markSearchesOrdered: (transactionId: text) -> (Result_1);
+  /// Heal developer-plot transactions whose `seller` doesn't match the
+  /// org's current developer principal. Two cases this addresses:
+  ///   1. Pre-migration txs (seller = buyer placeholder) created before the
+  ///      developer-on-chain work landed.
+  ///   2. Stale-pin txs where the org's pinned principal changed after the
+  ///      tx was created (e.g. admin password reset → new ICP key, or org
+  ///      ownership transferred to a different admin).
+  /// 
+  /// Idempotent over the target: re-running with the same developerPrincipal
+  /// returns an error (already at target), so admin-driven backfill scripts
+  /// don't silently re-touch state. Always rejects:
+  ///   - non-development mode txs
+  ///   - developerPrincipal == buyer (would break Principal.equal checks)
+  ///   - anonymous principal
+  migrateDevPlotSeller: (transactionId: text, developerPrincipal:
+   principal) -> (Result);
   onDocumentRegistered: (transactionId: text, docType: text, documentHash:
    text, uploadedBy: principal) -> ();
   on_blockchain_completion_success: (transactionID: text) -> (Result);
   pollAllPendingApplications: () -> (Result_5);
   pollApplicationStatus: (transactionID: text) -> (Result_4);
+  /// Closes #31 (TOCTOU): per-transaction lock blocks concurrent solicitors
+  /// from racing to record exchange while canModifyTransaction await is in flight.
   recordContractExchange: (transactionID: text, buyerSolicitorSignature:
    text, sellerSolicitorSignature: text) -> (Result);
+  recordConveyancerSelected: (txId: text, conveyancerId: text,
+   acceptedQuoteHash: text, finalAmountPence: nat) -> (Result_1);
   recordFormUpload: (txId: text, formType: text, fileHash: text, fileName:
    text) -> (Result_1);
   /// Record a single party's signature on-chain.
   /// The canister identifies the caller as buyer or seller from the transaction principals.
   /// When both parties have signed, the status auto-advances to #exchanged.
+  /// Closes #31 (TOCTOU): per-transaction lock blocks concurrent mutation
+  /// (buyer + seller racing to sign) while canModifyTransaction await is in flight.
   recordPartySignature: (transactionID: text, signatureHash: text,
    signingRole: text) -> (Result);
+  recordQuoteReceived: (txId: text, conveyancerId: text, quoteHash: text,
+   quotedAmountPence: nat) -> (Result_1);
+  recordQuoteRequested: (txId: text, conveyancerId: text) -> (Result_1);
+  /// Closes #31 (TOCTOU): per-transaction lock blocks concurrent mutation
+  /// while the isAdmin await is in flight.
   recordRequisition: (transactionID: text, requisition: Requisition) ->
    (Result_1);
   removeParty: (transactionId: text, partyPrincipal: principal) -> (Result_1);
@@ -571,12 +956,17 @@ service : {
                                                  seller;
                                                }) -> (Result_1);
   requestOfficialSearch: (transactionID: text) -> (Result_3);
+  /// Closes #31 (TOCTOU): per-transaction lock blocks concurrent mutation
+  /// while canModifyTransaction await is in flight.
   respondToRequisition: (transactionID: text, requisitionId: text,
    responseText: text, _supportingDocumentHashes: vec text) -> (Result_1);
   revokeBuyer: (transactionId: text, buyerPrincipal: principal) -> (Result);
   setDocumentStorageCanister: (canisterId: principal) -> (Result);
   setFlowState: (transactionId: text, jsonData: text) -> (Result);
+  setLandRegistryCanister: (canisterId: text) -> (Result);
+  setLedgerManagerCanister: (canisterId: text) -> (Result);
   setListingData: (transactionId: text, jsonData: text) -> (Result);
+  setPropertyRegistryCanister: (canisterId: text) -> (Result);
   setUserManagementCanister: (canisterId: text) -> (Result);
   trigger_land_registry_submission: (transactionID: text) -> (Result);
   updatePartyAMLDoc: (transactionId: text, partyPrincipal: principal,
@@ -592,7 +982,8 @@ service : {
   updateTA10: (txId: text, data: TA10FittingsAndContents) -> (Result_1);
   updateTA6: (txId: text, data: TA6PropertyInformation) -> (Result_1);
   updateTA7: (txId: text, data: TA7LeaseholdInformation) -> (Result_1);
-  updateTransactionStatus: (transactionId: nat, newStatus: text) -> (bool);
+  updateTitleNumber: (transactionId: text, newTitleNumber: text) -> (Result);
+  updateTransactionStatus: (_transactionId: nat, _newStatus: text) -> (bool);
   update_land_registry_status: (transactionID: text, lrStatus:
    LandRegistryStatus, confirmationNumber: opt text, estimatedCompletionTime:
    opt int) -> (Result);