refactor: remove default wallet name; fix README for example

README.md

@@ -24,7 +24,20 @@ This crate is still **EXPERIMENTAL** do not use with mainnet wallets.
    ```
    cargo test -- --test-threads=1
    ```
-5. Run example:
+
+## Example
+
+1. Create empty test database:
+   ```
+   psql postgres
+   postgres=# create database example_bdk_wallet;
+   postgres=# \q
+   ```
+2. Set DATABASE_URL to test database:
+   ```
+   export DATABASE_URL=postgresql://localhost/example_bdk_wallet
+   ```
+3. Run example:
    ```
    cargo run --example bdk_sqlx_postgres
    ```

examples/bdk_sqlx_postgres.rs

@@ -39,7 +39,7 @@ async fn main() -> anyhow::Result<()> {
         .with(EnvFilter::new(std::env::var("RUST_LOG").unwrap_or_else(
             |_| {
                 "sqlx=warn,\
-                    bdk_sqlx=info"
+                    bdk_sqlx=debug"
                     .into()
             },
         )))
@@ -57,7 +57,7 @@ async fn main() -> anyhow::Result<()> {
         &secp,
     )?;
     let mut store =
-        bdk_sqlx::Store::<Postgres>::new_with_url(url.clone(), Some(wallet_name)).await?;
+        bdk_sqlx::Store::<Postgres>::new_with_url(url.clone(), wallet_name).await?;
 
     let mut wallet = match Wallet::load().load_wallet_async(&mut store).await? {
         Some(wallet) => wallet,
@@ -85,7 +85,7 @@ async fn main() -> anyhow::Result<()> {
         bdk_wallet::wallet_name_from_descriptor(VAULT_DESC, Some(CHANGE_DESC), NETWORK, &secp)?;
 
     let mut store =
-        bdk_sqlx::Store::<Postgres>::new_with_url(url.clone(), Some(wallet_name)).await?;
+        bdk_sqlx::Store::<Postgres>::new_with_url(url.clone(), wallet_name).await?;
 
     let mut wallet = match Wallet::load().load_wallet_async(&mut store).await? {
         Some(wallet) => wallet,

src/postgres.rs

@@ -58,13 +58,10 @@ impl Store<Postgres> {
     #[tracing::instrument]
     pub async fn new(
         pool: Pool<Postgres>,
-        wallet_name: Option<String>,
+        wallet_name: String,
         migration: bool,
     ) -> Result<Self, BdkSqlxError> {
         info!("new store");
-
-        let wallet_name = wallet_name.unwrap_or_else(|| "bdk_pg_wallet".to_string());
-
         Ok(Self {
             pool,
             wallet_name,
@@ -76,13 +73,10 @@ impl Store<Postgres> {
     #[tracing::instrument]
     pub async fn new_with_url(
         url: String,
-        wallet_name: Option<String>,
+        wallet_name: String,
     ) -> Result<Store<Postgres>, BdkSqlxError> {
         info!("new store with url");
-
         let pool = PgPool::connect(url.as_str()).await?;
-        let wallet_name = wallet_name.unwrap_or_else(|| "bdk_pg_wallet".to_string());
-
         Ok(Self {
             pool,
             wallet_name,

src/sqlite.rs

@@ -56,13 +56,10 @@ impl Store<Sqlite> {
     #[tracing::instrument]
     pub async fn new(
         pool: Pool<Sqlite>,
-        wallet_name: Option<String>,
+        wallet_name: String,
         migration: bool,
     ) -> Result<Self, BdkSqlxError> {
         info!("new store");
-
-        let wallet_name = wallet_name.unwrap_or_else(|| "bdk_sqlites_wallet".to_string());
-
         Ok(Self {
             pool,
             wallet_name,
@@ -79,10 +76,9 @@ impl Store<Sqlite> {
     #[tracing::instrument]
     pub async fn new_with_url(
         url: Option<String>,
-        wallet_name: Option<String>,
+        wallet_name: String,
     ) -> Result<Store<Sqlite>, BdkSqlxError> {
         info!("new store with url");
-
         let pool = if let Some(url) = url {
             SqlitePool::connect(url.as_str()).await?
         } else {
@@ -95,8 +91,6 @@ impl Store<Sqlite> {
                 .connect(":memory:")
                 .await?
         };
-        let wallet_name = wallet_name.unwrap_or_else(|| "bdk_sqlite_wallet".to_string());
-
         Ok(Self {
             pool,
             wallet_name,

src/test.rs

@@ -151,13 +151,12 @@ async fn create_test_stores(wallet_name: String) -> anyhow::Result<Vec<TestStore
     let pool = Pool::<Postgres>::connect(&url.clone()).await?;
     // Drop all before creating new store for testing
     pool.drop_all().await?;
-    let postgres_store =
-        Store::<Postgres>::new_with_url(url.clone(), Some(wallet_name.clone())).await?;
+    let postgres_store = Store::<Postgres>::new_with_url(url.clone(), wallet_name.clone()).await?;
     stores.push(TestStore::Postgres(postgres_store));
 
     // Setup sqlite in-memory database
     let pool = SqlitePool::connect(":memory:").await?;
-    let sqlite_store = Store::<Sqlite>::new(pool.clone(), Some(wallet_name.clone()), true).await?;
+    let sqlite_store = Store::<Sqlite>::new(pool.clone(), wallet_name.clone(), true).await?;
     stores.push(TestStore::Sqlite(sqlite_store));
 
     Ok(stores)