@xyo-network/witness-blockchain-abstract

Primary SDK for using XYO Protocol 2.0

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

modules

### packages

  ### witness

    ### packages

      ### blockchain

        ### packages

          ### abstract

            ### .temp-typedoc

              ### functions

                ### <a id="checkIpfsUrl"></a>checkIpfsUrl

@xyo-network/witness-blockchain-abstract

function checkIpfsUrl(urlToCheck, ipfsGateway?): string;

Returns the equivalent IPFS gateway URL for the supplied URL.

Parameters

urlToCheck

string

The URL to check

ipfsGateway?

string

Returns

string

If the supplied URL is an IPFS URL, it converts the URL to the equivalent IPFS gateway URL. Otherwise, returns the original URL.

                ### <a id="getProviderFromEnv"></a>getProviderFromEnv

@xyo-network/witness-blockchain-abstract

function getProviderFromEnv(chainId?, __namedParameters?): Provider;

Parameters

chainId?

number = 0x01

__namedParameters?

GetProvidersFromEnvOptions = {}

Returns

Provider

                ### <a id="getProvidersFromEnv"></a>getProvidersFromEnv

@xyo-network/witness-blockchain-abstract

function getProvidersFromEnv(
   count?, 
   chainId?, 
   options?): Provider[];

Parameters

count?

number = 1

chainId?

number = 0x01

options?

GetProvidersFromEnvOptions = {}

Returns

Provider[]

                ### <a id="getSharedProviderFromEnv"></a>getSharedProviderFromEnv

@xyo-network/witness-blockchain-abstract

function getSharedProviderFromEnv(chainId?, options?): Provider;

Parameters

chainId?

number = 0x01

options?

providerSource?

ProviderSource

providerType?

ProviderType

Returns

Provider

              ### interfaces

                ### <a id="GetProvidersFromEnvOptions"></a>GetProvidersFromEnvOptions

@xyo-network/witness-blockchain-abstract

Properties

providerSource?

optional providerSource?: ProviderSource;

providerType?

optional providerType?: ProviderType;

              ### type-aliases

                ### <a id="ProviderSource"></a>ProviderSource

@xyo-network/witness-blockchain-abstract

type ProviderSource = "infura" | "quicknode";

                ### <a id="ProviderType"></a>ProviderType

@xyo-network/witness-blockchain-abstract

type ProviderType = "rpc" | "wss";