Skip to content

Commit

Permalink
chore: rename truf-node-sdk-js into sdk-js
Browse files Browse the repository at this point in the history
  • Loading branch information
MicBun committed Nov 26, 2024
1 parent eb34ca9 commit 07104f2
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 29 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
name: Bug Report
description: Something with truf-node-sdk-js is not working as expected.
description: Something with sdk-js is not working as expected.
title: "Bug: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report an issue. This form is for reporting **bugs in truf-node-sdk-js**.
Thank you for taking the time to report an issue. This form is for reporting **bugs in sdk-js**.
When submitting logs, please submit them as text and not as a screenshot.
- type: input
id: version
attributes:
label: Version / Commit
description: Please include the release version or commit hash of truf-node-sdk-js you are using. Write `unknown` if you are unsure.
description: Please include the release version or commit hash of sdk-js you are using. Write `unknown` if you are unsure.
placeholder: e.g. v0.1.0 or 1234567890abcdef
validations:
required: true
Expand All @@ -38,15 +38,15 @@ body:
attributes:
label: Expected Behavior
description: Please describe what you expected to happen.
placeholder: e.g. I expected truf-node-sdk-js to do X when I did Y
placeholder: e.g. I expected sdk-js to do X when I did Y
validations:
required: true
- type: textarea
id: actual_behavior
attributes:
label: Actual Behavior
description: Please describe what actually happened.
placeholder: e.g. truf-node-sdk-js did Z instead of X when I did Y
placeholder: e.g. sdk-js did Z instead of X when I did Y
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question
url: https://github.com/trufnetwork/truf-node-sdk-js/discussions
url: https://github.com/trufnetwork/sdk-js/discussions
about: Please ask and answer questions here
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: Feature Request
description: Suggest a new feature or change for truf-node-sdk-js.
description: Suggest a new feature or change for sdk-js.
title: "Feature Request: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to suggest a feature or change. This form is for suggesting **features or changes to truf-node-sdk-js**.
Thank you for taking the time to suggest a feature or change. This form is for suggesting **features or changes to sdk-js**.
Feel free to discuss or mull over potential features.
- type: textarea
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,24 @@ The TN SDK provides developers with tools to interact with the Truf Network, a d

### Installation
```bash
npm install @trufnetwork/truf-node-sdk-js
npm install @trufnetwork/sdk-js
# or your preferred package manager
```

### Environment-specific Usage

```ts
// For Node.js applications
import { NodeTNClient } from "@trufnetwork/truf-node-sdk-js";
import { NodeTNClient } from "@trufnetwork/sdk-js";

// For browser applications
import { BrowserTNClient } from "@trufnetwork/truf-node-sdk-js";
import { BrowserTNClient } from "@trufnetwork/sdk-js";
```

### Example Usage

```ts
import { NodeTNClient, StreamId } from "@trufnetwork/truf-node-sdk-js";
import { NodeTNClient, StreamId } from "@trufnetwork/sdk-js";

// Initialize client
const client = new NodeTNClient({
Expand Down Expand Up @@ -74,7 +74,7 @@ TN supports two main types of streams:
- **Primitive Streams**: Direct data sources from providers
- **Composed Streams**: Aggregate data from multiple streams using weights

More information about TN components can be found in the [Js TN-SDK Documentation](https://github.com/trufnetwork/truf-node-sdk-js/blob/main/docs/api-reference.md).
More information about TN components can be found in the [Js TN-SDK Documentation](https://github.com/trufnetwork/sdk-js/blob/main/docs/api-reference.md).

## Documentation

Expand All @@ -88,7 +88,7 @@ A staging network is available at https://staging.tsn.truflation.com for testing

## Support

For support, please [open an issue](https://github.com/trufnetwork/truf-node-sdk-js/issues).
For support, please [open an issue](https://github.com/trufnetwork/sdk-js/issues).

## License

Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# API Reference

For detailed information about TN concepts and operations, please refer to the [Js SDK Documentation](https://github.com/trufnetwork/truf-node-sdk-js/blob/main/docs/api-reference.md).
For detailed information about TN concepts and operations, please refer to the [Js SDK Documentation](https://github.com/trufnetwork/sdk-js/blob/main/docs/api-reference.md).

## Client Initialization

```typescript
import { NodeTNClient, BrowserTNClient } from "@trufnetwork/truf-node-sdk-js";
import { NodeTNClient, BrowserTNClient } from "@trufnetwork/sdk-js";

