Skip to main content

Centrifuge

@centrifuge/sdk

@centrifuge/sdk / Centrifuge

Class: Centrifuge

Defined in: src/Centrifuge.ts:72

Constructors​

new Centrifuge()​

new Centrifuge(config): Centrifuge

Defined in: src/Centrifuge.ts:97

Parameters​

config​

Partial<Config> = {}

Returns​

Centrifuge

Accessors​

chains​

Get Signature​

get chains(): number[]

Defined in: src/Centrifuge.ts:82

Returns​

number[]

config​

Get Signature​

get config(): DerivedConfig

Defined in: src/Centrifuge.ts:74

Returns​

DerivedConfig

signer​

Get Signature​

get signer(): null | Signer

Defined in: src/Centrifuge.ts:93

Returns​

null | Signer

Methods​

account()​

account(address, chainId?): Query<Account>

Defined in: src/Centrifuge.ts:123

Parameters​

address​

string

chainId?​

number

Returns​

Query<Account>

balance()​

balance(currency, owner, chainId?): Query<Currency>

Defined in: src/Centrifuge.ts:168

Get the balance of an ERC20 token for a given owner.

Parameters​

currency​

string

The token address

owner​

string

The owner address

chainId?​

number

The chain ID

Returns​

Query<Currency>

currency()​

currency(address, chainId?): Query<CurrencyMetadata>

Defined in: src/Centrifuge.ts:132

Get the metadata for an ERC20 token

Parameters​

address​

string

The token address

chainId?​

number

The chain ID

Returns​

Query<CurrencyMetadata>

getChainConfig()​

getChainConfig(chainId?): Chain

Defined in: src/Centrifuge.ts:85

Parameters​

chainId?​

number

Returns​

Chain

getClient()​

getClient(chainId?): undefined | {}

Defined in: src/Centrifuge.ts:79

Parameters​

chainId?​

number

Returns​

undefined | {}

pool()​

pool(id, metadataHash?): Query<Pool>

Defined in: src/Centrifuge.ts:119

Parameters​

id​

string | number

metadataHash?​

string

Returns​

Query<Pool>

setSigner()​

setSigner(signer): void

Defined in: src/Centrifuge.ts:90

Parameters​

signer​

null | Signer

Returns​

void