{"id":26586554,"url":"https://github.com/peeramid-labs/sdk","last_synced_at":"2026-02-09T19:20:08.936Z","repository":{"id":205976124,"uuid":"713152760","full_name":"peeramid-labs/sdk","owner":"peeramid-labs","description":"Client libraries and CLI tools for building your community.","archived":false,"fork":false,"pushed_at":"2025-11-27T11:07:59.000Z","size":5850,"stargazers_count":1,"open_issues_count":12,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-30T04:15:28.586Z","etag":null,"topics":["client","js","peeramid","sdk","viem"],"latest_commit_sha":null,"homepage":"","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/peeramid-labs.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-11-02T00:14:49.000Z","updated_at":"2025-11-13T08:59:41.000Z","dependencies_parsed_at":"2026-02-09T17:14:03.197Z","dependency_job_id":null,"html_url":"https://github.com/peeramid-labs/sdk","commit_stats":null,"previous_names":["vote4best/sdk","rankify-it/sdk","peeramid-labs/sdk"],"tags_count":66,"template":false,"template_full_name":null,"purl":"pkg:github/peeramid-labs/sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peeramid-labs%2Fsdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peeramid-labs%2Fsdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peeramid-labs%2Fsdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peeramid-labs%2Fsdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peeramid-labs","download_url":"https://codeload.github.com/peeramid-labs/sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peeramid-labs%2Fsdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29278379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-09T19:05:41.198Z","status":"ssl_error","status_checked_at":"2026-02-09T19:05:37.449Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["client","js","peeramid","sdk","viem"],"created_at":"2025-03-23T11:19:47.520Z","updated_at":"2026-02-09T19:20:08.884Z","avatar_url":"https://github.com/peeramid-labs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SDK\n\nThis is SDK for use with Rankify game. You can ease interaction with smart contracts.\n\n## Installation\n\n```bash\n# Using npm\nnpm install @peeramid-labs/sdk\n\n# Using yarn\nyarn add @peeramid-labs/sdk\n\n# Using pnpm\npnpm add @peeramid-labs/sdk\n```\n\n## CLI Usage\n\nThe SDK includes a command-line interface for interacting with Peeramid contracts:\n\n```bash\n# Set up environment variables\nexport RPC_URL=\"your-rpc-url\"\nexport PRIVATE_KEY=\"your-private-key\"\n\n# List available commands\npeeramid --help\n\n# Examples:\npeeramid distributions list\npeeramid fellowship create\npeeramid instances list\npeeramid multipass domains create\n```\n\n## Development\n\n## Prerequisites\n\nBefore setting up the local development environment, ensure you have the following installed:\n\n1. **Node.js and pnpm**\n   ```bash\n   # Using homebrew\n   brew install node\n   npm install -g pnpm\n   ```\n\n2. **Foundry (for Anvil)**\n   ```bash\n   curl -L https://foundry.paradigm.xyz | bash\n   foundryup\n   ```\n\n3. **tmux**\n   ```bash\n   # Using homebrew\n   brew install tmux\n   ```\n\n## Local Development Setup\n\nTo set up your local development environment:\n\n1. Create your environment file:\n   ```bash\n   mkdir -p .secrets\n   cp samples/\u003cnetwork\u003e.env.example .secrets/\u003cnetwork\u003e.env\n   ```\n   Then edit `.env` to set your local repository paths.\n\n2. Set the required environment variables:\n   ```bash\n   export RANKIFY_CONTRACTS_PATH=\"/path/to/rankify/contracts\"\n   export MULTIPASS_PATH=\"/path/to/multipass\"\n   ```\n\n3. Make the setup script executable:\n   ```bash\n   chmod +x scripts/deploy-contracts.sh\n   ```\n\n4. Run the setup script:\n   ```bash\n   ./scripts/deploy-contracts.sh \u003cnetwork\u003e clean # set last argument to clean the deployments \u0026 artifacts\n   ```\n\nThis will:\n- Start a local Anvil development network in a tmux session (for localhost network)\n- Install dependencies for all repositories\n- Run local deployment scripts (`playbook/utils/deploy-to-local-anvil.sh`) in each repository\n- Set up local pnpm links between packages\n\nThe script uses a fixed mnemonic for consistent addresses across runs.\n\n### Managing Anvil\n\n- View Anvil logs: `tmux attach -t anvil`\n- Detach from logs: Press `Ctrl+B` then `D`\n- Stop Anvil: `tmux kill-session -t anvil`\n\n## Documentation\n\nThe SDK comes with comprehensive API documentation generated using TypeDoc. The documentation is automatically generated during the package build process and is included in the npm package.\n\n### Generating Documentation\n\nTo generate the documentation locally:\n\n```bash\npnpm run docs\n```\n\nThis will create a `docs` directory with the generated documentation.\n\nFor development, you can use the watch mode:\n\n```bash\npnpm run docs:watch\n```\n\n### Accessing Documentation\n\n- **Local Development**: Open `docs/index.html` in your browser after generating the documentation\n- **Published Package**: Documentation is available through the npm package page\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeeramid-labs%2Fsdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeeramid-labs%2Fsdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeeramid-labs%2Fsdk/lists"}