@zing-protocol/zing-sdk 0.0.1 → 0.0.3

package/dist/config/mainnet.js

@@ -0,0 +1,80 @@
+// zing
+export const mainnetZingConfig = {
+    ZING_FRAMEWORK_PACKAGE_ADDRESS: "0x58c2589e21157bac347513cb4c392ffa34af0e1a630f5a77c0ee92f141057d01",
+    ZING_IDENTITY_PACKAGE_ADDRESS: "0x4a22da297adc51ec5ed6e1f4fc884a45a50d8299b8c3deb9d056392210ce951d",
+    ZING_STUDIO_PACKAGE_ADDRESS: "0x3db3853f032b5b403e35a7d863fb630359c5bec238990f52a8c33c6ac1f5222f",
+    ZING_STUDIO_V0_PACKAGE_ADDRESS: "0xf245105e9896942a02614e4dbbb6c6636452879d58b1e12db1e0364c0d1532a7",
+    ZING_TREASURY_SHARED_OBJECT_REF: {
+        objectId: "0x30f0dc6c1ad6bdf944ed303e9c966af60a3bbbef1b5b9ae3f23de1d44b02f5b6",
+        initialSharedVersion: 661729837,
+        mutable: true,
+    },
+    ZING_IDENTITY_CONFIG_SHARED_OBJECT_REF: {
+        objectId: "0xd511beaa68a5647cdc193b753f3658e8e33bc87ec603857c3d6d315562f0e470",
+        initialSharedVersion: 661729843,
+        mutable: true,
+    },
+    PROOF_COMMITMENT_TYPE: "0xd666d3234eb46551273014f5616ed2575e709a861dd3812613d59104a4cb7344::reclaim::ProofCommitment",
+    IDENTITY_PLATFORMS: {
+        twitter: {
+            PLATFORM_UPDATE_PROOF_TARGET: "0x910fd7e88647ea9369ab269fa5629f0efd815dfa5a7b7ef2355ffee13852413b::twitter::update_with_twitter_proof",
+            PLATFORM_TYPE: "0x910fd7e88647ea9369ab269fa5629f0efd815dfa5a7b7ef2355ffee13852413b::twitter::Twitter",
+            RECLAIM_MANAGER_SHARED_OBJECT_REF: {
+                objectId: "0xe8849f48412d3b7220902fd56b7f128f324ffb27615bf57e83c638f523aa10e6",
+                initialSharedVersion: 662715429,
+                mutable: true,
+            },
+            IDENTITY_MANAGER_SHARED_OBJECT_REF: {
+                objectId: "0xff54f2a3bfc4daedbbc7ecbb1b0985e8311c95fd847f070825882e7e083af5f1",
+                initialSharedVersion: 662715429,
+                mutable: true,
+            },
+            IDENTITY_MANAGER_IDENTIFIER_INFO_DF_ID: "0xcbe996d13835c0fcc9a0a015098546997ae9ff58dd075389bfe764d43bb46c2e",
+            IDENTITY_MANAGER_ADDRESS_TO_IDENTIFIER_DF_ID: "0x20ba08956972f73a956b288dde1659f9ad6059256205beb20bc3fa2cc0377ac2",
+        },
+    },
+    ZING_STUDIO_CONFIG_SHARED_OBJECT_REF: {
+        objectId: "0x9fe332fc68cb2a736a9643dc4f06089c7c4894396db0fb47895d216599ee5c00",
+        initialSharedVersion: 663114127,
+        mutable: true,
+    },
+    ZING_STORAGE_TREASURY_SHARED_OBJECT_REF: {
+        objectId: "0xd80e520d304a43b21c3d2dba2c89463819c2ef9b779c89d15e19b425b385fe74",
+        initialSharedVersion: 663114127,
+        mutable: true,
+    },
+    ZING_WORKS_TYPE: {
+        article: "0xf245105e9896942a02614e4dbbb6c6636452879d58b1e12db1e0364c0d1532a7::article::Article",
+    },
+    EVENT_TYPES: {
+        publishArticleEvent: "0xf245105e9896942a02614e4dbbb6c6636452879d58b1e12db1e0364c0d1532a7::article::PublishArticle",
+    },
+};
+// walrus
+export const mainnetWalrusConfig = {
+    WALRUS_PACKAGE: "0xfa65cb2d62f4d39e60346fb7d501c12538ca2bbc646eaa37ece2aec5f897814e",
+    WAL_STAKING_INNER_FIELD: "0x16f1f9fcdf5a746da423d1ad055d88f88b24a9272ca8afb4c0dcf074ae6c730a",
+    WALRUS_SYSTEM_SHARED_OBJECT_REF: {
+        objectId: "0x2134d52768ea07e8c43570ef975eb3e4c27a39fa6396bef985b5abc58d03ddd2",
+        initialSharedVersion: 317862159,
+        mutable: true, // mutable when register_blob
+    },
+    WALRUS_AGGREGATORS: ["https://aggregator.suicore.com"],
+    WALRUS_UPLOAD_RELAY_BASE_URL: "https://walrus-upload-relay-production-73a4.up.railway.app",
+    EVENT_TYPES: {
+        blobRegistered: "0xfdc88f7d7cf30afab2f82e8380d11ee8f70efb90e863d1de8616fae1bb09ea77::events::BlobRegistered",
+    },
+};
+// coins
+export const mainnetCoinConfig = {
+    USDC: "0xa1ec7fc00a6f40db9693ad1415d0c193ad3906494428cf252621037bd7117e29::usdc::USDC",
+};
+// seal
+export const mainnetSealConfig = {
+    serverConfigs: [
+        {
+            objectId: "0xe0eb52eba9261b96e895bbb4deca10dcd64fbc626a1133017adcd5131353fd10",
+            weight: 1,
+        },
+    ],
+};

