thiagodeev/rpcv08-websocket

.github/workflows/main_ci_check.yml

@@ -32,7 +32,7 @@ jobs:
         run: cd rpc && go test -timeout 600s -v -env devnet .
         env:
           TESTNET_ACCOUNT_PRIVATE_KEY: ${{ secrets.TESTNET_ACCOUNT_PRIVATE_KEY }}
-          INTEGRATION_BASE: "http://localhost:5050/"
+          HTTP_PROVIDER_URL: "http://localhost:5050/"
 
       # Test rpc on mock
       - name: Test RPC with mocks
@@ -43,31 +43,39 @@ jobs:
         run: cd rpc && go test -timeout 1200s -v -env testnet .
         env:
           TESTNET_ACCOUNT_PRIVATE_KEY: ${{ secrets.TESTNET_ACCOUNT_PRIVATE_KEY }}
-          INTEGRATION_BASE: "https://free-rpc.nethermind.io/sepolia-juno"
+          HTTP_PROVIDER_URL: ${{ secrets.TESTNET_HTTP_PROVIDER_URL}}
+          WS_PROVIDER_URL: ${{ secrets.TESTNET_WS_PROVIDER_URL }}
 
       # Test rpc on mainnet
       - name: Test RPC with mainnet
         run: echo "Skip for now - need public endpoint that follows rpc spec"
         #run: cd rpc && go test -timeout 600s -v -env mainnet .
         env:
           TESTNET_ACCOUNT_PRIVATE_KEY: ${{ secrets.TESTNET_ACCOUNT_PRIVATE_KEY }}
-          INTEGRATION_BASE: "https://free-rpc.nethermind.io/mainnet-juno"
+          HTTP_PROVIDER_URL: ${{ secrets.MAINNET_HTTP_PROVIDER_URL}}
+          WS_PROVIDER_URL: ${{ secrets.MAINNET_WS_PROVIDER_URL }}
 
       # Test Account on devnet
       - name: Test Account on devnet
         run: cd account && go test -timeout 600s -v -env devnet .
         env:
           TESTNET_ACCOUNT_PRIVATE_KEY: ${{ secrets.TESTNET_ACCOUNT_PRIVATE_KEY }}
-          INTEGRATION_BASE: "http://localhost:5050"
+          HTTP_PROVIDER_URL: "http://localhost:5050"
 
       # Test Account on mock
       - name: Test Account with mocks
         run: cd account && go test -v . -env mock
 
+      # Test client on mock
+      - name: Test client with mocks
+        run: cd client && go test -v
+
       # Build examples
       - name: Build examples
         run: |
           cd examples/deployAccount && go build
           cd ../simpleCall && go build
           cd ../simpleInvoke && go build
           cd ../deployContractUDC && go build
+          cd ../typedData && go build
+          cd ../websocket && go build

.github/workflows/test.yml

@@ -37,4 +37,4 @@ jobs:
         run: go test -timeout 600s -v -env devnet -run "^(TestRPC|TestGeneral)" .
         env:
           TESTNET_ACCOUNT_PRIVATE_KEY: ${{ secrets.TESTNET_ACCOUNT_PRIVATE_KEY }}
-          INTEGRATION_BASE: "http://localhost:5050/"
+          HTTP_PROVIDER_URL: "http://localhost:5050/"

.github/workflows/test_account.yml

@@ -34,7 +34,7 @@ jobs:
         run: cd account && go test -timeout 600s -v -env devnet .
         env:
           TESTNET_ACCOUNT_PRIVATE_KEY: ${{ secrets.TESTNET_ACCOUNT_PRIVATE_KEY }}
-          INTEGRATION_BASE: "http://localhost:5050"
+          HTTP_PROVIDER_URL: "http://localhost:5050"
 
       # Test Account on mock
       - name: Test Account with mocks

.github/workflows/test_rpc.yml

@@ -34,7 +34,7 @@ jobs:
         run: cd rpc && go test -timeout 600s -v -env devnet .
         env:
           TESTNET_ACCOUNT_PRIVATE_KEY: ${{ secrets.TESTNET_ACCOUNT_PRIVATE_KEY }}
-          INTEGRATION_BASE: "http://localhost:5050/"
+          HTTP_PROVIDER_URL: "http://localhost:5050/"
 
       # Test rpc on mock
       - name: Test RPC with mocks
@@ -46,12 +46,14 @@ jobs:
         #run: cd rpc && go test -timeout 1200s -v -env testnet .
         env:
           TESTNET_ACCOUNT_PRIVATE_KEY: ${{ secrets.TESTNET_ACCOUNT_PRIVATE_KEY }}
