@celo/contractkit › "wrappers/BaseWrapper"

Module: "wrappers/BaseWrapper"

Index

Classes

Functions

Functions

Const blocksToDurationString

▸ blocksToDurationString(input: BigNumber.Value): string

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:143

Parameters:

Name Type
input BigNumber.Value

Returns: string

Const bufferToSolidityBytes

▸ bufferToSolidityBytes(input: Buffer): SolidityBytes

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:165

Parameters:

Name Type
input Buffer

Returns: SolidityBytes

Const fixidityValueToBigNumber

▸ fixidityValueToBigNumber(input: BigNumber.Value): BigNumber‹›

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:83

Parameters:

Name Type
input BigNumber.Value

Returns: BigNumber‹›

Const identity

▸ identity<A>(a: A): A

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:180

Identity Parser

Type parameters:

▪ A

Parameters:

Name Type
a A

Returns: A

proxyCall

▸ proxyCall<InputArgs, ParsedInputArgs, PreParsedOutput, Output>(methodFn: Method‹ParsedInputArgs, PreParsedOutput›, parseInputArgs: function, parseOutput: function): function

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:249

Creates a proxy to call a web3 native contract method.

There are 4 cases: - methodFn - parseInputArgs => methodFn - parseInputArgs => methodFn => parseOutput - methodFn => parseOutput

Type parameters:

▪ InputArgs: any[]

▪ ParsedInputArgs: any[]

▪ PreParsedOutput

▪ Output

Parameters:

▪ methodFn: Method‹ParsedInputArgs, PreParsedOutput›

Web3 methods function

▪ parseInputArgs: function

parseInputArgs function, tranforms arguments into methodFn expected inputs

▸ (...args: InputArgs): ParsedInputArgs

Parameters:

Name Type
...args InputArgs

▪ parseOutput: function

parseOutput function, transforms methodFn output into proxy return

▸ (o: PreParsedOutput): Output

Parameters:

Name Type
o PreParsedOutput

Returns: function

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name Type
...args InputArgs

▸ proxyCall<InputArgs, PreParsedOutput, Output>(methodFn: Method‹InputArgs, PreParsedOutput›, x: undefined, parseOutput: function): function

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:259

Type parameters:

▪ InputArgs: any[]

▪ PreParsedOutput

▪ Output

Parameters:

▪ methodFn: Method‹InputArgs, PreParsedOutput›

▪ x: undefined

▪ parseOutput: function

▸ (o: PreParsedOutput): Output

Parameters:

Name Type
o PreParsedOutput

Returns: function

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name Type
...args InputArgs

▸ proxyCall<InputArgs, ParsedInputArgs, Output>(methodFn: Method‹ParsedInputArgs, Output›, parseInputArgs: function): function

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:264

Type parameters:

▪ InputArgs: any[]

▪ ParsedInputArgs: any[]

▪ Output

Parameters:

▪ methodFn: Method‹ParsedInputArgs, Output›

▪ parseInputArgs: function

▸ (...args: InputArgs): ParsedInputArgs

Parameters:

Name Type
...args InputArgs

Returns: function

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name Type
...args InputArgs

▸ proxyCall<InputArgs, Output>(methodFn: Method‹InputArgs, Output›): function

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:268

Type parameters:

▪ InputArgs: any[]

▪ Output

Parameters:

Name Type
methodFn Method‹InputArgs, Output›

Returns: function

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name Type
...args InputArgs

proxySend

▸ proxySend<InputArgs, ParsedInputArgs, Output>(kit: ContractKit, ...sendArgs: ProxySendArgs‹InputArgs, ParsedInputArgs, Output›): function

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:329

Creates a proxy to send a tx on a web3 native contract method.

There are 2 cases: - call methodFn (no pre or post parsing) - preParse arguments & call methodFn

Type parameters:

▪ InputArgs: any[]

▪ ParsedInputArgs: any[]

▪ Output

Parameters:

Name Type
kit ContractKit
...sendArgs ProxySendArgs‹InputArgs, ParsedInputArgs, Output›

Returns: function

▸ (...args: InputArgs): CeloTransactionObject‹Output›

Parameters:

Name Type
...args InputArgs