package/dist/config/testnet.d.ts

@@ -0,0 +1,6 @@
+import type { CoinSymbol } from "./common.js";
+import type { SealConfig, WalrusConfig, ZingConfig } from "./types.js";
+export declare const testnetZingConfig: ZingConfig;
+export declare const testnetWalrusConfig: WalrusConfig;
+export declare const testnetCoinConfig: Record<CoinSymbol, string>;
+export declare const testnetSealConfig: SealConfig;

package/dist/config/testnet.js

@@ -0,0 +1,81 @@
+export const testnetZingConfig = {
+    ZING_FRAMEWORK_PACKAGE_ADDRESS: "0xd851eb5b907b60aa5fd958dd74044d809c49ee60001cad621726f03ea138f943",
+    ZING_IDENTITY_PACKAGE_ADDRESS: "0xaaf27a90890ac1efface4fbb22597e95829cbe6cbb771df02f0d2cc93f067c70",
+    ZING_STUDIO_PACKAGE_ADDRESS: "0x455bd1ba1afe47158c9155001f33b4069c9f008d091eef28f61c47c857bf60aa",
+    ZING_STUDIO_V0_PACKAGE_ADDRESS: "0x455bd1ba1afe47158c9155001f33b4069c9f008d091eef28f61c47c857bf60aa",
+    ZING_TREASURY_SHARED_OBJECT_REF: {
+        objectId: "0xca56bc3982525decbd4b025d3d4ae4de07259d6efc187577bfc3ab212e20574f",
+        initialSharedVersion: 645292716,
+        mutable: true,
+    },
+    ZING_IDENTITY_CONFIG_SHARED_OBJECT_REF: {
+        objectId: "0xde2eb80aa01db47e65b705c80af931ccb1d56a8a6a06403e205fa8fb1ad4a02e",
+        initialSharedVersion: 645292717,
+        mutable: false,
+    },
+    PROOF_COMMITMENT_TYPE: "0xaaf27a90890ac1efface4fbb22597e95829cbe6cbb771df02f0d2cc93f067c70::reclaim::ProofCommitment",
+    IDENTITY_PLATFORMS: {
+        twitter: {
+            PLATFORM_UPDATE_PROOF_TARGET: "0xa0d84dc088ba37e3108e69458c4dc0d0f836479f384fbe1fe98c737d27945c3e::twitter::update_with_twitter_proof",
+            PLATFORM_TYPE: "0xa0d84dc088ba37e3108e69458c4dc0d0f836479f384fbe1fe98c737d27945c3e::twitter::Twitter",
+            RECLAIM_MANAGER_SHARED_OBJECT_REF: {
+                objectId: "0x3d3c56359728f12f8b54e9e2f5d5861a168f7d75675b83afc7f8b9cce289bfc1",
+                initialSharedVersion: 663897156,
+                mutable: true,
+            },
+            IDENTITY_MANAGER_SHARED_OBJECT_REF: {
+                objectId: "0x44e9171b465f9bbad19864c06cec7ad24d3e830198fe10d9acc84f4e31ad59f6",
+                initialSharedVersion: 663897156,
+                mutable: true,
+            },
+            IDENTITY_MANAGER_IDENTIFIER_INFO_DF_ID: "0x69ff6f5d7e4a64d177c24ae9882e732402065eb9668f41f9337b56fea39bd46d",
+            IDENTITY_MANAGER_ADDRESS_TO_IDENTIFIER_DF_ID: "0x1073c13dfed532938cd978adfcb0b14a165350762392e0bb3137f493112d0520",
+        },
+    },
+    ZING_STUDIO_CONFIG_SHARED_OBJECT_REF: {
+        objectId: "0x4257dc4f3a3fe73e5f8d8c86c2233210876c35dc9b369f72d6aab0521733e57e",
+        initialSharedVersion: 723767900,
+        mutable: false,
+    },
+    ZING_STORAGE_TREASURY_SHARED_OBJECT_REF: {
+        objectId: "0xde26730698493f851a7d9cd4d49b5b56f6781d902d3a63e24aa1f25820924cc8",
+        initialSharedVersion: 723767900,
+        mutable: true,
+    },
+    ZING_WORKS_TYPE: {
+        article: "0x455bd1ba1afe47158c9155001f33b4069c9f008d091eef28f61c47c857bf60aa::article::Article",
+    },
+    EVENT_TYPES: {
+        publishArticleEvent: "0x455bd1ba1afe47158c9155001f33b4069c9f008d091eef28f61c47c857bf60aa::article::PublishArticleEvent",
+    },
+};
+export const testnetWalrusConfig = {
+    WALRUS_PACKAGE: "0xa998b8719ca1c0a6dc4e24a859bbb39f5477417f71885fbf2967a6510f699144",
+    WAL_STAKING_INNER_FIELD: "0x93429364cd0447556847e7e96f15c20411e9cc9769c0877e5b6e99732a73a006",
+    WALRUS_SYSTEM_SHARED_OBJECT_REF: {
+        objectId: "0x6c2547cbbc38025cf3adac45f63cb0a8d12ecf777cdc75a4971612bf97fdf6af",
+        initialSharedVersion: 400185623,
+        mutable: true, // mutable when register_blob
+    },
+    WALRUS_AGGREGATORS: ["https://aggregator.suicore.com"],
+    WALRUS_UPLOAD_RELAY_BASE_URL: "https://walrus-upload-relay-production-73a4.up.railway.app",
+    EVENT_TYPES: {
+        blobRegistered: "0xd84704c17fc870b8764832c535aa6b11f21a95cd6f5bb38a9b07d2cf42220c66::events::BlobRegistered",
+    },
+};
+// coins
+export const testnetCoinConfig = {
+    USDC: "0xa1ec7fc00a6f40db9693ad1415d0c193ad3906494428cf252621037bd7117e29::usdc::USDC",
+};
+export const testnetSealConfig = {
+    serverConfigs: [
+        {
+            objectId: "0x73d05d62c18d9374e3ea529e8e0ed6161da1a141a94d3f76ae3fe4e99356db75",
+            weight: 1,
+        },
+        {
+            objectId: "0xf5d14a81a982144ae441cd7d64b09027f116a468bd36e7eca494f750591623c8",
+            weight: 1,
+        },
+    ],
+};