-          INTEGRATION_BASE: "https://free-rpc.nethermind.io/sepolia-juno"
+          HTTP_PROVIDER_URL: ${{ secrets.TESTNET_HTTP_PROVIDER_URL}}
+          WS_PROVIDER_URL: ${{ secrets.TESTNET_WS_PROVIDER_URL }}
 
       # Test rpc on mainnet
       - name: Test RPC with mainnet
         run: echo "Skip for now - need public endpoint that follows rpc spec"
         #run: cd rpc && go test -timeout 600s -v -env mainnet .
         env:
           TESTNET_ACCOUNT_PRIVATE_KEY: ${{ secrets.TESTNET_ACCOUNT_PRIVATE_KEY }}
-          INTEGRATION_BASE: "https://free-rpc.nethermind.io/mainnet-juno"
+          HTTP_PROVIDER_URL: ${{ secrets.MAINNET_HTTP_PROVIDER_URL}}
+          WS_PROVIDER_URL: ${{ secrets.MAINNET_WS_PROVIDER_URL }}

README.md

@@ -58,6 +58,7 @@ operations on the wallets. The package has excellent documentation for a smooth
 - [invoke transaction example](./examples/simpleInvoke) to add a new invoke transaction on testnet.
 - [deploy contract UDC example](./examples/deployContractUDC) to deploy an ERC20 token using [UDC (Universal Deployer Contract)](https://docs.starknet.io/architecture-and-concepts/accounts/universal-deployer/) on testnet.
 - [typed data example](./examples/typedData) to sign and verify a typed data.
+- [websocket example](./examples/websocket) to learn how to subscribe to WebSocket methods.
 
 ### Run Examples
 
@@ -105,6 +106,15 @@ go run main.go
 
 > Check [here](examples/typedData/README.md) for more details.
 
+***starknet websocket***
+
+```sh
+cd examples/websocket
+go run main.go
+```
+
+> Check [here](examples/websocket/README.md) for more details.
+
 <br/> Check [here](https://github.com/NethermindEth/starknet.go/tree/main/examples) for some FAQ answered by these examples.
 
 

account/account_test.go

@@ -33,7 +33,7 @@ var (
 //
 // It sets up the test environment by parsing command line flags and loading environment variables.
 // The test environment can be set using the "env" flag.
-// It then sets the base path for integration tests by reading the value from the "INTEGRATION_BASE" environment variable.
+// It then sets the base path for integration tests by reading the value from the "HTTP_PROVIDER_URL" environment variable.
 // If the base path is not set and the test environment is not "mock", it panics.
 // Finally, it exits with the return value of the test suite
 //
@@ -48,12 +48,12 @@ func TestMain(m *testing.M) {
 	if testEnv == "mock" {
 		return
 	}
-	base = os.Getenv("INTEGRATION_BASE")
+	base = os.Getenv("HTTP_PROVIDER_URL")
 	if base == "" {
 		if err := godotenv.Load(fmt.Sprintf(".env.%s", testEnv)); err != nil {
 			panic(fmt.Sprintf("Failed to load .env.%s, err: %s", testEnv, err))
 		}
-		base = os.Getenv("INTEGRATION_BASE")
+		base = os.Getenv("HTTP_PROVIDER_URL")
 	}
 	os.Exit(m.Run())
 }
@@ -1076,7 +1076,7 @@ func TestWaitForTransactionReceipt(t *testing.T) {
 				Timeout:         3, // Should poll 3 times
 				Hash:            new(felt.Felt).SetUint64(100),
 				ExpectedReceipt: rpc.TransactionReceipt{},
-				ExpectedErr:     rpc.Err(rpc.InternalError, &rpc.RPCData{Message: "Post \"http://localhost:5050\": context deadline exceeded"}),
+				ExpectedErr:     rpc.Err(rpc.InternalError, &rpc.RPCData{Message: "context deadline exceeded"}),
 			},
 		},
 	}[testEnv]
@@ -1090,7 +1090,7 @@ func TestWaitForTransactionReceipt(t *testing.T) {
 			rpcErr, ok := err.(*rpc.RPCError)
 			require.True(t, ok)
 			require.Equal(t, test.ExpectedErr.Code, rpcErr.Code)
-			require.Equal(t, test.ExpectedErr.Data.Message, rpcErr.Data.Message)
+			require.Contains(t, rpcErr.Data.Message, test.ExpectedErr.Data.Message) // sometimes the error message starts with "Post \"http://localhost:5050\":..."
 		} else {
 			require.Equal(t, test.ExpectedReceipt.ExecutionStatus, (*resp).ExecutionStatus)
 		}