Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @textile/eth-storage

Index

Type aliases

CoreAPI

Type parameters

  • T

Variables

Const DEPOSIT

DEPOSIT: BigNumber = ...

Const GAS

GAS: 3000000 = 3000000

Const PROVIDER_ID

PROVIDER_ID: "0x8845A98EF6580d2a109f8FcfC10cc1d6007059fc" = "0x8845A98EF6580d2a109f8FcfC10cc1d6007059fc"

Const REGISTRY_ID

REGISTRY_ID: "0x7085f413A72dCd53D001eb97971bbf25793262cC" = "0x7085f413A72dCd53D001eb97971bbf25793262cC"

Functions

createToken

  • createToken(signer: Signer, claims: StandardClaims): Promise<string>
  • Create and sign a JWT token to produce a JWS.

    Parameters

    • signer: Signer

      A generic Signer interface as specified in @textile/core-storage.

    • claims: StandardClaims

      A set of Standard Claims as specified by the JWT spec.

    Returns Promise<string>

    A promise that resolves to a token string.

estimateDeposit

  • estimateDeposit(seconds: number): BigNumber
  • Estimate the required deposit size in gwei given the session length.

    Parameters

    • seconds: number

      The requested session length in seconds. Should be an integer value. Is passed through Math.floor before being multiplied by current session multiplier.

    Returns BigNumber

    A BigNumber representation of the required deposit in gwei.

init

  • Initialize a Filecoin Storage Interface. This will generate a new JWT token, signed by the user for interacting with a remote Bridge Provider. If no Bridge Provider is given, this will also query the on-chain Bridge Registry to find a suitable Provider.

    Parameters

    • account: Signer

      User account as a ethers.Signer object.

    • opts: InitOptions & StandardClaims = {}

      Additional configuration options. Possible values include a pre-signed token, registry contract, provider contract, and standard JWT claims.

    Returns Promise<CoreAPI<BigNumber>>

    A promise that resolves to a CoreAPI object.

requestSignIn

  • requestSignIn(): Promise<boolean>
  • Request to connect to a EIP-1102 and EIP-1193 compliant Ethereum provider.

    Returns Promise<boolean>

    A promise that resolves to true (success) or false.

Generated using TypeDoc