const client = new NodeTNClient({
endpoint: "https://staging.tsn.truflation.com",
Expand Down
8 changes: 4 additions & 4 deletions docs/core-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ TN supports two types of streams:
- **Composed Streams**: Aggregate multiple streams with configurable weights

```typescript
import { StreamType } from "@trufnetwork/truf-node-sdk-js";
import { StreamType } from "@trufnetwork/sdk-js";

// Available stream types
StreamType.Primitive // Single data source
StreamType.Composed // Aggregates multiple streams with weights
```

For detailed information about stream types and their use cases, see the [Js SDK Documentation](https://github.com/trufnetwork/truf-node-sdk-js/blob/main/README.md).
For detailed information about stream types and their use cases, see the [Js SDK Documentation](https://github.com/trufnetwork/sdk-js/blob/main/README.md).

## Error Handling

Expand Down Expand Up @@ -52,7 +52,7 @@ const streamId = await StreamId.generate("my-unique-name");
Streams support granular permissions for both reading and composing:

```typescript
import { visibility } from "@trufnetwork/truf-node-sdk-js";
import { visibility } from "@trufnetwork/sdk-js";

// Set visibility
await stream.setReadVisibility(visibility.private);
Expand Down Expand Up @@ -81,5 +81,5 @@ if (tx.data?.tx_hash) {
## Further Reading

- [Integration Tests](../tests/integration) - Usage examples
- [Js SDK Documentation](https://github.com/trufnetwork/truf-node-sdk-js/blob/main/README.md) - Detailed TN concepts
- [Js SDK Documentation](https://github.com/trufnetwork/sdk-js/blob/main/README.md) - Detailed TN concepts
- [monads-io Documentation](https://github.com/AlexXanderGrib/monads-io) - Error handling patterns
14 changes: 7 additions & 7 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
## Installation

```bash
npm install @trufnetwork/truf-node-sdk-js
npm install @trufnetwork/sdk-js
# or
pnpm install @trufnetwork/truf-node-sdk-js
pnpm install @trufnetwork/sdk-js
# or
yarn add @trufnetwork/truf-node-sdk-js
yarn add @trufnetwork/sdk-js
```

## Quick Start

```typescript
import { NodeTNClient, StreamId } from "@trufnetwork/truf-node-sdk-js";
import { NodeTNClient, StreamId } from "@trufnetwork/sdk-js";
import { Wallet } from "ethers";

// Initialize client
Expand Down Expand Up @@ -61,10 +61,10 @@ The SDK provides optimized clients for different environments:

```typescript
// For Node.js
import { NodeTNClient } from "@trufnetwork/truf-node-sdk-js";
import { NodeTNClient } from "@trufnetwork/sdk-js";

// For browsers
import { BrowserTNClient } from "@trufnetwork/truf-node-sdk-js";
import { BrowserTNClient } from "@trufnetwork/sdk-js";
```

## Next Steps
Expand All @@ -75,4 +75,4 @@ import { BrowserTNClient } from "@trufnetwork/truf-node-sdk-js";

## Support

For support and issues, please visit our [GitHub repository](https://github.com/trufnetwork/truf-node-sdk-js/issues).
For support and issues, please visit our [GitHub repository](https://github.com/trufnetwork/sdk-js/issues).
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@trufnetwork/truf-node-sdk-js",
"name": "@trufnetwork/sdk-js",
"version": "0.1.0",
"description": "Truf Network SDK for JavaScript",
"type": "module",
Expand Down Expand Up @@ -44,7 +44,7 @@
},
"dependencies": {
"@kwilteam/kwil-js": "^0.7.3",
"@truflation/tsn-sdk-js": "github:trufnetwork/truf-node-sdk-js",
"@truflation/tsn-sdk-js": "github:trufnetwork/sdk-js",
"crypto-hash": "^3.1.0",
"lodash": "^4.17.21",
"monads-io": "^4.0.2"
Expand Down

0 comments on commit 07104f2

Please sign in to comment.