{"id":26524961,"url":"https://github.com/hypercerts-org/hypercerts-sdk","last_synced_at":"2026-03-08T09:31:08.541Z","repository":{"id":252775571,"uuid":"841449865","full_name":"hypercerts-org/hypercerts-sdk","owner":"hypercerts-org","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-05T15:14:18.000Z","size":352,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-05T16:26:00.318Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hypercerts-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-12T12:36:32.000Z","updated_at":"2025-03-05T15:12:37.000Z","dependencies_parsed_at":"2024-08-12T12:49:13.302Z","dependency_job_id":"41a3c128-f279-443e-93c1-2eeb9978fd8b","html_url":"https://github.com/hypercerts-org/hypercerts-sdk","commit_stats":null,"previous_names":["hypercerts-org/hypercerts-sdk"],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypercerts-org%2Fhypercerts-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypercerts-org%2Fhypercerts-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypercerts-org%2Fhypercerts-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypercerts-org%2Fhypercerts-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hypercerts-org","download_url":"https://codeload.github.com/hypercerts-org/hypercerts-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244815796,"owners_count":20514989,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-21T14:39:51.234Z","updated_at":"2026-03-08T09:31:08.378Z","avatar_url":"https://github.com/hypercerts-org.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hypercerts SDK\n\n## Quickstart Guide\n\n1. Install the SDK using npm or yarn:\n\n```bash\npnpm install @hypercerts-org/sdk\n```\n\nor\n\n```bash\n pnpm add @hypercerts-org/sdk\n```\n\n2. Import the SDK into your project:\n\n```bash\nimport { HypercertClient } from \"@hypercerts-org/sdk\";\n```\n\n3. Create a new instance of the HypercertClient class with your configuration options:\n\n```js\nconst client = new HypercertClient({\n  environment: \"test\",\n  walletClient, // optional, client will default to read-only mode if not provided\n  publicClient, // optional, can be infered from walletClient if present\n});\n```\n\n\u003e **Note** If there's no `walletClient` provided the client will run in [read-only mode](#read-only-mode)\n\n4. Use the client object to interact with the Hypercert network.\n\nFor example, you can use the `client.mintClaim` method to create a new claim:\n\n```ts\nconst hash = await client.mintHypercert({\n  metaData: { ... },\n  totalUnits: 1000n,\n  transferRestriction: TransferRestrictions.AllowAll,\n});\n```\n\nThis will validate the metadata, store it on IPFS, create a new hypercert on-chain and return a transaction receipt.\n\nFor more information on how to use the SDK, check out the\n[developer documentation](https://hypercerts.org/docs/developer/) and the\n[Graph playground](https://thegraph.com/hosted-service/subgraph/hypercerts-admin/hypercerts-testnet).\n\nThat's it! With these simple steps, you can start using the Hypercert SDK in your own projects.\n\n## Config\n\nHypercertClientConfig is a configuration object used when initializing a new instance of the HypercertClient. It allows\nyou to customize the client by setting your own providers or deployments. At it's simplest, you only need to provide\n`chain.id` to initalize the client in `readonly` mode.\n\n| Field          | Type                     | Description                                                                                  |\n| -------------- | ------------------------ | -------------------------------------------------------------------------------------------- |\n| `environment`  | `'test' \\| 'production'` | Defines the environment the client will connect with.                                        |\n| `deployments`  | Object                   | The deployments of the contracts on various networks.                                        |\n| `readOnly`     | Boolean                  | Boolean to assert if the client is in read-only mode.                                        |\n| `graphUrl`     | String                   | The URL of the graph endpoint.                                                               |\n| `publicClient` | Object                   | The `PublicClient` is inherently read-only and is used for reading data from the blockchain. |\n| `walletClient` | Object                   | The `WalletClient` is used for signing and sending transactions.                             |\n\n### Read-only mode\n\nThe SDK client will be in read-only mode if any of the following conditions are true:\n\n- The client was initialized without a wallet client.\n- The client was initialized with a wallet client connected to a chain that is not supported in the environment.\n\n### Logging\n\nThe logger for the SDK uses the log level based on the value of the LOG_LEVEL environment variable. The log level\ndetermines which log messages are printed to the console. By default, the logger is configured to log messages with a\nlevel of info or higher to the console.\n\n## Modules\n\n### Storage\n\nThe `storage` module is an utility service for easy access to the hypercerts API. It's built based on the OpenAPI spec\nexposed by the hypercerts API.\n\n```js\n const client = new HypercertClient({\n  environment: \"test\",\n  walletClient, // optional, client will default to read-only mode if not provided\n  publicClient, // optional, can be infered from walletClient if present\n});\n\nconst storage = client.storage;\n\nconst storageRequest = { metadata: {...}}\nconst storageResponse = await client.storage.storeMetadata(storageRequest);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypercerts-org%2Fhypercerts-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhypercerts-org%2Fhypercerts-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypercerts-org%2Fhypercerts-sdk/lists"}