@circle-fin/usdckit 0.20.0 → 0.20.1

package/README.md

@@ -4,29 +4,29 @@
 
 USDCKit is a Node.js SDK that streamlines interactions with USDC. With USDCKit, you can integrate USDC into your applications and enable secure and efficient blockchain transactions. USDCKit aims to provide multi-chain fund orchestration features to enable USDC payment use cases like crypto acquiring (C2B), payroll (B2C), remittance (C2C), and B2B cross-border payments.
 
-The SDK is compatible with popular open-source clients like viem, web3.js, and ethers.js, and can also function as a standalone client. The SDK is built with TypeScript and supports high-level use cases involving USDC, making it an important tool for developers working with digital currencies.
+The SDK is built with TypeScript and supports high-level use cases involving stablecoins, making it an important tool for developers working with digital currencies.
 
 This guide will help you get started quickly and efficiently, whether you're building a wallet, a payment gateway, or anything in between. It covers the following items:
 
 - [Benefits of using USDCKit](#benefits-of-using-usdckit)
 - [Quickstart to write your first line of code using USDCKit](#quickstart-steps)
-- [Sample Code to run USDC Acquiring Flow](./documents/Solutions.USDC_Acquiring_Flow.html)
+- [Sample Code to run Stablecoin Acquiring Flow](./documents/Developer_Resources.Stablecoin_Acquiring_Flow.html)
 
 ### Benefits of Using USDCKit
 
-- **Faster time-to-market**. USDCKit simplifies accepting and managing USDC payments with minimal code. It provides reusable payment modules and removes technical complexities for faster integration.
-- **Payment Focused**. USDCKit is built to offer all the features and tools required to create a complete end-to-end USDC payment flow, with functionalities tailored for payment use cases. It also includes sample code for specific payment products, making it easier to develop your own. The focus of the current release is USDC Acquiring use case.
+- **Faster time-to-market**. USDCKit simplifies accepting and managing stablecoin payments with minimal code. It provides reusable payment modules and removes technical complexities for faster integration.
+- **Payment Focused**. USDCKit is built to offer all the features and tools required to create a complete end-to-end stablecoin payment flow, with functionalities tailored for payment use cases. It also includes sample code for specific payment products, making it easier to develop your own. The focus of the current release is Stablecoin Acquiring use case.
 - **Scalable payments without bottlenecks**. Process millions of transactions efficiently with USDCKit’s high-performance infrastructure.‍
 - **Enterprise-grade compliance management**. Adhere to global regulatory standards with real-time transaction screening through Compliance Engine.‍
 
 #### Key features
 
-Besides basic wallet management, transfers, and balance queries, USDCKit supports the following features:
+Besides basic wallet management, transfers, and balance queries, here are some of the other highlighted features that USDCKit supports that facilitate the orchestration of on-chain fund flow:
 
 - **Fund sweeping**: Automate fund aggregation with many-to-1 transfers and optimize gas efficiency.
 - **Cross-chain transfer**: Transfer funds between wallets on different chains.
-- **Transaction screening**: Prevent wallets from transacting with OFAC sanctioned addresses
-- **Wallet filtering**: Query and filter wallets by balance threshold.
+- **Token Swap**: Convert one token type into another seamlessly.
+- **Transaction screening**: Prevent wallets from transacting with OFAC sanctioned addresses.
 
 ## Quickstart Steps
 
@@ -85,9 +85,14 @@ const client = createCircleClient({
 
 To create a new account (also known as wallet), use the [createAccount](./functions/providers_circle-wallets.createAccount.html) method. This will generate a new account that you can use for various operations such as transferring tokens and retrieving balances.
 
+USDCKit currently supports the creation of **EOA** (Externally-Owned-Account) and **SCA** (Smart-Contract-Account). Refer to this [page](./documents/Developer_Resources.Account_Type_and_Gas_Fee_Management.html) to understand more and select the most appropriate account type for your business.
+
 ```typescript
-// Creates an account on the default chain ETH_SEPOLIA
+// Creates an account on the default chain ETH_SEPOLIA (EOA)
 const account = await client.createAccount()
+
+// Creates an account on the ARB_SEPOLIA (SCA)
+const account = await client.createAccount({ accountType: 'SCA', chain: ARB_SEPOLIA })
 ```
 
 ### Query for accounts
@@ -136,11 +141,30 @@ const transaction_native = await client.transfer({
 const transaction_usdc = await client.transfer({
   from: account,
   to: anotherAccount,
-  token: client.chain.contracts.USDC,
+  token: ETH_SEPOLIA.contracts.USDC,
+  amount: '0.01',
+  chain: ETH_SEPOLIA,
+})
+
+// Create Transfer - EURC
+const transaction_eurc = await client.transfer({
+  from: account,
+  to: anotherAccount,
+  token: ETH_SEPOLIA.contracts.EURC,
   amount: '0.01',
+  chain: ETH_SEPOLIA,
 })
 
-// Create Transfer - Cross chain USDC
+// Create Transfer - USDT
+const transaction_usdt = await client.transfer({
+  from: account,
+  to: anotherAccount,
+  token: '0xdac17f958d2ee523a2206206994597c13d831ec7',
+  amount: '0.01',
+  chain: ETH,
+})
+
+// Create Transfer - Cross chain transfer (only supported for USDC)
 const transaction_usdc = await client.transfer({
   from: accountOnETH_SEPOLIA,
   to: accountOnMATIC_AMOY,
@@ -211,17 +235,21 @@ const client = createClient({
 
 ```
 
-## Sample Code to run USDC Acquiring Flow
+## Samples
+
+### Sample Code to run Stablecoin Acquiring Flow
+
+Our sample code on the Stablecoin Acquiring Flow demonstrates the architecture and technical implementation of a typical acquiring platform. It guides you through the process to set up different wallets to collect stablecoin payments, and also to use different SDK methods to orchestrate the fund flow.
 
-For more details on how to run an end-to-end USDC Acquiring Flow to support your business, refer to the [USDC Acquiring Flow sample code](./documents/Solutions.USDC_Acquiring_Flow.html)
+- Refer to the [Stablecoin Acquiring Flow sample code](./documents/Developer_Resources.Stablecoin_Acquiring_Flow.html)
 
 ## Future Plans
 
-The current private release marks the first version of USDCKit, and we recognize that additional tools are needed to create a smooth USDC payment experience. As such, we are actively working on several modules and would greatly appreciate your feedback. Our roadmap includes, but is not limited to, the following:
+The current private release marks the first version of USDCKit, and we recognize that additional tools are needed to create a smooth stablecoin payment experience. As such, we are actively working on several modules and would greatly appreciate your feedback. Our roadmap includes, but is not limited to, the following:
 
-- Swap between USDC and other tokens
-- Mass Payout of USDC
 - Gas Efficiency Enhancement
+- Mass Payout of Funds
+- Pull Payment/Subscription Payment
 
 ## Feedback & Support
 

package/dist/cjs/metadata.js

@@ -14,5 +14,5 @@ exports.VERSION = void 0;
 /**
  * The current semantic version of the SDK
  */
-exports.VERSION = `${'0.20.0' || '0.0.0'}`;
+exports.VERSION = `${'0.20.1' || '0.0.0'}`;
 //# sourceMappingURL=metadata.js.map

package/dist/esm/metadata.js

@@ -11,5 +11,5 @@
 /**
  * The current semantic version of the SDK
  */
-export const VERSION = `${'0.20.0' || '0.0.0'}`;
+export const VERSION = `${'0.20.1' || '0.0.0'}`;
 //# sourceMappingURL=metadata.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@circle-fin/usdckit",
-  "version": "0.20.0",
+  "version": "0.20.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/circlefin/w3s-node-sdk.git"
@@ -17,7 +17,7 @@
     "@inquirer/prompts": "^7.5.3",
     "axios": "^1.9.0",
     "commander": "^14.0.0",
-    "pino": "^9.6.0",
+    "pino": "~9.7.0",
     "uuid": "^11.0.3",
     "viem": "^2.23.13"
   },