@primuslabs/fund-js-sdk 0.1.0

package/README.md

@@ -0,0 +1,10 @@
+## Primus Fund SDK
+
+The **Primus Fund SDK** provides a straightforward and simple way to send crypto to anyone’s social account, powered by **zkTLS**, to onboard more Web2 users.
+
+For details, please refer to the following links:
+
+- [Overview](./README/overview.md)
+- [How to intall the SDK](./README/install.md)
+- [Example: Funding Tokens](./README/example.md)
+- [Receiver Guide](./README/receiver-guide.md)

package/dist/index.d.mts

@@ -0,0 +1,62 @@
+type AttNetworkRequest = {
+    url: string,
+    header: string, // json string
+    method: string,
+    body: string
+}
+type AttNetworkResponseResolve = {
+    keyName: string,
+    parseType: string, //json or html
+    parsePath: string
+}
+type Attestor = {
+    attestorAddr: string,
+    url: string
+}
+type Attestation = {
+    recipient: string,
+    request: AttNetworkRequest,
+    reponseResolve: AttNetworkResponseResolve[],
+    data: string, // json string
+    attConditions: string, // json string
+    timestamp: number,
+    additionParams: string,
+    attestors: Attestor[],
+    signatures: string[],
+}
+declare global {
+    interface Window {
+        primus?: any;
+    }
+}
+
+// start
+//
+// ERC20_TYPE = 0;
+// NATIVE_TYPE = 1;
+type TokenType = 0 | 1
+type TokenInfo =
+  | { tokenType: 0; tokenAddress: string }
+  | { tokenType: 1; tokenAddress?: string }; 
+
+type  RecipientBaseInfo = {
+    socialPlatform: string;// The name of the social platform.
+    userIdentifier: string;// The user’s unique identifier on the platforms.
+}
+
+type  RecipientInfo = RecipientBaseInfo & {
+    tokenAmount: string;// The amount of the token
+    nftIds?: bigint[];// The nft token ids when token is nft.
+}
+
+type FundParam = {
+    tokenInfo: TokenInfo;
+    recipientInfos: RecipientInfo[];
+}
+
+type ClaimParam = RecipientBaseInfo & {
+    attestation: Attestation;
+    fundIndex?: number;
+}
+
+export type { AttNetworkRequest, AttNetworkResponseResolve, Attestation, Attestor, ClaimParam, FundParam, RecipientBaseInfo, RecipientInfo, TokenInfo, TokenType };

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+type AttNetworkRequest = {
+    url: string,
+    header: string, // json string
+    method: string,
+    body: string
+}
+type AttNetworkResponseResolve = {
+    keyName: string,
+    parseType: string, //json or html
+    parsePath: string
+}
+type Attestor = {
+    attestorAddr: string,
+    url: string
+}
+type Attestation = {
+    recipient: string,
+    request: AttNetworkRequest,
+    reponseResolve: AttNetworkResponseResolve[],
+    data: string, // json string
+    attConditions: string, // json string
+    timestamp: number,
+    additionParams: string,
+    attestors: Attestor[],
+    signatures: string[],
+}
+declare global {
+    interface Window {
+        primus?: any;
+    }
+}
+
+// start
+//
+// ERC20_TYPE = 0;
+// NATIVE_TYPE = 1;
+type TokenType = 0 | 1
+type TokenInfo =
+  | { tokenType: 0; tokenAddress: string }
+  | { tokenType: 1; tokenAddress?: string }; 
+
+type  RecipientBaseInfo = {
+    socialPlatform: string;// The name of the social platform.
+    userIdentifier: string;// The user’s unique identifier on the platforms.
+}
+
+type  RecipientInfo = RecipientBaseInfo & {
+    tokenAmount: string;// The amount of the token
+    nftIds?: bigint[];// The nft token ids when token is nft.
+}
+
+type FundParam = {
+    tokenInfo: TokenInfo;
+    recipientInfos: RecipientInfo[];
+}
+
+type ClaimParam = RecipientBaseInfo & {
+    attestation: Attestation;
+    fundIndex?: number;
+}
+
+export type { AttNetworkRequest, AttNetworkResponseResolve, Attestation, Attestor, ClaimParam, FundParam, RecipientBaseInfo, RecipientInfo, TokenInfo, TokenType };