@fileverse/heartbit-core - npm Package Compare versions

Comparing version 0.0.22 to 1.0.0

package.json

 {
   "name": "@fileverse/heartbit-core",
-  "version": "0.0.22",
+  "version": "1.0.0",
   "description": "",
@@ -5,0 +5,0 @@ "type": "module",

README.md

@@ -5,3 +5,3 @@ # HeartBit Core
 
-This is the core of the HeartBit functionality. It exposes the APIs that are crucial for implementing HeartBit functionalities.
+This is the core of the [HeartBit](https://github.com/fileverse/HeartBitSDK) functionality. It exposes the APIs that are crucial for implementing HeartBit functionalities.
 
@@ -48,3 +48,3 @@ ## Getting Started
 	const endTime = 1706898251;
-	const hash = "Hello World"; // keccak256 hash of a string
+	const hash = "Hello World"; // This is an identifier for the token, if this hash changes you mint a new token in that case
 
@@ -75,1 +75,31 @@ // Mint HeartBit
 [Here](https://codesandbox.io/p/devbox/heartbit-core-sdk-example-37h7hw) is a link to a working example using `HeartBitCore`.
+
+### Interfaces
+
+```javascript
+type SupportedChain = "0xaa36a7" | "0x2105";
+
+interface HeartBitCoreOptions {
+	chain: SupportedChain;
+	rpcUrl?: string;
+}
+
+interface TotalHeartBitCountArgs {
+	hash: string; // keccak256 hash of a string
+}
+
+interface HeartBitCountByUserArgs {
+	hash: string; // keccak256 hash of a string
+	address: string; // ethereum wallet address
+}
+
+interface MintHeartBitArgs {
+	message: string;
+	signature: string;
+	startTime: number; // in seconds
+	endTime: number; // in seconds
+	hash: string; // keccak256 hash of a string
+}
+```
+
+Checkout [HeartBit React](https://github.com/fileverse/HeartBitSDK/edit/main/packages/heartbit-react) which uses the `HeartBitCore` to integrate HeartBit functionality in a react app.

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

69412

increased by1.23%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

103

increased by41.1%

No dependency changes