github.com/stafiprotocol/go-substrate-rpc-client@v1.4.7/config/config.go (about)

     1  // Go Substrate RPC Client (GSRPC) provides APIs and types around Polkadot and any Substrate-based chain RPC calls
     2  //
     3  // Copyright 2020 Stafi Protocol
     4  //
     5  // Licensed under the Apache License, Version 2.0 (the "License");
     6  // you may not use this file except in compliance with the License.
     7  // You may obtain a copy of the License at
     8  //
     9  //     http://www.apache.org/licenses/LICENSE-2.0
    10  //
    11  // Unless required by applicable law or agreed to in writing, software
    12  // distributed under the License is distributed on an "AS IS" BASIS,
    13  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14  // See the License for the specific language governing permissions and
    15  // limitations under the License.
    16  
    17  package config
    18  
    19  import (
    20  	"os"
    21  	"time"
    22  )
    23  
    24  type Config struct {
    25  	RPCURL string
    26  
    27  	// Timeouts
    28  	DialTimeout      time.Duration
    29  	SubscribeTimeout time.Duration
    30  }
    31  
    32  var (
    33  	DialTimeout      = 10 * time.Second
    34  	SubscribeTimeout = 10 * time.Second
    35  )
    36  
    37  // DefaultConfig returns the default config. Default values can be overwritten with env variables, most importantly
    38  // RPC_URL for a custom RPC endpoint.
    39  func Default() Config {
    40  	return Config{
    41  		RPCURL:           extractDefaultRPCURL(),
    42  		DialTimeout:      DialTimeout,
    43  		SubscribeTimeout: SubscribeTimeout,
    44  	}
    45  }
    46  
    47  // ExtractDefaultRPCURL reads the env variable RPC_URL and returns it. If that variable is unset or empty,
    48  // it will fallback to "http://127.0.0.1:9933"
    49  func extractDefaultRPCURL() string {
    50  	if url, ok := os.LookupEnv("RPC_URL"); ok {
    51  		return url
    52  	}
    53  
    54  	// Fallback
    55  	return "ws://127.0.0.1:9944"
    56  }
    57  
    58  func SetDialTimeout(dialTimeout time.Duration) {
    59  	DialTimeout = dialTimeout
    60  }
    61  
    62  func SetSubscribeTimeout(subscribeTimeout time.Duration) {
    63  	SubscribeTimeout = subscribeTimeout
    64  }