-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
862f7f1
commit 95301cd
Showing
52 changed files
with
3,422 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
|
||
## @centrifuge/sdk | ||
|
||
### References | ||
|
||
#### default | ||
|
||
Renames and re-exports [Centrifuge](#class-centrifuge) | ||
|
||
### Classes | ||
|
||
- [Centrifuge](#class-centrifuge) | ||
- [Currency](#class-currency) | ||
- [~~Perquintill~~](#class-perquintill) | ||
- [Pool](#class-pool) | ||
- [PoolNetwork](#class-poolnetwork) | ||
- [Price](#class-price) | ||
- [~~Rate~~](#class-rate) | ||
- [Reports](#class-reports) | ||
- [Vault](#class-vault) | ||
|
||
### Typees | ||
|
||
- [AssetListReport](#type-assetlistreport) | ||
- [AssetListReportBase](#type-assetlistreportbase) | ||
- [AssetListReportFilter](#type-assetlistreportfilter) | ||
- [AssetListReportPrivateCredit](#type-assetlistreportprivatecredit) | ||
- [AssetListReportPublicCredit](#type-assetlistreportpubliccredit) | ||
- [AssetTransactionReport](#type-assettransactionreport) | ||
- [AssetTransactionReportFilter](#type-assettransactionreportfilter) | ||
- [BalanceSheetReport](#type-balancesheetreport) | ||
- [CashflowReport](#type-cashflowreport) | ||
- [CashflowReportBase](#type-cashflowreportbase) | ||
- [CashflowReportPrivateCredit](#type-cashflowreportprivatecredit) | ||
- [CashflowReportPublicCredit](#type-cashflowreportpubliccredit) | ||
- [Client](#type-client) | ||
- [Config](#type-config) | ||
- [CurrencyMetadata](#type-currencymetadata) | ||
- [EIP1193ProviderLike](#type-eip1193providerlike) | ||
- [FeeTransactionReport](#type-feetransactionreport) | ||
- [FeeTransactionReportFilter](#type-feetransactionreportfilter) | ||
- [GroupBy](#type-groupby) | ||
- [HexString](#type-hexstring) | ||
- [InvestorListReport](#type-investorlistreport) | ||
- [InvestorListReportFilter](#type-investorlistreportfilter) | ||
- [InvestorTransactionsReport](#type-investortransactionsreport) | ||
- [InvestorTransactionsReportFilter](#type-investortransactionsreportfilter) | ||
- [OperationConfirmedStatus](#type-operationconfirmedstatus) | ||
- [OperationPendingStatus](#type-operationpendingstatus) | ||
- [OperationSignedMessageStatus](#type-operationsignedmessagestatus) | ||
- [OperationSigningMessageStatus](#type-operationsigningmessagestatus) | ||
- [OperationSigningStatus](#type-operationsigningstatus) | ||
- [OperationStatus](#type-operationstatus) | ||
- [OperationStatusType](#type-operationstatustype) | ||
- [OperationSwitchChainStatus](#type-operationswitchchainstatus) | ||
- [ProfitAndLossReport](#type-profitandlossreport) | ||
- [ProfitAndLossReportBase](#type-profitandlossreportbase) | ||
- [ProfitAndLossReportPrivateCredit](#type-profitandlossreportprivatecredit) | ||
- [ProfitAndLossReportPublicCredit](#type-profitandlossreportpubliccredit) | ||
- [Query](#type-query) | ||
- [ReportFilter](#type-reportfilter) | ||
- [Signer](#type-signer) | ||
- [TokenPriceReport](#type-tokenpricereport) | ||
- [TokenPriceReportFilter](#type-tokenpricereportfilter) | ||
- [Transaction](#type-transaction) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,224 @@ | ||
|
||
## Class: Centrifuge | ||
|
||
Defined in: [src/Centrifuge.ts:72](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L72) | ||
|
||
### Constructors | ||
|
||
#### new Centrifuge() | ||
|
||
> **new Centrifuge**(`config`): [`Centrifuge`](#class-centrifuge) | ||
Defined in: [src/Centrifuge.ts:97](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L97) | ||
|
||
##### Parameters | ||
|
||
###### config | ||
|
||
`Partial`\<[`Config`](#type-config)\> = `{}` | ||
|
||
##### Returns | ||
|
||
[`Centrifuge`](#class-centrifuge) | ||
|
||
### Accessors | ||
|
||
#### chains | ||
|
||
##### Get Signature | ||
|
||
> **get** **chains**(): `number`[] | ||
Defined in: [src/Centrifuge.ts:82](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L82) | ||
|
||
###### Returns | ||
|
||
`number`[] | ||
|
||
*** | ||
|
||
#### config | ||
|
||
##### Get Signature | ||
|
||
> **get** **config**(): `DerivedConfig` | ||
Defined in: [src/Centrifuge.ts:74](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L74) | ||
|
||
###### Returns | ||
|
||
`DerivedConfig` | ||
|
||
*** | ||
|
||
#### signer | ||
|
||
##### Get Signature | ||
|
||
> **get** **signer**(): `null` \| [`Signer`](#type-signer) | ||
Defined in: [src/Centrifuge.ts:93](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L93) | ||
|
||
###### Returns | ||
|
||
`null` \| [`Signer`](#type-signer) | ||
|
||
### Methods | ||
|
||
#### account() | ||
|
||
> **account**(`address`, `chainId`?): [`Query`](#type-query)\<`Account`\> | ||
Defined in: [src/Centrifuge.ts:123](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L123) | ||
|
||
##### Parameters | ||
|
||
###### address | ||
|
||
`string` | ||
|
||
###### chainId? | ||
|
||
`number` | ||
|
||
##### Returns | ||
|
||
[`Query`](#type-query)\<`Account`\> | ||
|
||
*** | ||
|
||
#### balance() | ||
|
||
> **balance**(`currency`, `owner`, `chainId`?): [`Query`](#type-query)\<[`Currency`](#class-currency)\> | ||
Defined in: [src/Centrifuge.ts:168](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L168) | ||
|
||
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`](#type-query)\<[`Currency`](#class-currency)\> | ||
|
||
*** | ||
|
||
#### currency() | ||
|
||
> **currency**(`address`, `chainId`?): [`Query`](#type-query)\<[`CurrencyMetadata`](#type-currencymetadata)\> | ||
Defined in: [src/Centrifuge.ts:132](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L132) | ||
|
||
Get the metadata for an ERC20 token | ||
|
||
##### Parameters | ||
|
||
###### address | ||
|
||
`string` | ||
|
||
The token address | ||
|
||
###### chainId? | ||
|
||
`number` | ||
|
||
The chain ID | ||
|
||
##### Returns | ||
|
||
[`Query`](#type-query)\<[`CurrencyMetadata`](#type-currencymetadata)\> | ||
|
||
*** | ||
|
||
#### getChainConfig() | ||
|
||
> **getChainConfig**(`chainId`?): `Chain` | ||
Defined in: [src/Centrifuge.ts:85](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L85) | ||
|
||
##### Parameters | ||
|
||
###### chainId? | ||
|
||
`number` | ||
|
||
##### Returns | ||
|
||
`Chain` | ||
|
||
*** | ||
|
||
#### getClient() | ||
|
||
> **getClient**(`chainId`?): `undefined` \| \{\} | ||
Defined in: [src/Centrifuge.ts:79](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L79) | ||
|
||
##### Parameters | ||
|
||
###### chainId? | ||
|
||
`number` | ||
|
||
##### Returns | ||
|
||
`undefined` \| \{\} | ||
|
||
*** | ||
|
||
#### pool() | ||
|
||
> **pool**(`id`, `metadataHash`?): [`Query`](#type-query)\<[`Pool`](#class-pool)\> | ||
Defined in: [src/Centrifuge.ts:119](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L119) | ||
|
||
##### Parameters | ||
|
||
###### id | ||
|
||
`string` | `number` | ||
|
||
###### metadataHash? | ||
|
||
`string` | ||
|
||
##### Returns | ||
|
||
[`Query`](#type-query)\<[`Pool`](#class-pool)\> | ||
|
||
*** | ||
|
||
#### setSigner() | ||
|
||
> **setSigner**(`signer`): `void` | ||
Defined in: [src/Centrifuge.ts:90](https://github.com/centrifuge/sdk/blob/862f7f1e7a8d6021f967d75a29f9dd861d4ba104/src/Centrifuge.ts#L90) | ||
|
||
##### Parameters | ||
|
||
###### signer | ||
|
||
`null` | [`Signer`](#type-signer) | ||
|
||
##### Returns | ||
|
||
`void` |
Oops, something went wrong.