ETHERspot docs

Index

Enumerations

Other Classes

Sdk Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AccountMemberNotification

AccountMemberNotification: BaseNotification<AccountMemberCreated | AccountMemberUpdated, { account: string; member: string }>

AccountNotification

AccountNotification: BaseNotification<AccountUpdated, { account: string }>

ContractAddresses

ContractAddresses: {} | string

ENSNodeNotification

ENSNodeNotification: BaseNotification<ENSNodeCreated | ENSNodeUpdated, { hash: string }>

EnvLike

EnvLike: EnvNames | Env

GatewayBatchNotification

GatewayBatchNotification: BaseNotification<GatewayBatchCreated | GatewayBatchUpdated, { hash: string }>

GatewayResubmittedNotification

GatewayResubmittedNotification: BaseNotification<GatewayBatchResubmitted, { hash: string; newTransaction: GatewayTransaction; oldTransaction: { id: number } }>

Notification

Notification: AccountNotification | AccountMemberNotification | ENSNodeNotification | GatewayBatchNotification | P2PPaymentChannelNotification | P2PPaymentDepositNotification | PaymentHubNotification | PaymentHubBridgeNotification | PaymentHubDepositNotification | PaymentHubPaymentNotification | TransactionUpdatedNotification

P2PPaymentChannelNotification

P2PPaymentChannelNotification: BaseNotification<P2PPaymentChannelCreated | P2PPaymentChannelUpdated, { hash: string }>

P2PPaymentDepositNotification

P2PPaymentDepositNotification: BaseNotification<P2PPaymentDepositCreated | P2PPaymentDepositUpdated, { hash: string }>

PaymentHubBridgeNotification

PaymentHubBridgeNotification: BaseNotification<PaymentHubBridgeCreated | PaymentHubBridgeUpdated, { acceptedChainId: number; acceptedToken: string; hub: string; token: string }>

PaymentHubDepositNotification

PaymentHubDepositNotification: BaseNotification<PaymentHubDepositCreated | PaymentHubDepositUpdated, { hub: string; owner: string; token: string }>

PaymentHubNotification

PaymentHubNotification: BaseNotification<PaymentHubCreated | PaymentHubUpdated, { hub: string; token: string }>

PaymentHubPaymentNotification

PaymentHubPaymentNotification: BaseNotification<PaymentHubPaymentCreated, { hash: string }>

StateStorageState

StateStorageState: Omit<State, "wallet" | "network" | "gatewayBatch">

TransactionUpdatedNotification

TransactionUpdatedNotification: BaseNotification<TransactionUpdated, { hash: string }>

WalletProviderLike

WalletProviderLike: string | WalletLike | WalletProvider

Variables

Const CHAIN_ID_TO_NETWORK_NAME

CHAIN_ID_TO_NETWORK_NAME: {} = Object.entries(NETWORK_NAME_TO_CHAIN_ID,).reduce((result, [networkName, chainId]) => ({...result,[chainId]: networkName,}),{},)

Type declaration

Const DEFAULT_PAYMENT_CHANNEL_UID_SALT

DEFAULT_PAYMENT_CHANNEL_UID_SALT: "default" = "default"

Const ENS_ADDR_REVERSE_TLD

ENS_ADDR_REVERSE_TLD: "addr.reverse" = "addr.reverse"

Const PAYMENT_HUB_P2P_CHANNEL_UID

PAYMENT_HUB_P2P_CHANNEL_UID: string = utils.id('PAYMENT_HUB_P2P_CHANNEL_ID')

Const SuperTokenContractABI

