@connext/types¶
ClientOptions¶
Object including the options to instantiate the connext client with.
The object contains the following fields:
Name | Type | Description |
---|---|---|
rpcProviderUrl | String | the Web3 provider URL used by the client |
nodeUrl | String | url of the node |
mnemonic? | String | (optional) Mnemonic of the signing wallet |
externalWallet? | any | (optional) External wallet address |
channelProvider? | ChannelProvider | (optional) Injected ChannelProvider |
keyGen? | () => Promise |
Function passed in by wallets to generate ephemeral keys |
store? | object | Maps to set/get from CF. Defaults localStorage |
logLevel? | number | Depth of logging |
natsUrl? | String | Initially hardcoded |
natsClusterId? | String | Initially hardcoded |
natsToken? | String | Initially hardcoded |
If the optional values are not provided, they will default to the ones that synchronize with the hub’s configuration values. However, you must pass at least one signing option (mnemonic, externalWallet, or channelProvider).
Type aliases¶
Types¶
Object literals¶
Type aliases¶
ConditionResolvers¶
ConditionResolvers: object
Defined in controllers/ResolveConditionController.ts:14
Type declaration¶
ProposalValidator¶
ProposalValidator: object
Defined in validation/appProposals.ts:9
Type declaration¶
Variables¶
createPaymentId¶
createPaymentId: createRandom32ByteHexString = createRandom32ByteHexString
Defined in lib/utils.ts:78
createPreImage¶
createPreImage: createRandom32ByteHexString = createRandom32ByteHexString
Defined in lib/utils.ts:79
baseAppValidation¶
baseAppValidation(app: AppInstanceInfo, registeredInfo: RegisteredAppDetails, isVirtual: boolean, connext: ConnextInternal): Promise
Defined in validation/appProposals.ts:125
Parameters¶
app: AppInstanceInfo¶
registeredInfo: RegisteredAppDetails¶
isVirtual: boolean¶
connext: ConnextInternal¶
Returns Promise¶
calculateExchange¶
calculateExchange(amount: BigNumber, swapRate: string): BigNumber
Defined in controllers/SwapController.ts:19
Returns BigNumber¶
connect¶
connect(opts: ClientOptions): Promise<ConnextInternal>
Defined in connext.ts:62
Creates a new client-node connection with node at specified url
Parameters¶
opts: ClientOptions¶
The options to instantiate the client with. At a minimum, must contain the nodeUrl and a client signing key or mnemonic
Returns Promise<ConnextInternal>¶
createLinkedHash¶
createLinkedHash(action: UnidirectionalLinkedTransferAppActionBigNumber): string
Defined in lib/utils.ts:65
Returns string¶
createRandom32ByteHexString¶
createRandom32ByteHexString(): string
Defined in lib/utils.ts:74
Returns string¶
freeBalanceAddressFromXpub¶
freeBalanceAddressFromXpub(xpub: string): string
Defined in lib/utils.ts:61
Returns string¶
insertDefault¶
insertDefault(val: string, obj: any, keys: string[]): any
Defined in lib/utils.ts:39
Returns any¶
invalid32ByteHexString¶
invalid32ByteHexString(value: any): string | undefined
Defined in validation/hexStrings.ts:4
Returns string | undefined¶
invalidAddress¶
invalidAddress(value: string): string | undefined
Defined in validation/addresses.ts:24
Returns string | undefined¶
invalidXpub¶
invalidXpub(value: string): string | undefined
Defined in validation/addresses.ts:16
Returns string | undefined¶
isValidAddress¶
isValidAddress(value: any): boolean
Defined in validation/addresses.ts:4
Returns boolean¶
notBigNumber¶
notBigNumber(value: any): string | undefined
Defined in validation/bn.ts:15
Returns string | undefined¶
notBigNumberish¶
notBigNumberish(value: any): string | undefined
Defined in validation/bn.ts:21
Returns string | undefined¶
notGreaterThan¶
notGreaterThan(value: any, ceil: utils.BigNumberish): string | undefined
Defined in validation/bn.ts:31
Returns string | undefined¶
notGreaterThanOrEqualTo¶
notGreaterThanOrEqualTo(value: any, ceil: utils.BigNumberish): string | undefined
Defined in validation/bn.ts:40
Returns string | undefined¶
notLessThan¶
notLessThan(value: any, floor: utils.BigNumberish): string | undefined
Defined in validation/bn.ts:50
Returns string | undefined¶
notLessThanOrEqualTo¶
notLessThanOrEqualTo(value: any, floor: utils.BigNumberish): string | undefined
Defined in validation/bn.ts:59
Returns string | undefined¶
notNegative¶
notNegative(value: any): string | undefined
Defined in validation/bn.ts:72
Returns string | undefined¶
notPositive¶
notPositive(value: any): string | undefined
Defined in validation/bn.ts:68
Returns string | undefined¶
objMap¶
objMap<T, F, R>(obj: T, func: function): object
Defined in lib/utils.ts:13
Type parameters¶
T¶
F: keyof T¶
R¶
Parameters¶
obj: T¶
func: function¶
* * (val: T\[F\], field: F): R
* #### Parameters
##### val: T\[F\]
##### field: F
#### Returns R
Returns object¶
objMapPromise¶
objMapPromise<T, F, R>(obj: T, func: function): Promise
Defined in lib/utils.ts:26
Type parameters¶
T¶
F: keyof T¶
R¶
Parameters¶
obj: T¶
func: function¶
* * (val: T\[F\], field: F): Promise<R\>
* #### Parameters
##### val: T\[F\]
##### field: F
#### Returns Promise<R\>
Returns Promise<object>¶
prettyLog¶
prettyLog(app: AppInstanceInfo): string
Defined in validation/appProposals.ts:116
Returns string¶
publicIdentifierToAddress¶
publicIdentifierToAddress(publicIdentifier: string): string
Defined in lib/utils.ts:57
Returns string¶
validateLinkedTransferApp¶
validateLinkedTransferApp(app: AppInstanceInfo, registeredInfo: RegisteredAppDetails, isVirtual: boolean, connext: ConnextInternal): Promise
Defined in validation/appProposals.ts:100
Parameters¶
app: AppInstanceInfo¶
registeredInfo: RegisteredAppDetails¶
isVirtual: boolean¶
connext: ConnextInternal¶
Returns Promise¶
validateSimpleTransferApp¶
validateSimpleTransferApp(app: AppInstanceInfo, registeredInfo: RegisteredAppDetails, isVirtual: boolean, connext: ConnextInternal): Promise
Defined in validation/appProposals.ts:68
Parameters¶
app: AppInstanceInfo¶
registeredInfo: RegisteredAppDetails¶
isVirtual: boolean¶
connext: ConnextInternal¶
Returns Promise¶
validateSwapApp¶
validateSwapApp(app: AppInstanceInfo, registeredInfo: RegisteredAppDetails, isVirtual: boolean, connext: ConnextInternal): Promise
Defined in validation/appProposals.ts:18
Parameters¶
app: AppInstanceInfo¶
registeredInfo: RegisteredAppDetails¶
isVirtual: boolean¶
connext: ConnextInternal¶
Returns Promise¶
validateTransferApp¶
validateTransferApp(app: AppInstanceInfo, registeredInfo: RegisteredAppDetails, isVirtual: boolean, connext: ConnextInternal): Promise
Defined in validation/appProposals.ts:37
Parameters¶
app: AppInstanceInfo¶
registeredInfo: RegisteredAppDetails¶
isVirtual: boolean¶
connext: ConnextInternal¶
Returns Promise¶
Object literals¶
SimpleTransferApp¶
SimpleTransferApp: validateSimpleTransferApp = validateSimpleTransferApp
Defined in validation/appProposals.ts:110
SimpleTwoPartySwapApp¶
SimpleTwoPartySwapApp: validateSwapApp = validateSwapApp
Defined in validation/appProposals.ts:111
UnidirectionalLinkedTransferApp¶
UnidirectionalLinkedTransferApp: validateLinkedTransferApp = validateLinkedTransferApp
Defined in validation/appProposals.ts:112
UnidirectionalTransferApp¶
UnidirectionalTransferApp: validateTransferApp = validateTransferApp
Defined in validation/appProposals.ts:113