Skip to content

Commit

Permalink
rename push protocol package name
Browse files Browse the repository at this point in the history
  • Loading branch information
strykerin committed Jan 29, 2025
1 parent 125c2b0 commit daa5a95
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 28 deletions.
4 changes: 2 additions & 2 deletions docs/chain/01-build/01-Develop-Get-Started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The following speed run is designed to give you a quick overview of usage and de
<TabItem value="js" attributes={{className: "codetab js"}} default>
```typescript
// Import Push Chain SDK
import { PushChain, CONSTANTS } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS } from '@pushchain/devnet';

// Import utility functions from viem
import { hexToBytes } from 'viem';
Expand Down Expand Up @@ -105,7 +105,7 @@ for (const blocks of transactions.blocks) {

```zsh
# Install Libraries
npm install @pushprotocol/push-chain viem
npm install @pushchain/devnet viem
```

</TabItem>
Expand Down
6 changes: 3 additions & 3 deletions docs/chain/01-build/03-Develop-Initialize-SDK.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import Details from '@theme/Details';
<TabItem value="js" attributes={{className: "codetab js"}} default>
```typescript
// Import required modules
import { PushChain, CONSTANTS } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS } from '@pushchain/devnet';
import { hexToBytes } from 'viem';
import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts';

Expand Down Expand Up @@ -55,7 +55,7 @@ const pushChain = await PushChain.initialize(universalSigner);
<TabItem value="react" attributes={{className: "codetab react"}} default>
```typescript
// Import required modules
import { PushChain, CONSTANTS } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS } from '@pushchain/devnet';
import { hexToBytes } from 'viem';
import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts';

Expand Down Expand Up @@ -84,7 +84,7 @@ const pushChain = await PushChain.initialize(universalSigner);
<TabItem value="reactnative" attributes={{className: "codetab reactnative"}} default>
```typescript
// Import required modules
import { PushChain, CONSTANTS } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS } from '@pushchain/devnet';
import { hexToBytes } from 'viem';
import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts';

Expand Down
9 changes: 0 additions & 9 deletions docs/chain/01-build/08-JSON-RPC-Functions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -223,15 +223,6 @@ Returns transactions for a specific category, ordered by time
Fetches one single transaction by key

```typescript
/* Request
1 string, wallet in caip10
ex: eip155:1:0xAA
2 string, category
(NOTIF is the only valid value as of now)
3 string, key - defines the uniq transaction key
*/
"params": [ "eip155:1:0xAA", "NOTIF", "0x1234"]

// Result
Expand Down
12 changes: 6 additions & 6 deletions docs/chain/02-Quickstart-Push-Chain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@ import TabItem from '@theme/TabItem';
<TabItem value="js" attributes={{className: "codetab js"}} default>

```bash
npm install @pushprotocol/push-chain viem
npm install @pushchain/devnet viem
```

</TabItem>
<TabItem value="react" attributes={{className: "codetab react"}} default>

```bash
npm install @pushprotocol/push-chain viem
npm install @pushchain/devnet viem
```

</TabItem>
<TabItem value="reactnative" attributes={{className: "codetab reactnative"}} default>

```bash
npm install @pushprotocol/push-chain viem
npm install @pushchain/devnet viem
```

</TabItem>
Expand All @@ -54,7 +54,7 @@ npm install @pushprotocol/push-chain viem

```typescript
// Import Push Chain SDK for blockchain interactions
import { PushChain, CONSTANTS } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS } from '@pushchain/devnet';

// Import utility functions from viem
import { hexToBytes } from 'viem';
Expand All @@ -67,7 +67,7 @@ import { privateKeyToAccount, generatePrivateKey } from 'viem/accounts';

```typescript
// Import Push Chain SDK for blockchain interactions
import { PushChain, CONSTANTS } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS } from '@pushchain/devnet';

// Import utility functions from viem
import { hexToBytes } from 'viem';
Expand All @@ -80,7 +80,7 @@ import { privateKeyToAccount, generatePrivateKey } from 'viem/accounts';

```typescript
// Import Push Chain SDK for blockchain interactions
import { PushChain, CONSTANTS } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS } from '@pushchain/devnet';

// Import utility functions from viem
import { hexToBytes } from 'viem';
Expand Down
8 changes: 4 additions & 4 deletions docs/chain/02-tutorials/01-Build-cross-chain-email.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ We'll cover:
To get started, install the required dependencies:

```shell
npm install @pushprotocol/push-chain viem
npm install @pushchain/devnet viem
```

**Why These Libraries?**

- `@pushprotocol/push-chain`: Core SDK for interacting with Push Chain.
- `@pushchain/devnet`: Core SDK for interacting with Push Chain.
- `viem`: Utilities for Ethereum key management and signing.

Import installed dependencies:

```typescript
// Import Push Chain SDK
import { PushChain, CONSTANTS } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS } from '@pushchain/devnet';

// Import utility functions from viem
import { hexToBytes } from 'viem';
Expand Down Expand Up @@ -122,7 +122,7 @@ for (const blocks of transactions.blocks) {
## Complete Example Code

```typescript
import { PushChain, CONSTANTS } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS } from '@pushchain/devnet';
import { hexToBytes } from 'viem';
import { privateKeyToAccount, generatePrivateKey } from 'viem/accounts';

Expand Down
6 changes: 3 additions & 3 deletions docs/chain/02-tutorials/02-Build-cross-chain-chat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,19 @@ A chat interface is often more dynamic than an email-based approach. While email
You’ll need to install (or already have) the following libraries in your project:

```bash
npm install @pushprotocol/push-chain viem
npm install @pushchain/devnet viem
```

**What’s Included?**

- `@pushprotocol/push-chain`: Gives you the methods for initializing, signing, and sending transactions over Push Chain.
- `@pushchain/devnet`: Gives you the methods for initializing, signing, and sending transactions over Push Chain.
- `viem`: Helps manage private keys and produce signatures on Ethereum.

Import installed dependencies:

```typescript
// Import Push Chain SDK
import { PushChain, CONSTANTS } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS } from '@pushchain/devnet';

// Import utility functions from viem
import { hexToBytes } from 'viem';
Expand Down
2 changes: 1 addition & 1 deletion src/config/DocsHubList.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const QuickstartItems: IQuickstartItem[] = [
{
title: 'Push Chain Quickstart',
codeblock: `// Import Push Chain SDK
import { PushChain, CONSTANTS, createUniversalAccount, createUniversalSigner } from '@pushprotocol/push-chain';
import { PushChain, CONSTANTS, createUniversalAccount, createUniversalSigner } from '@pushchain/devnet';
// Import utility functions from viem
import { hexToBytes } from 'viem';
Expand Down

0 comments on commit daa5a95

Please sign in to comment.