@coinflowlabs/vue 0.1.0 → 0.2.1

package/README.md

@@ -0,0 +1,52 @@
+# Coinflow Vue
+
+## Withdraw
+
+Props:
+* `wallet`: The Solana Wallet Adapter Wallet
+* `merchantId`: Your Merchant ID (Contact Coinflow support for this)
+* `connection`: Solana Connection
+* `env` (optional): This defaults to `prod`
+    - For testing set to `staging`
+* `onSuccess` (optional): function to run when the withdrawal process is successful
+* `lockAmount` (optional): Whether to let the user select the amount to withdraw or to disable the input
+* `amount` (optional): The amount to withdraw - required if `lockAmount=true`
+* `tokens` (optional): Define a list to filter the available tokens
+* `lockDefaultToken` (optional): Only allow the default token to be used
+* `email` (optional): Set the default email to be used in entry fields
+* `bankAccountLinkRedirect` (optional): The URL to be used for bank account setup
+* `additionalWallets` (optional): Define additional wallets to assign to the user
+* `usePermit` (optional): Pass as false to disable permit message signing for EVM and use approve transactions
+* `transactionSigner` (optional): Public Key of the wallet which will actually execute the withdrawal transaction. Must be associated with the same withdrawer as the main wallet.
+
+## Purchase
+
+Props:
+* `wallet`: The Solana Wallet Adapter Wallet
+* `merchantId`: Your Merchant ID (Contact Coinflow support for this)
+* `connection`: Solana Connection
+* `env` (optional): This defaults to `prod`
+    - For testing set to `staging`
+* `onSuccess` (optional): function to run when the purchase process is successful
+* `transaction` (optional): transaction for the user to run which redeems their credits with your smart contract. Create this transaction just like you would for a normal user who has USDC in their account.
+* `partialSigners` (optional): Keypairs of Partial Signers to sign the transaction with, this is necessary when initializing new accounts as the new account Keypair must sign the transaction.
+* `debugTx` (optional): Setting this to `true` will sign the transaction with the wallet, and send the transaction with no preflight checks allowing for easier debug of any issues.
+* `token` (optional): The token to use for the purchase. Defaults to USDC. Currently only supported for the Solana Blockchain.
+* `planCode` (optional): When a subscription is being purchased, the code of the subscription plan.
+* `settlementType` (optional): The settlement method to use for the proceeds of a purchase. (Credits, USDC, or Bank)
+* `amount` (optional): Fix the amount of purchase
+* `webhookInfo` (optional): Product or transaction based information that you want transmitted when you receive webhooks regarding the purchase
+* `email` (optional): Set the default email to use in email entry fields
+* `chargebackProtectionData` (optional):
+* `disableApplePay` (optional): Ability to disable Apple Pay
+* `disableGooglePay` (optional): Ability to disable Google Pay
+* `customerInfo` (optional): Additional information about the customer
+* `rent` (optional, Solana only): Specify the blockchain rent amount to add to the total
+* `nativeSolToConvert` (optional, Solana only): Specify the amount of native SOL to convert wSOL for the purchase
+* `jwtToken` (optional): A JWT token which encodes verified checkout parameters to prevent spoofing of arguments.
+
+# Changelog
+
+## 1.0.0
+
+- Initial Version of the SDK