SuperTokenContractABI: ({ inputs: { internalType: string; name: string; type: string }[]; stateMutability: string; type: string } | { anonymous: boolean; inputs: { indexed: boolean; internalType: string; name: string; type: string }[]; name: string; type: string } | { inputs: { internalType: string; name: string; type: string }[]; name: string; outputs: { internalType: string; name: string; type: string }[]; stateMutability: string; type: string })[] = [{"inputs": [{"internalType": "contract ISuperfluid","name": "host","type": "address"}],"stateMutability": "nonpayable","type": "constructor"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "agreementClass","type": "address"},{"indexed": false,"internalType": "bytes32","name": "id","type": "bytes32"},{"indexed": false,"internalType": "bytes32[]","name": "data","type": "bytes32[]"}],"name": "AgreementCreated","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "agreementClass","type": "address"},{"indexed": false,"internalType": "bytes32","name": "id","type": "bytes32"},{"indexed": true,"internalType": "address","name": "penaltyAccount","type": "address"},{"indexed": true,"internalType": "address","name": "rewardAccount","type": "address"},{"indexed": false,"internalType": "uint256","name": "rewardAmount","type": "uint256"}],"name": "AgreementLiquidated","type": "event"},{"anonymous": false,"inputs": [{"indexed": false,"internalType": "address","name": "liquidatorAccount","type": "address"},{"indexed": true,"internalType": "address","name": "agreementClass","type": "address"},{"indexed": false,"internalType": "bytes32","name": "id","type": "bytes32"},{"indexed": true,"internalType": "address","name": "penaltyAccount","type": "address"},{"indexed": true,"internalType": "address","name": "bondAccount","type": "address"},{"indexed": false,"internalType": "uint256","name": "rewardAmount","type": "uint256"},{"indexed": false,"internalType": "uint256","name": "bailoutAmount","type": "uint256"}],"name": "AgreementLiquidatedBy","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "agreementClass","type": "address"},{"indexed": false,"internalType": "bytes32","name": "id","type": "bytes32"},{"indexed": true,"internalType": "address","name": "liquidatorAccount","type": "address"},{"indexed": true,"internalType": "address","name": "targetAccount","type": "address"},{"indexed": false,"internalType": "address","name": "rewardAmountReceiver","type": "address"},{"indexed": false,"internalType": "uint256","name": "rewardAmount","type": "uint256"},{"indexed": false,"internalType": "int256","name": "targetAccountBalanceDelta","type": "int256"},{"indexed": false,"internalType": "bytes","name": "liquidationTypeData","type": "bytes"}],"name": "AgreementLiquidatedV2","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "agreementClass","type": "address"},{"indexed": true,"internalType": "address","name": "account","type": "address"},{"indexed": false,"internalType": "uint256","name": "slotId","type": "uint256"}],"name": "AgreementStateUpdated","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "agreementClass","type": "address"},{"indexed": false,"internalType": "bytes32","name": "id","type": "bytes32"}],"name": "AgreementTerminated","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "agreementClass","type": "address"},{"indexed": false,"internalType": "bytes32","name": "id","type": "bytes32"},{"indexed": false,"internalType": "bytes32[]","name": "data","type": "bytes32[]"}],"name": "AgreementUpdated","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "owner","type": "address"},{"indexed": true,"internalType": "address","name": "spender","type": "address"},{"indexed": false,"internalType": "uint256","name": "value","type": "uint256"}],"name": "Approval","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "operator","type": "address"},{"indexed": true,"internalType": "address","name": "tokenHolder","type": "address"}],"name": "AuthorizedOperator","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "bailoutAccount","type": "address"},{"indexed": false,"internalType": "uint256","name": "bailoutAmount","type": "uint256"}],"name": "Bailout","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "operator","type": "address"},{"indexed": true,"internalType": "address","name": "from","type": "address"},{"indexed": false,"internalType": "uint256","name": "amount","type": "uint256"},{"indexed": false,"internalType": "bytes","name": "data","type": "bytes"},{"indexed": false,"internalType": "bytes","name": "operatorData","type": "bytes"}],"name": "Burned","type": "event"},{"anonymous": false,"inputs": [{"indexed": false,"internalType": "bytes32","name": "uuid","type": "bytes32"},{"indexed": false,"internalType": "address","name": "codeAddress","type": "address"}],"name": "CodeUpdated","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "operator","type": "address"},{"indexed": true,"internalType": "address","name": "to","type": "address"},{"indexed": false,"internalType": "uint256","name": "amount","type": "uint256"},{"indexed": false,"internalType": "bytes","name": "data","type": "bytes"},{"indexed": false,"internalType": "bytes","name": "operatorData","type": "bytes"}],"name": "Minted","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "operator","type": "address"},{"indexed": true,"internalType": "address","name": "tokenHolder","type": "address"}],"name": "RevokedOperator","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "operator","type": "address"},{"indexed": true,"internalType": "address","name": "from","type": "address"},{"indexed": true,"internalType": "address","name": "to","type": "address"},{"indexed": false,"internalType": "uint256","name": "amount","type": "uint256"},{"indexed": false,"internalType": "bytes","name": "data","type": "bytes"},{"indexed": false,"internalType": "bytes","name": "operatorData","type": "bytes"}],"name": "Sent","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "account","type": "address"},{"indexed": false,"internalType": "uint256","name": "amount","type": "uint256"}],"name": "TokenDowngraded","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "account","type": "address"},{"indexed": false,"internalType": "uint256","name": "amount","type": "uint256"}],"name": "TokenUpgraded","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "address","name": "from","type": "address"},{"indexed": true,"internalType": "address","name": "to","type": "address"},{"indexed": false,"internalType": "uint256","name": "value","type": "uint256"}],"name": "Transfer","type": "event"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "address","name": "spender","type": "address"}],"name": "allowance","outputs": [{"internalType": "uint256","name": "","type": "uint256"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "spender","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "approve","outputs": [{"internalType": "bool","name": "","type": "bool"}],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "operator","type": "address"}],"name": "authorizeOperator","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"}],"name": "balanceOf","outputs": [{"internalType": "uint256","name": "balance","type": "uint256"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "uint256","name": "amount","type": "uint256"},{"internalType": "bytes","name": "data","type": "bytes"}],"name": "burn","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "bytes32","name": "id","type": "bytes32"},{"internalType": "bytes32[]","name": "data","type": "bytes32[]"}],"name": "createAgreement","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [],"name": "decimals","outputs": [{"internalType": "uint8","name": "","type": "uint8"}],"stateMutability": "pure","type": "function"},{"inputs": [{"internalType": "address","name": "spender","type": "address"},{"internalType": "uint256","name": "subtractedValue","type": "uint256"}],"name": "decreaseAllowance","outputs": [{"internalType": "bool","name": "","type": "bool"}],"stateMutability": "nonpayable","type": "function"},{"inputs": [],"name": "defaultOperators","outputs": [{"internalType": "address[]","name": "","type": "address[]"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "downgrade","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"}],"name": "getAccountActiveAgreements","outputs": [{"internalType": "contract ISuperAgreement[]","name": "","type": "address[]"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "agreementClass","type": "address"},{"internalType": "bytes32","name": "id","type": "bytes32"},{"internalType": "uint256","name": "dataLength","type": "uint256"}],"name": "getAgreementData","outputs": [{"internalType": "bytes32[]","name": "data","type": "bytes32[]"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "agreementClass","type": "address"},{"internalType": "address","name": "account","type": "address"},{"internalType": "uint256","name": "slotId","type": "uint256"},{"internalType": "uint256","name": "dataLength","type": "uint256"}],"name": "getAgreementStateSlot","outputs": [{"internalType": "bytes32[]","name": "slotData","type": "bytes32[]"}],"stateMutability": "view","type": "function"},{"inputs": [],"name": "getCodeAddress","outputs": [{"internalType": "address","name": "codeAddress","type": "address"}],"stateMutability": "view","type": "function"},{"inputs": [],"name": "getHost","outputs": [{"internalType": "address","name": "host","type": "address"}],"stateMutability": "view","type": "function"},{"inputs": [],"name": "getUnderlyingToken","outputs": [{"internalType": "address","name": "","type": "address"}],"stateMutability": "view","type": "function"},{"inputs": [],"name": "granularity","outputs": [{"internalType": "uint256","name": "","type": "uint256"}],"stateMutability": "pure","type": "function"},{"inputs": [{"internalType": "address","name": "spender","type": "address"},{"internalType": "uint256","name": "addedValue","type": "uint256"}],"name": "increaseAllowance","outputs": [{"internalType": "bool","name": "","type": "bool"}],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "contract IERC20","name": "underlyingToken","type": "address"},{"internalType": "uint8","name": "underlyingDecimals","type": "uint8"},{"internalType": "string","name": "n","type": "string"},{"internalType": "string","name": "s","type": "string"}],"name": "initialize","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "uint256","name": "timestamp","type": "uint256"}],"name": "isAccountCritical","outputs": [{"internalType": "bool","name": "isCritical","type": "bool"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"}],"name": "isAccountCriticalNow","outputs": [{"internalType": "bool","name": "isCritical","type": "bool"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "uint256","name": "timestamp","type": "uint256"}],"name": "isAccountSolvent","outputs": [{"internalType": "bool","name": "isSolvent","type": "bool"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"}],"name": "isAccountSolventNow","outputs": [{"internalType": "bool","name": "isSolvent","type": "bool"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "operator","type": "address"},{"internalType": "address","name": "tokenHolder","type": "address"}],"name": "isOperatorFor","outputs": [{"internalType": "bool","name": "","type": "bool"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "bytes32","name": "id","type": "bytes32"},{"internalType": "bytes","name": "liquidationTypeData","type": "bytes"},{"internalType": "address","name": "liquidatorAccount","type": "address"},{"internalType": "bool","name": "useDefaultRewardAccount","type": "bool"},{"internalType": "address","name": "targetAccount","type": "address"},{"internalType": "uint256","name": "rewardAmount","type": "uint256"},{"internalType": "int256","name": "targetAccountBalanceDelta","type": "int256"}],"name": "makeLiquidationPayoutsV2","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [],"name": "name","outputs": [{"internalType": "string","name": "","type": "string"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "address","name": "spender","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "operationApprove","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "operationDowngrade","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "address","name": "spender","type": "address"},{"internalType": "address","name": "recipient","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "operationTransferFrom","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "operationUpgrade","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"},{"internalType": "bytes","name": "data","type": "bytes"},{"internalType": "bytes","name": "operatorData","type": "bytes"}],"name": "operatorBurn","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "sender","type": "address"},{"internalType": "address","name": "recipient","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"},{"internalType": "bytes","name": "data","type": "bytes"},{"internalType": "bytes","name": "operatorData","type": "bytes"}],"name": "operatorSend","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [],"name": "proxiableUUID","outputs": [{"internalType": "bytes32","name": "","type": "bytes32"}],"stateMutability": "pure","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "uint256","name": "timestamp","type": "uint256"}],"name": "realtimeBalanceOf","outputs": [{"internalType": "int256","name": "availableBalance","type": "int256"},{"internalType": "uint256","name": "deposit","type": "uint256"},{"internalType": "uint256","name": "owedDeposit","type": "uint256"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"}],"name": "realtimeBalanceOfNow","outputs": [{"internalType": "int256","name": "availableBalance","type": "int256"},{"internalType": "uint256","name": "deposit","type": "uint256"},{"internalType": "uint256","name": "owedDeposit","type": "uint256"},{"internalType": "uint256","name": "timestamp","type": "uint256"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "operator","type": "address"}],"name": "revokeOperator","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "address","name": "spender","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "selfApproveFor","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"},{"internalType": "bytes","name": "userData","type": "bytes"}],"name": "selfBurn","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"},{"internalType": "bytes","name": "userData","type": "bytes"}],"name": "selfMint","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "holder","type": "address"},{"internalType": "address","name": "spender","type": "address"},{"internalType": "address","name": "recipient","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "selfTransferFrom","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "recipient","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"},{"internalType": "bytes","name": "data","type": "bytes"}],"name": "send","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "int256","name": "delta","type": "int256"}],"name": "settleBalance","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [],"name": "symbol","outputs": [{"internalType": "string","name": "","type": "string"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "bytes32","name": "id","type": "bytes32"},{"internalType": "uint256","name": "dataLength","type": "uint256"}],"name": "terminateAgreement","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [],"name": "totalSupply","outputs": [{"internalType": "uint256","name": "","type": "uint256"}],"stateMutability": "view","type": "function"},{"inputs": [{"internalType": "address","name": "recipient","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "transfer","outputs": [{"internalType": "bool","name": "","type": "bool"}],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "recipient","type": "address"}],"name": "transferAll","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "holder","type": "address"},{"internalType": "address","name": "recipient","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "transferFrom","outputs": [{"internalType": "bool","name": "","type": "bool"}],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "bytes32","name": "id","type": "bytes32"},{"internalType": "bytes32[]","name": "data","type": "bytes32[]"}],"name": "updateAgreementData","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "account","type": "address"},{"internalType": "uint256","name": "slotId","type": "uint256"},{"internalType": "bytes32[]","name": "slotData","type": "bytes32[]"}],"name": "updateAgreementStateSlot","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "newAddress","type": "address"}],"name": "updateCode","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "uint256","name": "amount","type": "uint256"}],"name": "upgrade","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "to","type": "address"},{"internalType": "uint256","name": "amount","type": "uint256"},{"internalType": "bytes","name": "data","type": "bytes"}],"name": "upgradeTo","outputs": [],"stateMutability": "nonpayable","type": "function"}]