package/dist/config/types.d.ts

@@ -0,0 +1,49 @@
+import type { CoinSymbol, PlatformType, WorkType } from "./common.js";
+import type { KeyServerConfig } from "@mysten/seal";
+import type { WalrusClient } from "@mysten/walrus";
+export interface SharedObjectRef {
+    objectId: string;
+    initialSharedVersion: number;
+    mutable: boolean;
+}
+export interface PlatformConfig {
+    PLATFORM_UPDATE_PROOF_TARGET: string;
+    PLATFORM_TYPE: string;
+    RECLAIM_MANAGER_SHARED_OBJECT_REF: SharedObjectRef;
+    IDENTITY_MANAGER_SHARED_OBJECT_REF: SharedObjectRef;
+    IDENTITY_MANAGER_IDENTIFIER_INFO_DF_ID: string;
+    IDENTITY_MANAGER_ADDRESS_TO_IDENTIFIER_DF_ID: string;
+}
+export interface ZingConfig {
+    ZING_FRAMEWORK_PACKAGE_ADDRESS: string;
+    ZING_IDENTITY_PACKAGE_ADDRESS: string;
+    ZING_STUDIO_PACKAGE_ADDRESS: string;
+    ZING_STUDIO_V0_PACKAGE_ADDRESS: string;
+    ZING_TREASURY_SHARED_OBJECT_REF: SharedObjectRef;
+    ZING_IDENTITY_CONFIG_SHARED_OBJECT_REF: SharedObjectRef;
+    PROOF_COMMITMENT_TYPE: string;
+    IDENTITY_PLATFORMS: Record<PlatformType, PlatformConfig>;
+    ZING_STUDIO_CONFIG_SHARED_OBJECT_REF: SharedObjectRef;
+    ZING_STORAGE_TREASURY_SHARED_OBJECT_REF: SharedObjectRef;
+    ZING_WORKS_TYPE: Record<WorkType, string>;
+    EVENT_TYPES: Record<"publishArticleEvent", string>;
+}
+export interface WalrusConfig {
+    WALRUS_PACKAGE: string;
+    WAL_STAKING_INNER_FIELD: string;
+    WALRUS_SYSTEM_SHARED_OBJECT_REF: SharedObjectRef;
+    WALRUS_AGGREGATORS: string[];
+    WALRUS_UPLOAD_RELAY_BASE_URL: string;
+    EVENT_TYPES: Record<"blobRegistered", string>;
+}
+export interface SealConfig {
+    serverConfigs: KeyServerConfig[];
+}
+export interface Config {
+    zing: ZingConfig;
+    walrus: WalrusConfig;
+    seal: SealConfig;
+    coins: Record<CoinSymbol, string>;
+}
+export type WalrusStakingState = Awaited<ReturnType<WalrusClient["stakingState"]>>;
+export type WalrusSystemState = Awaited<ReturnType<WalrusClient["systemState"]>>;

