@centrifuge/sdk 0.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2019 Centrifuge GmbH <https://centrifuge.io/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,149 @@
+[![Codecov](https://codecov.io/gh/centrifuge/sdk/graph/badge.svg?token=Q2yU8QfefP)](https://codecov.io/gh/centrifuge/sdk)
+[![Build CI status](https://github.com/centrifuge/sdk/actions/workflows/build-test-report.yml/badge.svg)](https://github.com/centrifuge/sdk/actions/workflows/build-test-report.yml)
+
+<!-- [![npm version](https://badge.fury.io/js/@centrifuge%2Fsdk.svg)](https://www.npmjs.com/package/@centrifuge/sdk) -->
+
+[![Latest Release](https://img.shields.io/github/v/release/centrifuge/sdk?sort=semver)](https://github.com/centrifuge/sdk/releases/latest)
+
+# Centrifuge JavaScript SDK
+
+CentrifugeSDK provides a JavaScript client to interact with the Centrifuge ecosystem. It provides a comprehensive interface to easily create and manage pools, nfts, loans and metadata.
+
+## Installation
+
+CentrifugeSDK uses [Viem](https://viem.sh/) under the hood. It's necessary to install it alongside the SDK.
+
+```bash
+npm install --save @centrifuge/sdk viem
+```
+
+## Init and config
+
+Create an instance and pass optional configuration
+
+```js
+import Centrifuge from '@centrifuge/sdk'
+
+const centrifuge = new Centrifuge()
+```
+
+The following config options can be passed on initilization of CentrifugeSDK:
+
+- `environment: 'mainnet' | 'demo' | 'dev'`
+  - Optional
+  - Default value: `mainnet`
+- `rpcUrls: Record<number, string>`
+  - Optional
+  - A object mapping chain ids to RPC URLs
+
+## Queries
+
+Queries return Promise-like [Observables](https://rxjs.dev/guide/observable). They can be either awaited to get a single value, or subscribed to to get fresh data whenever on-chain data changes.
+
+```js
+try {
+  const pool = await centrifuge.pools()
+} catch (error) {
+  console.error(error)
+}
+```
+
+```js
+const subscription = centrifuge.pools().subscribe(
+  (pool) => console.log(pool),
+  (error) => console.error(error)
+)
+subscription.unsubscribe()
+```
+
+The returned results are either immutable values, or entities that can be further queried.
+
+## Transactions
+
+To perform transactions, you need to set a signer on the `centrifuge` instance.
+
+```js
+centrifuge.setSigner(signer)
+```
+
+`signer` can be a [EIP1193](https://eips.ethereum.org/EIPS/eip-1193)-compatible provider or a Viem [LocalAccount](https://viem.sh/docs/accounts/local)
+
+With this you can call transaction methods. Similar to queries they can be awaited to get their final result, or subscribed to get get status updates.
+
+```js
+const pool = await centrifuge.pool('1')
+try {
+  const status = await pool.closeEpoch()
+  console.log(status)
+} catch (error) {
+  console.error(error)
+}
+```
+
+```js
+const pool = await centrifuge.pool('1')
+const subscription = pool.closeEpoch().subscribe(
+  (status) => console.log(pool),
+  (error) => console.error(error),
+  () => console.log('complete')
+)
+```
+
+## Reports
+
+Reports are generated from data from the Centrifuge API and are combined with pool metadata to provide a comprehensive view of the pool's financials.
+
+Available reports are:
+
+- `balanceSheet`
+- `profitAndLoss`
+- `cashflow`
+
+```ts
+const pool = await centrifuge.pool('<pool-id>')
+const balanceSheetReport = await pool.reports.balanceSheet()
+```
+
+### Report Filtering
+
+Reports can be filtered using the `ReportFilter` type.
+
+```ts
+type GroupBy = 'day' | 'month' | 'quarter' | 'year'
+
+const balanceSheetReport = await pool.reports.balanceSheet({
+  from: '2024-01-01',
+  to: '2024-01-31',
+  groupBy: 'month',
+})
+```
+
+## Developer Docs
+
+### Dev server
+
+```bash
+yarn dev
+```
+
+### Build
+
+```bash
+yarn build
+```
+
+### Test
+
+```bash
+yarn test
+yarn test:single <path-to-file>
+yarn test:simple:single <path-to-file> # without setup file, faster and without tenderly setup
+```
+
+### PR Naming Convention
+
+PR naming should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+
+### Semantic Versioning
+
+PRs should be marked with the appropriate type: `major`, `minor`, `patch`, `no-release`.

package/dist/Account.d.ts

@@ -0,0 +1,11 @@
+import type { Centrifuge } from './Centrifuge.js';
+import { Entity } from './Entity.js';
+import type { HexString } from './types/index.js';
+export declare class Account extends Entity {
+    accountId: HexString;
+    chainId: number;
+    constructor(_root: Centrifuge, accountId: HexString, chainId: number);
+    balances(): import("./index.js").Query<bigint>;
+    transfer(to: string, amount: bigint): import("./index.js").Transaction;
+}
+//# sourceMappingURL=Account.d.ts.map

package/dist/Account.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Account.d.ts","sourceRoot":"","sources":["../src/Account.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAKjD,qBAAa,OAAQ,SAAQ,MAAM;IAGxB,SAAS,EAAE,SAAS;IACpB,OAAO,EAAE,MAAM;gBAFtB,KAAK,EAAE,UAAU,EACV,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,MAAM;IAKxB,QAAQ;IA8BR,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAapC"}

package/dist/Account.js

@@ -0,0 +1,46 @@
+import { defer } from 'rxjs';
+import { ABI } from './abi/index.js';
+import { Entity } from './Entity.js';
+import { repeatOnEvents } from './utils/rx.js';
+const tUSD = '0x8503b4452Bf6238cC76CdbEE223b46d7196b1c93';
+export class Account extends Entity {
+    accountId;
+    chainId;
+    constructor(_root, accountId, chainId) {
+        super(_root, ['account', accountId, chainId]);
+        this.accountId = accountId;
+        this.chainId = chainId;
+    }
+    balances() {
+        return this._query(['balances'], () => {
+            return defer(async () => {
+                const client = this._root.getClient(this.chainId);
+                const balance = (await client.readContract({
+                    address: tUSD,
+                    abi: ABI.Currency,
+                    functionName: 'balanceOf',
+                    args: [this.accountId],
+                }));
+                return balance;
+            }).pipe(repeatOnEvents(this._root, {
+                address: tUSD,
+                abi: ABI.Currency,
+                eventName: 'Transfer',
+                filter: (events) => {
+                    return events.some((event) => {
+                        return event.args.from === this.accountId || event.args.to === this.accountId;
+                    });
+                },
+            }, this.chainId));
+        });
+    }
+    transfer(to, amount) {
+        return this._transact('Transfer', ({ walletClient }) => walletClient.writeContract({
+            address: tUSD,
+            abi: ABI.Currency,
+            functionName: 'transfer',
+            args: [to, amount],
+        }), this.chainId);
+    }
+}
+//# sourceMappingURL=Account.js.map

package/dist/Account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Account.js","sourceRoot":"","sources":["../src/Account.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAA;AAC5B,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AAEpC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAE9C,MAAM,IAAI,GAAG,4CAA4C,CAAA;AAEzD,MAAM,OAAO,OAAQ,SAAQ,MAAM;IAGxB;IACA;IAHT,YACE,KAAiB,EACV,SAAoB,EACpB,OAAe;QAEtB,KAAK,CAAC,KAAK,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAA;QAHtC,cAAS,GAAT,SAAS,CAAW;QACpB,YAAO,GAAP,OAAO,CAAQ;IAGxB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE;YACpC,OAAO,KAAK,CAAC,KAAK,IAAI,EAAE;gBACtB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAE,CAAA;gBAClD,MAAM,OAAO,GAAG,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC;oBACzC,OAAO,EAAE,IAAI;oBACb,GAAG,EAAE,GAAG,CAAC,QAAQ;oBACjB,YAAY,EAAE,WAAW;oBACzB,IAAI,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;iBACvB,CAAC,CAAW,CAAA;gBACb,OAAO,OAAO,CAAA;YAChB,CAAC,CAAC,CAAC,IAAI,CACL,cAAc,CACZ,IAAI,CAAC,KAAK,EACV;gBACE,OAAO,EAAE,IAAI;gBACb,GAAG,EAAE,GAAG,CAAC,QAAQ;gBACjB,SAAS,EAAE,UAAU;gBACrB,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;oBACjB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;wBAC3B,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,SAAS,CAAA;oBAC/E,CAAC,CAAC,CAAA;gBACJ,CAAC;aACF,EACD,IAAI,CAAC,OAAO,CACb,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,QAAQ,CAAC,EAAU,EAAE,MAAc;QACjC,OAAO,IAAI,CAAC,SAAS,CACnB,UAAU,EACV,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,CACnB,YAAY,CAAC,aAAa,CAAC;YACzB,OAAO,EAAE,IAAI;YACb,GAAG,EAAE,GAAG,CAAC,QAAQ;YACjB,YAAY,EAAE,UAAU;YACxB,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC;SACnB,CAAC,EACJ,IAAI,CAAC,OAAO,CACb,CAAA;IACH,CAAC;CACF"}