Const SuperTokenFactoryABI

SuperTokenFactoryABI: ({ inputs: { internalType: string; name: string; type: string }[]; stateMutability: string; type: string } | { anonymous: boolean; inputs: { indexed: boolean; internalType: string; name: string; type: string }[]; name: string; type: string } | { inputs: { internalType: string; name: string; type: string }[]; name: string; outputs: { internalType: string; name: string; type: string }[]; stateMutability: string; type: string })[] = [{"inputs": [{"internalType": "contract ISuperfluid","name": "host","type": "address"},{"internalType": "contract SuperTokenFactoryHelper","name": "helper","type": "address"}],"stateMutability": "nonpayable","type": "constructor"},{"anonymous": false,"inputs": [{"indexed": false,"internalType": "bytes32","name": "uuid","type": "bytes32"},{"indexed": false,"internalType": "address","name": "codeAddress","type": "address"}],"name": "CodeUpdated","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "contract ISuperToken","name": "token","type": "address"}],"name": "CustomSuperTokenCreated","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "contract ISuperToken","name": "token","type": "address"}],"name": "SuperTokenCreated","type": "event"},{"anonymous": false,"inputs": [{"indexed": true,"internalType": "contract ISuperToken","name": "tokenLogic","type": "address"}],"name": "SuperTokenLogicCreated","type": "event"},{"inputs": [{"internalType": "contract ERC20WithTokenInfo","name": "underlyingToken","type": "address"},{"internalType": "enum ISuperTokenFactory.Upgradability","name": "upgradability","type": "uint8"},{"internalType": "string","name": "name","type": "string"},{"internalType": "string","name": "symbol","type": "string"}],"name": "createERC20Wrapper","outputs": [{"internalType": "contract ISuperToken","name": "superToken","type": "address"}],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "contract IERC20","name": "underlyingToken","type": "address"},{"internalType": "uint8","name": "underlyingDecimals","type": "uint8"},{"internalType": "enum ISuperTokenFactory.Upgradability","name": "upgradability","type": "uint8"},{"internalType": "string","name": "name","type": "string"},{"internalType": "string","name": "symbol","type": "string"}],"name": "createERC20Wrapper","outputs": [{"internalType": "contract ISuperToken","name": "superToken","type": "address"}],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "contract ISuperfluid","name": "host","type": "address"}],"name": "createSuperTokenLogic","outputs": [{"internalType": "address","name": "logic","type": "address"}],"stateMutability": "nonpayable","type": "function"},{"inputs": [],"name": "getCodeAddress","outputs": [{"internalType": "address","name": "codeAddress","type": "address"}],"stateMutability": "view","type": "function"},{"inputs": [],"name": "getHost","outputs": [{"internalType": "address","name": "host","type": "address"}],"stateMutability": "view","type": "function"},{"inputs": [],"name": "getSuperTokenLogic","outputs": [{"internalType": "contract ISuperToken","name": "","type": "address"}],"stateMutability": "view","type": "function"},{"inputs": [],"name": "initialize","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [{"internalType": "address","name": "customSuperTokenProxy","type": "address"}],"name": "initializeCustomSuperToken","outputs": [],"stateMutability": "nonpayable","type": "function"},{"inputs": [],"name": "proxiableUUID","outputs": [{"internalType": "bytes32","name": "","type": "bytes32"}],"stateMutability": "pure","type": "function"},{"inputs": [{"internalType": "address","name": "newAddress","type": "address"}],"name": "updateCode","outputs": [],"stateMutability": "nonpayable","type": "function"}]

Const TOKEN_LIST_MAX_NAME_LENGTH

TOKEN_LIST_MAX_NAME_LENGTH: 32 = 32

Const TOKEN_LIST_MIN_NAME_LENGTH

TOKEN_LIST_MIN_NAME_LENGTH: 3 = 3

Let currentNonce

currentNonce: number = Math.floor(Date.now() / 1000) - 1605000000

Const window

window: Window & { ethereum: { autoRefreshOnNetworkChange: boolean; isMetaMask: boolean; networkVersion: string; selectedAddress: string; enable: any; on: any; request: any } }

Functions

IsAddress

  • IsAddress(options?: ValidationOptions): (Anonymous function)

  • Parameters

    • Default value options: ValidationOptions = {}

    Returns (Anonymous function)

IsBigNumberish

  • IsBigNumberish(options?: { positive?: boolean }, validationOptions?: ValidationOptions): (Anonymous function)

  • Parameters

    • Default value options: { positive?: boolean } = {}
      • Optional positive?: boolean
    • Default value validationOptions: ValidationOptions = {}

    Returns (Anonymous function)

IsBytesLike

  • IsBytesLike(options?: ValidationOptions & { acceptText?: boolean }): (Anonymous function)

  • Parameters

    • Default value options: ValidationOptions & { acceptText?: boolean } = {}

    Returns (Anonymous function)

IsHex

  • IsHex(options?: { size?: number }, validationOptions?: ValidationOptions): (Anonymous function)

  • Parameters

    • Default value options: { size?: number } = {}
      • Optional size?: number
    • Default value validationOptions: ValidationOptions = {}

    Returns (Anonymous function)

IsHex32

  • IsHex32(options?: ValidationOptions): (Anonymous function)

  • Parameters

    • Default value options: ValidationOptions = {}

    Returns (Anonymous function)

IsUrl

  • IsUrl(validationOptions?: ValidationOptions): (Anonymous function)

  • Parameters

    • Default value validationOptions: ValidationOptions = {}

    Returns (Anonymous function)

addressesEqual

  • addressesEqual(address1: string, address2: string): boolean

  • Parameters

    • address1: string
    • address2: string

    Returns boolean

computePaymentChannelHash

  • computePaymentChannelHash(sender: string, recipient: string, token: string, uid: string): string

  • Parameters

    • sender: string
    • recipient: string
    • token: string
    • uid: string

    Returns string

createPaymentChannelUid

  • createPaymentChannelUid(salt?: string): string

  • Parameters

    • Default value salt: string = null

    Returns string

isWalletProvider

networkNameToChainId

parseENSName

parseResolutionName

prepareInputArg

  • prepareInputArg(type: string, arg: any): any

  • Parameters

    • type: string
    • arg: any

    Returns any

prepareNetworkName

  • prepareNetworkName(networkNameOrChainId: string | number): NetworkNames

  • Parameters

    • networkNameOrChainId: string | number

    Returns NetworkNames

randomPrivateKey

  • randomPrivateKey(): string

  • Returns string

Object literals

Const NETWORK_NAME_TO_CHAIN_ID

NETWORK_NAME_TO_CHAIN_ID: object

[NetworkNames.ArbitrumNitro]

[NetworkNames.ArbitrumNitro]: number = 421613

[NetworkNames.ArbitrumNova]

[NetworkNames.ArbitrumNova]: number = 42170

[NetworkNames.Arbitrum]

[NetworkNames.Arbitrum]: number = 42161

[NetworkNames.AuroraTest]

[NetworkNames.AuroraTest]: number = 1313161555

[NetworkNames.Aurora]

[NetworkNames.Aurora]: number = 1313161554

[NetworkNames.Avalanche]

[NetworkNames.Avalanche]: number = 43114

[NetworkNames.BaseGoerli]

[NetworkNames.BaseGoerli]: number = 84531

[NetworkNames.BscTest]

[NetworkNames.BscTest]: number = 97

[NetworkNames.Bsc]

[NetworkNames.Bsc]: number = 56

[NetworkNames.CeloTest]

[NetworkNames.CeloTest]: number = 44787

[NetworkNames.Celo]

[NetworkNames.Celo]: number = 42220

[NetworkNames.Chiado]

[NetworkNames.Chiado]: number = 10200

[NetworkNames.Etherspot]

[NetworkNames.Etherspot]: number = 4386

[NetworkNames.FantomTest]

[NetworkNames.FantomTest]: number = 4002

[NetworkNames.Fantom]

[NetworkNames.Fantom]: number = 250

[NetworkNames.Fuji]

[NetworkNames.Fuji]: number = 43113

[NetworkNames.FuseSparknet]

[NetworkNames.FuseSparknet]: number = 123

[NetworkNames.Fuse]

[NetworkNames.Fuse]: number = 122

[NetworkNames.Goerli]

[NetworkNames.Goerli]: number = 5

[NetworkNames.KlaytnBaobab]

[NetworkNames.KlaytnBaobab]: number = 1001

[NetworkNames.Klaytn]

[NetworkNames.Klaytn]: number = 8217

[NetworkNames.LocalA]

[NetworkNames.LocalA]: number = 9999

[NetworkNames.LocalB]

[NetworkNames.LocalB]: number = 6666

[NetworkNames.LocalH]

[NetworkNames.LocalH]: number = 3333

[NetworkNames.Mainnet]

[NetworkNames.Mainnet]: number = 1

[NetworkNames.Matic]

[NetworkNames.Matic]: number = 137

[NetworkNames.Moonbase]

[NetworkNames.Moonbase]: number = 1287

[NetworkNames.Moonbeam]

[NetworkNames.Moonbeam]: number = 1284

[NetworkNames.Mumbai]

[NetworkNames.Mumbai]: number = 80001

[NetworkNames.NeonDevnet]

[NetworkNames.NeonDevnet]: number = 245022926

[NetworkNames.OKTC]

[NetworkNames.OKTC]: number = 66

[NetworkNames.OktcTest]

[NetworkNames.OktcTest]: number = 65

[NetworkNames.OptimismGoerli]

[NetworkNames.OptimismGoerli]: number = 420

[NetworkNames.Optimism]

[NetworkNames.Optimism]: number = 10

[NetworkNames.Xdai]

[NetworkNames.Xdai]: number = 100

Const SUPPORTED_ENVS

SUPPORTED_ENVS: object

[EnvNames.LocalNets]

[EnvNames.LocalNets]: object

apiOptions

apiOptions: object

host

host: string = "localhost"

port

port: number = 4000

networkOptions

networkOptions: object

supportedNetworkNames

supportedNetworkNames: (LocalA | LocalB | LocalH)[] = [NetworkNames.LocalA, //NetworkNames.LocalB,NetworkNames.LocalH,]

[EnvNames.MainNetsTest]

[EnvNames.MainNetsTest]: object

apiOptions

apiOptions: object

host

host: string = "qa-etherspot.pillarproject.io"

useSsl

useSsl: true = true

networkOptions

networkOptions: object

supportedNetworkNames

supportedNetworkNames: (Bsc | Matic | Optimism | Arbitrum | Klaytn)[] = [NetworkNames.Matic,NetworkNames.Bsc,NetworkNames.Optimism,NetworkNames.Arbitrum,NetworkNames.Klaytn,]

[EnvNames.MainNets]

[EnvNames.MainNets]: object

apiOptions

apiOptions: object

host

host: string = "etherspot.pillarproject.io"

useSsl

useSsl: true = true

networkOptions

networkOptions: object

supportedNetworkNames

supportedNetworkNames: (Mainnet | Xdai | Bsc | Fantom | Matic | Aurora | Avalanche | Optimism | Arbitrum | Moonbeam | Celo | Fuse | ArbitrumNova | Klaytn | OKTC)[] = [NetworkNames.Mainnet, //NetworkNames.Xdai,NetworkNames.Bsc,NetworkNames.Fantom,NetworkNames.Matic,NetworkNames.Aurora,NetworkNames.Avalanche,NetworkNames.Optimism,NetworkNames.Arbitrum,NetworkNames.Moonbeam,NetworkNames.Celo,NetworkNames.Fuse,NetworkNames.ArbitrumNova,NetworkNames.Klaytn,// NetworkNames.Neon,NetworkNames.OKTC,]

[EnvNames.TestNets]

[EnvNames.TestNets]: object

apiOptions

apiOptions: object

host

host: string = "qa-etherspot.pillarproject.io"

useSsl

useSsl: true = true

networkOptions

networkOptions: object

supportedNetworkNames

supportedNetworkNames: (Goerli | Chiado | BscTest | FantomTest | Mumbai | AuroraTest | Fuji | Moonbase | CeloTest | Etherspot | FuseSparknet | ArbitrumNitro | NeonDevnet | OptimismGoerli | BaseGoerli | KlaytnBaobab | OktcTest)[] = [NetworkNames.Goerli,NetworkNames.Chiado,NetworkNames.BscTest,NetworkNames.FantomTest,NetworkNames.Mumbai,NetworkNames.AuroraTest,NetworkNames.Fuji,NetworkNames.Moonbase,NetworkNames.CeloTest,NetworkNames.FuseSparknet,NetworkNames.ArbitrumNitro,NetworkNames.NeonDevnet,NetworkNames.OptimismGoerli,NetworkNames.BaseGoerli,NetworkNames.KlaytnBaobab,NetworkNames.OktcTest,NetworkNames.Etherspot,]

Const SUPPORTED_FAUCET_NETWORKS

SUPPORTED_FAUCET_NETWORKS: object

[NetworkNames.Etherspot]

[NetworkNames.Etherspot]: true = true

[NetworkNames.LocalA]

[NetworkNames.LocalA]: true = true

[NetworkNames.LocalB]

[NetworkNames.LocalB]: true = true

[NetworkNames.LocalH]

[NetworkNames.LocalH]: true = true

Const сacheSettings

сacheSettings: object

TokenList

TokenList: object

timeToLive

timeToLive: number = 1000 * 60 * 60 * 12