package/dist/config/types.js

@@ -0,0 +1 @@
+export {};

package/dist/const.d.ts

@@ -0,0 +1,4 @@
+import type { SuiNetwork } from "./types.js";
+import type { KeyServerConfig } from "@mysten/seal";
+export declare const WALRUS_UPLOAD_RELAY_BASE_URL: Record<SuiNetwork, string>;
+export declare const SEAL_SERVERS_CONFIGS: Record<SuiNetwork, KeyServerConfig[]>;

package/dist/const.js

@@ -0,0 +1,25 @@
+// // Walrus upload relay
+export const WALRUS_UPLOAD_RELAY_BASE_URL = {
+    mainnet: "https://walrus-upload-relay-production-73a4.up.railway.app",
+    testnet: "https://walrus-upload-relay-production-73a4.up.railway.app",
+};
+// Platform
+// seal
+export const SEAL_SERVERS_CONFIGS = {
+    mainnet: [
+        {
+            objectId: "0xe0eb52eba9261b96e895bbb4deca10dcd64fbc626a1133017adcd5131353fd10",
+            weight: 1,
+        },
+    ],
+    testnet: [
+        {
+            objectId: "0x73d05d62c18d9374e3ea529e8e0ed6161da1a141a94d3f76ae3fe4e99356db75",
+            weight: 1,
+        },
+        {
+            objectId: "0xf5d14a81a982144ae441cd7d64b09027f116a468bd36e7eca494f750591623c8",
+            weight: 1,
+        },
+    ],
+};