secondsToDurationString

▸ secondsToDurationString(durationSeconds: BigNumber.Value, outputUnits: TimeUnit[]): string

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:114

Parameters:

Name Type Default
durationSeconds BigNumber.Value -
outputUnits TimeUnit[] ['year', 'month', 'week', 'day', 'hour', 'minute', 'second']

Returns: string

Const solidityBytesToString

▸ solidityBytesToString(input: SolidityBytes): string

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:166

Parameters:

Name Type
input SolidityBytes

Returns: string

Const stringIdentity

▸ stringIdentity(x: string): string

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:181

Parameters:

Name Type
x string

Returns: string

Const stringToSolidityBytes

▸ stringToSolidityBytes(input: string): SolidityBytes

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:164

Parameters:

Name Type
input string

Returns: SolidityBytes

tupleParser

▸ tupleParser<A0, B0>(parser0: Parser‹A0, B0›): function

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:187

Tuple parser Useful to map different input arguments

Type parameters:

▪ A0

▪ B0

Parameters:

Name Type
parser0 Parser‹A0, B0›

Returns: function

▸ (...args: [A0]): [B0]

Parameters:

Name Type
...args [A0]

▸ tupleParser<A0, B0, A1, B1>(parser0: Parser‹A0, B0›, parser1: Parser‹A1, B1›): function

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:188

Type parameters:

▪ A0

▪ B0

▪ A1

▪ B1

Parameters:

Name Type
parser0 Parser‹A0, B0›
parser1 Parser‹A1, B1›

Returns: function

▸ (...args: [A0, A1]): [B0, B1]

Parameters:

Name Type
...args [A0, A1]

▸ tupleParser<A0, B0, A1, B1, A2, B2>(parser0: Parser‹A0, B0›, parser1: Parser‹A1, B1›, parser2: Parser‹A2, B2›): function

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:192

Type parameters:

▪ A0

▪ B0

▪ A1

▪ B1

▪ A2

▪ B2

Parameters:

Name Type
parser0 Parser‹A0, B0›
parser1 Parser‹A1, B1›
parser2 Parser‹A2, B2›

Returns: function

▸ (...args: [A0, A1, A2]): [B0, B1, B2]

Parameters:

Name Type
...args [A0, A1, A2]

▸ tupleParser<A0, B0, A1, B1, A2, B2, A3, B3>(parser0: Parser‹A0, B0›, parser1: Parser‹A1, B1›, parser2: Parser‹A2, B2›, parser3: Parser‹A3, B3›): function

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:197

Type parameters:

▪ A0

▪ B0

▪ A1

▪ B1

▪ A2

▪ B2

▪ A3

▪ B3

Parameters:

Name Type
parser0 Parser‹A0, B0›
parser1 Parser‹A1, B1›
parser2 Parser‹A2, B2›
parser3 Parser‹A3, B3›

Returns: function

▸ (...args: [A0, A1, A2, A3]): [B0, B1, B2, B3]

Parameters:

Name Type
...args [A0, A1, A2, A3]

Const unixSecondsTimestampToDateString

▸ unixSecondsTimestampToDateString(input: BigNumber.Value): string

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:156

Parameters:

Name Type
input BigNumber.Value

Returns: string

Const valueToBigNumber

▸ valueToBigNumber(input: BigNumber.Value): BigNumber‹›

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:81

Parameters:

Name Type
input BigNumber.Value

Returns: BigNumber‹›

Const valueToFixidityString

▸ valueToFixidityString(input: BigNumber.Value): string

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:87

Parameters:

Name Type
input BigNumber.Value

Returns: string

Const valueToFrac

▸ valueToFrac(numerator: BigNumber.Value, denominator: BigNumber.Value): BigNumber‹›

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:93

Parameters:

Name Type
numerator BigNumber.Value
denominator BigNumber.Value

Returns: BigNumber‹›

Const valueToInt

▸ valueToInt(input: BigNumber.Value): number

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:90

Parameters:

Name Type
input BigNumber.Value

Returns: number

Const valueToString

▸ valueToString(input: BigNumber.Value): string

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:85

Parameters:

Name Type
input BigNumber.Value

Returns: string