search

LtbLightning / bdk-flutter

Bitcoin Development Kit - Flutter Package
MIT License
63 stars 28 forks source link

Modified README.md with docs fix #1

Closed aniketambore closed 2 years ago

aniketambore commented 2 years ago

After testing bdk-flutter, I noticed that there are several errors / typos in readme.md. The usage has been fixed.

  1. For genSeed() and getBalance() method.

    • Error: : Error: Undefined name 'BdkRn'.
    • Fix: Instead of BdkRn used BdkWallet

  2. For all the methods, response is declared as const which throws.

    • Error: : Error: Not a constant expression.
    • Fix: final response = await BdkWallet().methodName();

  3. Also, static access to instance member is not allowed, like final response = await BdkWallet.genSeed();

    • Fix: final response = await BdkWallet().genSeed();

  4. For confirmedTransactions() method.

    • Error: The method 'confirmedTransactions' isn't defined for the type 'BdkWallet'. Try correcting the name to the name of an existing method, or defining a method named 'confirmedTransactions'.
    • Fix: final response = await BdkWallet().getConfirmedTransactions();

Amazing Project, Thanks !

BitcoinZavior commented 2 years ago

@aniketambore Thanks for this, the readme has been updated a lot due to new methods added. So this PR may need to be updated. Also, I would suggest make the PR for the ffi branch if you can, as thats the branch which will be merged to main.

I am happy for you to update it and I will merge when its done. You can use this as a reference to save you some trouble: https://github.com/LtbLightning/bdk-rn/blob/main/README.md