package/dist/getters.d.ts

@@ -0,0 +1,228 @@
+import { QuiltPatchId } from "./bcs.js";
+import type { WalrusSystemState } from "./config/types.js";
+import type { SuiGrpcClient } from "@mysten/sui/grpc";
+import type { SuiJsonRpcClient } from "@mysten/sui/jsonRpc";
+import type { EncodingType, WalrusClient } from "@mysten/walrus";
+export declare function getDerivedStudioID(studioConfigId: string, address: string): string;
+export declare function getDerivedStorageID(studioConfigId: string, address: string): string;
+export declare function getDerivedWorksID(studioConfigId: string, address: string): string;
+export declare function getDerivedMembershipID(studioConfigId: string, address: string): string;
+export declare function getIdentifierByAddress(suiGrpcClient: SuiGrpcClient, addressToIdentifierDynamicFieldId: string, address: string): Promise<string | null>;
+export declare function getIdentifierInfoByIdentifier(suiGrpcClient: SuiGrpcClient, identifierInfoDynamicFieldId: string, identifier: string): Promise<{
+    owner: string;
+    updated_at: string;
+} | null>;
+export declare function getDonationByIdentifier(suiGrpcClient: SuiGrpcClient, donationTableId: string, identifier: string): Promise<{
+    contents: {
+        key: {
+            name: string;
+        };
+        value: string;
+    }[];
+} | null>;
+export declare function getStudio(suiGrpcClient: SuiGrpcClient, studioId: string): Promise<{
+    id: {
+        id: string;
+    };
+    owner: string;
+    period: string[];
+    monthly_subscription_fee: {
+        contents: {
+            key: number;
+            value: string;
+        }[];
+    };
+    membership: {
+        id: {
+            id: string;
+        };
+        size: string;
+    };
+    works: {
+        id: {
+            id: string;
+        };
+        size: string;
+    };
+    encrypted_file_key: number[] | null;
+} | null>;
+export declare function getStorageSpace(suiGrpcClient: SuiGrpcClient, storageSpaceId: string): Promise<{
+    id: {
+        id: string;
+    };
+    owner: string;
+    tier: number | null;
+    storage_used: {
+        contents: {
+            key: number;
+            value: string;
+        }[];
+    };
+    credits: string;
+} | null>;
+export declare function getStorageTreasury(suiGrpcClient: SuiGrpcClient, storageTreasuryId: string): Promise<{
+    id: {
+        id: string;
+    };
+    tier_plan: {
+        contents: {
+            key: number;
+            value: {
+                price: string;
+                duration_days: number;
+                storage_limit: string;
+            };
+        }[];
+    };
+    storages_by_epoch: {
+        contents: {
+            key: number;
+            value: {
+                id: {
+                    id: string;
+                };
+                start_epoch: number;
+                end_epoch: number;
+                storage_size: string;
+            };
+        }[];
+    };
+    wal_treasury: {
+        id: {
+            id: string;
+        };
+        balance: {
+            value: string;
+        };
+    };
+} | null>;
+export declare function getMember(suiGrpcClient: SuiGrpcClient, membershipTableId: string, member: string): Promise<{
+    level: number;
+    expired_at: string;
+} | null>;
+export declare function getMembers(suiGrpcClient: SuiGrpcClient, membershipTableId: string, cursor?: string, limit?: number): Promise<{
+    data: {
+        member: string;
+        level: number;
+        expiredAt: string;
+    }[];
+    nextCursor: string | undefined;
+    hasNextPage: boolean;
+}>;
+export declare function getWork(suiGrpcClient: SuiGrpcClient, walrusSystem: WalrusSystemState, workId: string, workType?: string): Promise<{
+    id: {
+        id: string;
+    };
+    owner: string;
+    deleted: boolean;
+    created_at: string;
+    subscription_level: number | null;
+    blobs: {
+        id: {
+            id: string;
+        };
+        registered_epoch: number;
+        blob_id: string;
+        size: string;
+        encoding_type: number;
+        certified_epoch: number | null;
+        storage: {
+            id: {
+                id: string;
+            };
+            start_epoch: number;
+            end_epoch: number;
+            storage_size: string;
+        };
+        deletable: boolean;
+    }[];
+    files: {
+        contents: {
+            key: string;
+            value: {
+                blob_index: string;
+                mime_type: string;
+                size: string;
+            };
+        }[];
+    };
+} | null>;
+export declare function getWorks(suiGrpcClient: SuiGrpcClient, walrusSystem: WalrusSystemState, workTableId: string, workType?: string, cursor?: string, limit?: number): Promise<{
+    data: {
+        id: {
+            id: string;
+        };
+        owner: string;
+        deleted: boolean;
+        created_at: string;
+        subscription_level: number | null;
+        blobs: {
+            id: {
+                id: string;
+            };
+            registered_epoch: number;
+            blob_id: string;
+            size: string;
+            encoding_type: number;
+            certified_epoch: number | null;
+            storage: {
+                id: {
+                    id: string;
+                };
+                start_epoch: number;
+                end_epoch: number;
+                storage_size: string;
+            };
+            deletable: boolean;
+        }[];
+        files: {
+            contents: {
+                key: string;
+                value: {
+                    blob_index: string;
+                    mime_type: string;
+                    size: string;
+                };
+            }[];
+        };
+    }[];
+    nextCursor: string | undefined;
+    hasNextPage: boolean;
+}>;
+export declare function getPublishedArticleAndBlobId(suiGrpcClient: SuiGrpcClient, suiClient: SuiJsonRpcClient, walrusClient: WalrusClient, digest: string, blobRegisteredEventType: string, publishArticleEventType: string): Promise<{
+    parsedPublishArticleEvent: {
+        article_id: string;
+        owner: string;
+        blob_ids: string[];
+        blob_sizes: string[];
+        blob_storage_sizes: string[];
+        blob_end_epochs: number[];
+        files: {
+            contents: {
+                key: string;
+                value: {
+                    blob_index: string;
+                    mime_type: string;
+                    size: string;
+                };
+            }[];
+        };
+        timestamp_ms: string;
+    };
+    blobObjectId: string;
+}>;
+export declare function encodeQuiltPatchId(id: typeof QuiltPatchId.$inferInput): string;
+export declare function urlSafeBase64(bytes: Uint8Array): string;
+export declare function getMaxFaultyNodes(nShards: number): number;
+export declare function decodingSafetyLimit(nShards: number, encodingType: EncodingType): number;
+export declare function signersToBitmap(signers: number[], committeeSize: number): Uint8Array;
+export declare function getSourceSymbols(nShards: number, encodingType?: EncodingType): {
+    primarySymbols: number;
+    secondarySymbols: number;
+};
+/**
+ * Calculate the encoded sliver size.
+ * This matches the Walrus SDK's encodedSliverSize function.
+ */
+export declare function encodedSliverSize(unencodedLength: number, nShards: number, encodingType?: EncodingType): number;
+export declare function encodedBlobLength(unencodedLength: number, nShards: number, encodingType?: EncodingType): number;