Name audit for 0.24 release (payjoin#803)

Author: arminsabouri

payjoin-cli/src/app/v2/mod.rs

@@ -5,9 +5,9 @@ use payjoin::bitcoin::consensus::encode::serialize_hex;
 use payjoin::bitcoin::{Amount, FeeRate};
 use payjoin::persist::OptionalTransitionOutcome;
 use payjoin::receive::v2::{
-    process_err_res, replay_event_log as replay_receiver_event_log, MaybeInputsOwned,
+    process_err_res, replay_event_log as replay_receiver_event_log, Initialized, MaybeInputsOwned,
     MaybeInputsSeen, OutputsUnknown, PayjoinProposal, ProvisionalProposal, Receiver,
-    ReceiverTypeState, SessionHistory, UncheckedProposal, WantsInputs, WantsOutputs, WithContext,
+    ReceiverTypeState, SessionHistory, UncheckedProposal, WantsInputs, WantsOutputs,
 };
 use payjoin::send::v2::{
     replay_event_log as replay_sender_event_log, Sender, SenderBuilder, SenderTypeState,
@@ -114,7 +114,7 @@ impl AppTrait for App {
         println!("Request Payjoin by sharing this Payjoin Uri:");
         println!("{}", pj_uri);
 
-        self.process_receiver_session(ReceiverTypeState::WithContext(session.clone()), &persister)
+        self.process_receiver_session(ReceiverTypeState::Initialized(session.clone()), &persister)
             .await?;
         Ok(())
     }
@@ -251,7 +251,7 @@ impl App {
 
     async fn long_poll_fallback(
         &self,
-        session: Receiver<WithContext>,
+        session: Receiver<Initialized>,
         persister: &ReceiverPersister,
     ) -> Result<Receiver<UncheckedProposal>> {
         let ohttp_relay = self
@@ -287,7 +287,7 @@ impl App {
     ) -> Result<()> {
         let res = {
             match session {
-                ReceiverTypeState::WithContext(proposal) =>
+                ReceiverTypeState::Initialized(proposal) =>
                     self.read_from_directory(proposal, persister).await,
                 ReceiverTypeState::UncheckedProposal(proposal) =>
                     self.check_proposal(proposal, persister).await,
@@ -307,7 +307,7 @@ impl App {
                     self.send_payjoin_proposal(proposal, persister).await,
                 ReceiverTypeState::Uninitialized(_) =>
                     return Err(anyhow!("Uninitialized receiver session")),
-                ReceiverTypeState::TerminalState =>
+                ReceiverTypeState::TerminalFailure =>
                     return Err(anyhow!("Terminal receiver session")),
             }
         };
@@ -331,7 +331,7 @@ impl App {
     #[allow(clippy::incompatible_msrv)]
     async fn read_from_directory(
         &self,
-        session: Receiver<WithContext>,
+        session: Receiver<Initialized>,
         persister: &ReceiverPersister,
     ) -> Result<()> {
         let mut interrupt = self.interrupt.clone();

payjoin-ffi/python/test/test_payjoin_integration_test.py

@@ -61,7 +61,7 @@ def setUpClass(cls):
         cls.sender = cls.env.get_sender()
 
     async def process_receiver_proposal(self, receiver: ReceiverTypeState, recv_persister: InMemoryReceiverSessionEventLog, ohttp_relay: Url) -> Optional[ReceiverTypeState]:
-        if receiver.is_WITH_CONTEXT():
+        if receiver.is_INITIALIZED():
             res = await self.retrieve_receiver_proposal(receiver.inner, recv_persister, ohttp_relay)
             if res is None:
                 return None
@@ -87,11 +87,11 @@ async def process_receiver_proposal(self, receiver: ReceiverTypeState, recv_pers
         raise Exception(f"Unknown receiver state: {receiver}")
 
 
-    def create_receiver_context(self, receiver_address: bitcoinffi.Address, directory: Url, ohttp_keys: OhttpKeys, recv_persister: InMemoryReceiverSessionEventLog) -> WithContext:
+    def create_receiver_context(self, receiver_address: bitcoinffi.Address, directory: Url, ohttp_keys: OhttpKeys, recv_persister: InMemoryReceiverSessionEventLog) -> Initialized:
         receiver = UninitializedReceiver().create_session(address=receiver_address, directory=directory.as_string(), ohttp_keys=ohttp_keys, expire_after=None).save(recv_persister)
         return receiver
 
-    async def retrieve_receiver_proposal(self, receiver: WithContext, recv_persister: InMemoryReceiverSessionEventLog, ohttp_relay: Url):
+    async def retrieve_receiver_proposal(self, receiver: Initialized, recv_persister: InMemoryReceiverSessionEventLog, ohttp_relay: Url):
         agent = httpx.AsyncClient()
         request: RequestResponse = receiver.extract_req(ohttp_relay.as_string())
         response = await agent.post(
@@ -150,7 +150,7 @@ async def test_integration_v2_to_v2(self):
             recv_persister = InMemoryReceiverSessionEventLog(1)
             sender_persister = InMemorySenderPersister(1)
             session = self.create_receiver_context(receiver_address, directory, ohttp_keys, recv_persister)
-            process_response = await self.process_receiver_proposal(ReceiverTypeState.WITH_CONTEXT(session), recv_persister, ohttp_relay)
+            process_response = await self.process_receiver_proposal(ReceiverTypeState.INITIALIZED(session), recv_persister, ohttp_relay)
             print(f"session: {session.to_json()}")
             self.assertIsNone(process_response)
 
@@ -173,7 +173,7 @@ async def test_integration_v2_to_v2(self):
             # Inside the Receiver:
 
             # GET fallback psbt
-            payjoin_proposal = await self.process_receiver_proposal(ReceiverTypeState.WITH_CONTEXT(session), recv_persister, ohttp_relay)
+            payjoin_proposal = await self.process_receiver_proposal(ReceiverTypeState.INITIALIZED(session), recv_persister, ohttp_relay)
             self.assertIsNotNone(payjoin_proposal)
             self.assertEqual(payjoin_proposal.is_PAYJOIN_PROPOSAL(), True)
 

payjoin-ffi/python/test/test_payjoin_unit_test.py

@@ -57,7 +57,7 @@ def test_receiver_persistence(self):
             None
         ).save(persister)
         result = payjoin.payjoin_ffi.replay_receiver_event_log(persister)
-        self.assertTrue(result.state().is_WITH_CONTEXT())
+        self.assertTrue(result.state().is_INITIALIZED())
 
 class InMemorySenderPersister(payjoin.payjoin_ffi.JsonSenderSessionPersister):
     def __init__(self, id):

payjoin-ffi/src/receive/mod.rs

@@ -62,7 +62,7 @@ pub struct InitInputsTransition(
             Option<
                 payjoin::persist::MaybeBadInitInputsTransition<
                     payjoin::receive::v2::SessionEvent,
-                    payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext>,
+                    payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized>,
                     payjoin::IntoUrlError,
                 >,
             >,
@@ -71,7 +71,7 @@ pub struct InitInputsTransition(
 );
 
 impl InitInputsTransition {
-    pub fn save<P>(&self, persister: &P) -> Result<WithContext, ReceiverPersistedError>
+    pub fn save<P>(&self, persister: &P) -> Result<Initialized, ReceiverPersistedError>
     where
         P: SessionPersister<SessionEvent = payjoin::receive::v2::SessionEvent>,
     {
@@ -98,7 +98,7 @@ impl From<UninitializedReceiver>
 }
 
 impl UninitializedReceiver {
-    /// Creates a new [`WithContext`] with the provided parameters.
+    /// Creates a new [`Initialized`] with the provided parameters.
     ///
     /// # Parameters
     /// - `address`: The Bitcoin address for the payjoin session.
@@ -107,7 +107,7 @@ impl UninitializedReceiver {
     /// - `expire_after`: The duration after which the session expires.
     ///
     /// # Returns
-    /// A new instance of [`WithContext`].
+    /// A new instance of [`Initialized`].
     ///
     /// # References
     /// - [BIP 77: Payjoin Version 2: Serverless Payjoin](https://github.com/bitcoin/bips/blob/master/bip-0077.md)
@@ -129,35 +129,35 @@ impl UninitializedReceiver {
 }
 
 #[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
-pub struct WithContext(payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext>);
+pub struct Initialized(payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized>);
 
-impl From<WithContext> for payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext> {
-    fn from(value: WithContext) -> Self { value.0 }
+impl From<Initialized> for payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized> {
+    fn from(value: Initialized) -> Self { value.0 }
 }
 
-impl From<payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext>> for WithContext {
-    fn from(value: payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext>) -> Self {
+impl From<payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized>> for Initialized {
+    fn from(value: payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized>) -> Self {
         Self(value)
     }
 }
 
-pub struct WithContextTransition(
+pub struct InitializedTransition(
     Arc<
         RwLock<
             Option<
                 payjoin::persist::MaybeFatalTransitionWithNoResults<
                     payjoin::receive::v2::SessionEvent,
                     payjoin::receive::v2::Receiver<payjoin::receive::v2::UncheckedProposal>,
-                    payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext>,
+                    payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized>,
                     payjoin::receive::Error,
                 >,
             >,
         >,
     >,
 );
 
-impl WithContextTransition {
-    pub fn save<P>(&self, persister: &P) -> Result<WithContextTransitionOutcome, ReceiverPersistedError>
+impl InitializedTransition {
+    pub fn save<P>(&self, persister: &P) -> Result<InitializedTransitionOutcome, ReceiverPersistedError>
     where
         P: SessionPersister<SessionEvent = payjoin::receive::v2::SessionEvent>,
     {
@@ -173,14 +173,14 @@ impl WithContextTransition {
     }
 }
 
-pub struct WithContextTransitionOutcome(
+pub struct InitializedTransitionOutcome(
     payjoin::persist::OptionalTransitionOutcome<
         payjoin::receive::v2::Receiver<payjoin::receive::v2::UncheckedProposal>,
-        payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext>,
+        payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized>,
     >,
 );
 
-impl WithContextTransitionOutcome {
+impl InitializedTransitionOutcome {
     pub fn is_none(&self) -> bool { self.0.is_none() }
 
     pub fn is_success(&self) -> bool { self.0.is_success() }
@@ -194,21 +194,21 @@ impl
     From<
         payjoin::persist::OptionalTransitionOutcome<
             payjoin::receive::v2::Receiver<payjoin::receive::v2::UncheckedProposal>,
-            payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext>,
+            payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized>,
         >,
-    > for WithContextTransitionOutcome
+    > for InitializedTransitionOutcome
 {
     fn from(
         value: payjoin::persist::OptionalTransitionOutcome<
             payjoin::receive::v2::Receiver<payjoin::receive::v2::UncheckedProposal>,
-            payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext>,
+            payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized>,
         >,
     ) -> Self {
         Self(value)
     }
 }
 
-impl WithContext {
+impl Initialized {
     pub fn extract_req(&self, ohttp_relay: String) -> Result<(Request, ClientResponse), Error> {
         self.0
             .clone()
@@ -218,15 +218,15 @@ impl WithContext {
     }
 
     ///The response can either be an UncheckedProposal or an ACCEPTED message indicating no UncheckedProposal is available yet.
-    pub fn process_res(&self, body: &[u8], ctx: &ClientResponse) -> WithContextTransition {
-        WithContextTransition(Arc::new(RwLock::new(Some(
+    pub fn process_res(&self, body: &[u8], ctx: &ClientResponse) -> InitializedTransition {
+        InitializedTransition(Arc::new(RwLock::new(Some(
             self.0.clone().process_res(body, ctx.into()),
         ))))
     }
 
     /// Build a V2 Payjoin URI from the receiver's context
     pub fn pj_uri(&self) -> crate::PjUri {
-        <Self as Into<payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext>>>::into(
+        <Self as Into<payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized>>>::into(
             self.clone(),
         )
         .pj_uri()
@@ -238,7 +238,7 @@ impl WithContext {
     }
 
     pub fn from_json(json: &str) -> Result<Self, SerdeJsonError> {
-        serde_json::from_str::<payjoin::receive::v2::Receiver<payjoin::receive::v2::WithContext>>(
+        serde_json::from_str::<payjoin::receive::v2::Receiver<payjoin::receive::v2::Initialized>>(
             json,
         )
         .map_err(Into::into)