@v3finance/core-sdk 0.1.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +441 -7
- package/README.md +219 -73
- package/dist/cjs/client.d.ts +67 -22
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +38 -2
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/core/errors.d.ts +30 -10
- package/dist/cjs/core/errors.d.ts.map +1 -1
- package/dist/cjs/core/errors.js +47 -15
- package/dist/cjs/core/errors.js.map +1 -1
- package/dist/cjs/core/gated.d.ts +30 -6
- package/dist/cjs/core/gated.d.ts.map +1 -1
- package/dist/cjs/core/gated.js +21 -6
- package/dist/cjs/core/gated.js.map +1 -1
- package/dist/cjs/core/http.d.ts +12 -8
- package/dist/cjs/core/http.d.ts.map +1 -1
- package/dist/cjs/core/http.js +147 -43
- package/dist/cjs/core/http.js.map +1 -1
- package/dist/cjs/core/pagination.d.ts +28 -1
- package/dist/cjs/core/pagination.d.ts.map +1 -1
- package/dist/cjs/core/pagination.js +36 -1
- package/dist/cjs/core/pagination.js.map +1 -1
- package/dist/cjs/generated/operations.js +1 -1
- package/dist/cjs/generated/types.d.ts +965 -179
- package/dist/cjs/generated/types.d.ts.map +1 -1
- package/dist/cjs/index.d.ts +32 -8
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +12 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/resources/addresses.d.ts +23 -8
- package/dist/cjs/resources/addresses.d.ts.map +1 -1
- package/dist/cjs/resources/addresses.js +8 -1
- package/dist/cjs/resources/addresses.js.map +1 -1
- package/dist/cjs/resources/admin.d.ts +150 -25
- package/dist/cjs/resources/admin.d.ts.map +1 -1
- package/dist/cjs/resources/admin.js +94 -23
- package/dist/cjs/resources/admin.js.map +1 -1
- package/dist/cjs/resources/approvals.d.ts +46 -5
- package/dist/cjs/resources/approvals.d.ts.map +1 -1
- package/dist/cjs/resources/approvals.js +27 -4
- package/dist/cjs/resources/approvals.js.map +1 -1
- package/dist/cjs/resources/balances.d.ts +152 -16
- package/dist/cjs/resources/balances.d.ts.map +1 -1
- package/dist/cjs/resources/balances.js +9 -5
- package/dist/cjs/resources/balances.js.map +1 -1
- package/dist/cjs/resources/categories.d.ts +93 -21
- package/dist/cjs/resources/categories.d.ts.map +1 -1
- package/dist/cjs/resources/categories.js +65 -18
- package/dist/cjs/resources/categories.js.map +1 -1
- package/dist/cjs/resources/counterparties.d.ts +26 -3
- package/dist/cjs/resources/counterparties.d.ts.map +1 -1
- package/dist/cjs/resources/counterparties.js +17 -0
- package/dist/cjs/resources/counterparties.js.map +1 -1
- package/dist/cjs/resources/folders.d.ts +51 -10
- package/dist/cjs/resources/folders.d.ts.map +1 -1
- package/dist/cjs/resources/folders.js +36 -5
- package/dist/cjs/resources/folders.js.map +1 -1
- package/dist/cjs/resources/history.d.ts +20 -2
- package/dist/cjs/resources/history.d.ts.map +1 -1
- package/dist/cjs/resources/history.js.map +1 -1
- package/dist/cjs/resources/me.d.ts +27 -4
- package/dist/cjs/resources/me.d.ts.map +1 -1
- package/dist/cjs/resources/me.js +22 -1
- package/dist/cjs/resources/me.js.map +1 -1
- package/dist/cjs/resources/members.d.ts +19 -4
- package/dist/cjs/resources/members.d.ts.map +1 -1
- package/dist/cjs/resources/members.js +15 -6
- package/dist/cjs/resources/members.js.map +1 -1
- package/dist/cjs/resources/operations.d.ts +64 -8
- package/dist/cjs/resources/operations.d.ts.map +1 -1
- package/dist/cjs/resources/operations.js +26 -2
- package/dist/cjs/resources/operations.js.map +1 -1
- package/dist/cjs/resources/registries.d.ts +87 -9
- package/dist/cjs/resources/registries.d.ts.map +1 -1
- package/dist/cjs/resources/registries.js +54 -11
- package/dist/cjs/resources/registries.js.map +1 -1
- package/dist/cjs/resources/reports.d.ts +300 -41
- package/dist/cjs/resources/reports.d.ts.map +1 -1
- package/dist/cjs/resources/reports.js +135 -7
- package/dist/cjs/resources/reports.js.map +1 -1
- package/dist/cjs/resources/sharing.d.ts +61 -10
- package/dist/cjs/resources/sharing.d.ts.map +1 -1
- package/dist/cjs/resources/sharing.js +51 -4
- package/dist/cjs/resources/sharing.js.map +1 -1
- package/dist/cjs/resources/transfers.d.ts +44 -6
- package/dist/cjs/resources/transfers.d.ts.map +1 -1
- package/dist/cjs/resources/transfers.js +41 -3
- package/dist/cjs/resources/transfers.js.map +1 -1
- package/dist/cjs/resources/types.d.ts +16 -0
- package/dist/cjs/resources/types.d.ts.map +1 -1
- package/dist/cjs/units.d.ts.map +1 -1
- package/dist/cjs/units.js +18 -2
- package/dist/cjs/units.js.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/client.d.ts +67 -22
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +38 -2
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/core/errors.d.ts +30 -10
- package/dist/esm/core/errors.d.ts.map +1 -1
- package/dist/esm/core/errors.js +47 -15
- package/dist/esm/core/errors.js.map +1 -1
- package/dist/esm/core/gated.d.ts +30 -6
- package/dist/esm/core/gated.d.ts.map +1 -1
- package/dist/esm/core/gated.js +21 -6
- package/dist/esm/core/gated.js.map +1 -1
- package/dist/esm/core/http.d.ts +12 -8
- package/dist/esm/core/http.d.ts.map +1 -1
- package/dist/esm/core/http.js +148 -44
- package/dist/esm/core/http.js.map +1 -1
- package/dist/esm/core/pagination.d.ts +28 -1
- package/dist/esm/core/pagination.d.ts.map +1 -1
- package/dist/esm/core/pagination.js +36 -1
- package/dist/esm/core/pagination.js.map +1 -1
- package/dist/esm/generated/operations.js +1 -1
- package/dist/esm/generated/types.d.ts +965 -179
- package/dist/esm/generated/types.d.ts.map +1 -1
- package/dist/esm/index.d.ts +32 -8
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +17 -5
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/resources/addresses.d.ts +23 -8
- package/dist/esm/resources/addresses.d.ts.map +1 -1
- package/dist/esm/resources/addresses.js +8 -1
- package/dist/esm/resources/addresses.js.map +1 -1
- package/dist/esm/resources/admin.d.ts +150 -25
- package/dist/esm/resources/admin.d.ts.map +1 -1
- package/dist/esm/resources/admin.js +94 -23
- package/dist/esm/resources/admin.js.map +1 -1
- package/dist/esm/resources/approvals.d.ts +46 -5
- package/dist/esm/resources/approvals.d.ts.map +1 -1
- package/dist/esm/resources/approvals.js +27 -4
- package/dist/esm/resources/approvals.js.map +1 -1
- package/dist/esm/resources/balances.d.ts +152 -16
- package/dist/esm/resources/balances.d.ts.map +1 -1
- package/dist/esm/resources/balances.js +9 -5
- package/dist/esm/resources/balances.js.map +1 -1
- package/dist/esm/resources/categories.d.ts +93 -21
- package/dist/esm/resources/categories.d.ts.map +1 -1
- package/dist/esm/resources/categories.js +65 -18
- package/dist/esm/resources/categories.js.map +1 -1
- package/dist/esm/resources/counterparties.d.ts +26 -3
- package/dist/esm/resources/counterparties.d.ts.map +1 -1
- package/dist/esm/resources/counterparties.js +17 -0
- package/dist/esm/resources/counterparties.js.map +1 -1
- package/dist/esm/resources/folders.d.ts +51 -10
- package/dist/esm/resources/folders.d.ts.map +1 -1
- package/dist/esm/resources/folders.js +36 -5
- package/dist/esm/resources/folders.js.map +1 -1
- package/dist/esm/resources/history.d.ts +20 -2
- package/dist/esm/resources/history.d.ts.map +1 -1
- package/dist/esm/resources/history.js.map +1 -1
- package/dist/esm/resources/me.d.ts +27 -4
- package/dist/esm/resources/me.d.ts.map +1 -1
- package/dist/esm/resources/me.js +22 -1
- package/dist/esm/resources/me.js.map +1 -1
- package/dist/esm/resources/members.d.ts +19 -4
- package/dist/esm/resources/members.d.ts.map +1 -1
- package/dist/esm/resources/members.js +15 -6
- package/dist/esm/resources/members.js.map +1 -1
- package/dist/esm/resources/operations.d.ts +64 -8
- package/dist/esm/resources/operations.d.ts.map +1 -1
- package/dist/esm/resources/operations.js +26 -2
- package/dist/esm/resources/operations.js.map +1 -1
- package/dist/esm/resources/registries.d.ts +87 -9
- package/dist/esm/resources/registries.d.ts.map +1 -1
- package/dist/esm/resources/registries.js +54 -11
- package/dist/esm/resources/registries.js.map +1 -1
- package/dist/esm/resources/reports.d.ts +300 -41
- package/dist/esm/resources/reports.d.ts.map +1 -1
- package/dist/esm/resources/reports.js +135 -7
- package/dist/esm/resources/reports.js.map +1 -1
- package/dist/esm/resources/sharing.d.ts +61 -10
- package/dist/esm/resources/sharing.d.ts.map +1 -1
- package/dist/esm/resources/sharing.js +51 -4
- package/dist/esm/resources/sharing.js.map +1 -1
- package/dist/esm/resources/transfers.d.ts +44 -6
- package/dist/esm/resources/transfers.d.ts.map +1 -1
- package/dist/esm/resources/transfers.js +41 -3
- package/dist/esm/resources/transfers.js.map +1 -1
- package/dist/esm/resources/types.d.ts +16 -0
- package/dist/esm/resources/types.d.ts.map +1 -1
- package/dist/esm/units.d.ts.map +1 -1
- package/dist/esm/units.js +18 -2
- package/dist/esm/units.js.map +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/docs/concepts.md +193 -0
- package/docs/errors.md +491 -0
- package/package.json +7 -6
- package/src/client.ts +89 -25
- package/src/core/errors.ts +49 -15
- package/src/core/gated.ts +31 -7
- package/src/core/http.ts +173 -49
- package/src/core/pagination.ts +38 -1
- package/src/generated/operations.ts +1 -1
- package/src/generated/types.ts +1001 -180
- package/src/index.ts +64 -7
- package/src/resources/addresses.ts +24 -8
- package/src/resources/admin.ts +186 -33
- package/src/resources/approvals.ts +55 -9
- package/src/resources/balances.ts +186 -14
- package/src/resources/categories.ts +125 -30
- package/src/resources/counterparties.ts +23 -6
- package/src/resources/folders.ts +74 -18
- package/src/resources/history.ts +27 -2
- package/src/resources/me.ts +30 -5
- package/src/resources/members.ts +26 -7
- package/src/resources/operations.ts +73 -8
- package/src/resources/registries.ts +90 -11
- package/src/resources/reports.ts +348 -67
- package/src/resources/sharing.ts +71 -18
- package/src/resources/transfers.ts +51 -7
- package/src/resources/types.ts +16 -0
- package/src/units.ts +19 -2
- package/src/version.ts +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../../src/resources/operations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAmB,MAAM,iBAAiB,CAAA;
|
|
1
|
+
{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../../src/resources/operations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAmB,MAAM,iBAAiB,CAAA;AAwCtD;;;;;;;;GAQG;AACH,MAAM,OAAO,kBAAkB;IACpB,KAAK,CAAY;IACjB,MAAM,CAAQ;IAEvB,YAAY,IAAgB,EAAE,SAAiB;QAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,SAAS,CAAC,CAAA;IAC9B,CAAC;IAED,GAAG,CAAC,IAAmB,EAAE,WAAmB;QAC1C,OAAO,kBAAkB,IAAI,CAAC,MAAM,eAAe,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,WAAW,CAAC,EAAE,CAAA;IACpF,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAmB,EAAE,WAAmB;QAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CACvB,KAAK,EACL,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,WAAW,CAC1C,CAAA;IACH,CAAC;IAED,WAAW,CACT,IAAmB,EACnB,WAAmB,EACnB,KAAiC;QAEjC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CACvB,OAAO,EACP,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,WAAW,EACzC,EAAE,IAAI,EAAE,KAAK,EAAE,CAChB,CAAA;IACH,CAAC;IAED,sEAAsE;IACtE,SAAS,CAAC,IAAmB,EAAE,WAAmB;QAChD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CACvB,KAAK,EACL,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,CAC3C,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAAmB,EACnB,WAAmB;QAWnB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,iBAAiB,CAAC,CAAA;IACnF,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,MAAM,GAAwB,EAAE;QAC5C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CACvB,KAAK,EACL,kBAAkB,IAAI,CAAC,MAAM,sBAAsB,EACnD,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CACzB,CAAA;IACH,CAAC;IAED,cAAc,CAAC,KAAkC;QAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CACvB,MAAM,EACN,kBAAkB,IAAI,CAAC,MAAM,sBAAsB,EACnD,EAAE,IAAI,EAAE,KAAK,EAAE,CAChB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,SAAiB;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CACvB,KAAK,EACL,kBAAkB,IAAI,CAAC,MAAM,aAAa,GAAG,CAAC,SAAS,CAAC,EAAE,CAC3D,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,iBAAiB,CAAC,MAAM,GAAwB,EAAE;QAChD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CACvB,KAAK,EACL,kBAAkB,IAAI,CAAC,MAAM,qBAAqB,EAClD,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CACzB,CAAA;IACH,CAAC;CACF"}
|
|
@@ -1,5 +1,39 @@
|
|
|
1
1
|
import type { HttpClient } from '../core/http.js';
|
|
2
|
-
import type { CreateNetworkBody, CreateTokenBody, EvaluationRequest, EvaluationResult, Network, PatchNetworkBody, PatchTokenBody, RatesResponse, TokenWithNetwork } from '../generated/types.js';
|
|
2
|
+
import type { AmlValue, CreateNetworkBody, CreateTokenBody, EvaluationRequest, EvaluationResult, Network, PatchNetworkBody, PatchTokenBody, RatesResponse, TokenWithNetwork } from '../generated/types.js';
|
|
3
|
+
/**
|
|
4
|
+
* The AML risk of one address, as `amlScore` returns it.
|
|
5
|
+
*
|
|
6
|
+
* Hand-written because the API declares this body inline rather than as a
|
|
7
|
+
* named schema, so `src/generated/types.ts` has no name for it. The risk
|
|
8
|
+
* LEVEL is reused from the generated policy selector (`AmlValue.minLevel`):
|
|
9
|
+
* one list, so a sixth level added to the API cannot be read here as five.
|
|
10
|
+
*/
|
|
11
|
+
export interface AmlScore {
|
|
12
|
+
address: string;
|
|
13
|
+
/** `tron` or `ethereum`, decided by the shape of the address. */
|
|
14
|
+
network: string;
|
|
15
|
+
/** 0–10. Do not threshold on it — see `level`. */
|
|
16
|
+
score: number;
|
|
17
|
+
/**
|
|
18
|
+
* Branch on THIS, not on `score`: the provider recalibrates its scores and
|
|
19
|
+
* ships its own thresholds with every answer, so a rule written in numbers
|
|
20
|
+
* drifts with their calibration while the level stays put.
|
|
21
|
+
*/
|
|
22
|
+
level: AmlValue['minLevel'];
|
|
23
|
+
/** Themes of the address's links: `Blacklisted`, `Sanction list`, `Exchange`… */
|
|
24
|
+
categories: Array<{
|
|
25
|
+
name: string;
|
|
26
|
+
count: number;
|
|
27
|
+
}>;
|
|
28
|
+
/** Counts of linked entities per level, plus incoming/outgoing/total. */
|
|
29
|
+
summary: Record<string, number> | null;
|
|
30
|
+
/** When the PROVIDER ran the check. */
|
|
31
|
+
checkedAt: string;
|
|
32
|
+
/** When we received it. With `cached: true` this is the age of the cache entry. */
|
|
33
|
+
fetchedAt: string;
|
|
34
|
+
/** `true` — served from the 24h cache, no external call was made. */
|
|
35
|
+
cached: boolean;
|
|
36
|
+
}
|
|
3
37
|
/**
|
|
4
38
|
* Registries and preflight checks. Not scoped to a vault.
|
|
5
39
|
*
|
|
@@ -16,8 +50,21 @@ export declare class RegistriesResource {
|
|
|
16
50
|
network?: string;
|
|
17
51
|
enabled?: boolean;
|
|
18
52
|
}): Promise<TokenWithNetwork[]>;
|
|
19
|
-
/**
|
|
20
|
-
|
|
53
|
+
/**
|
|
54
|
+
* USD rates used to value operations.
|
|
55
|
+
*
|
|
56
|
+
* `codes` narrows the answer to the tokens you name; without it every
|
|
57
|
+
* enabled token of the registry comes back. The parameter goes out as one
|
|
58
|
+
* comma-separated value, which is what the endpoint parses — an array is
|
|
59
|
+
* joined for you.
|
|
60
|
+
*
|
|
61
|
+
* Rates are fetched live on every call and NOT cached, so this is the
|
|
62
|
+
* "right now" figure. The rate stored on an operation is a separate thing:
|
|
63
|
+
* a snapshot taken when it was created.
|
|
64
|
+
*/
|
|
65
|
+
rates(params?: {
|
|
66
|
+
codes?: string | readonly string[] | undefined;
|
|
67
|
+
}): Promise<RatesResponse>;
|
|
21
68
|
/**
|
|
22
69
|
* Asks the policy engine what would happen, without doing it.
|
|
23
70
|
*
|
|
@@ -30,16 +77,47 @@ export declare class RegistriesResource {
|
|
|
30
77
|
* • it has no verdict for "there is nobody to sign". A chain that cannot
|
|
31
78
|
* be satisfied still previews as `requireApproval`, and the refusal
|
|
32
79
|
* arrives only when the request is actually created.
|
|
80
|
+
*
|
|
81
|
+
* `explain: true` adds a per-policy TRACE to the answer — why each policy
|
|
82
|
+
* did or did not apply, the main tool for debugging a rule set. All four
|
|
83
|
+
* decisions carry it then, a bare `deny` included, which is where it earns
|
|
84
|
+
* its keep: one entry per ENABLED policy the person has for this action,
|
|
85
|
+
* saying whether it applied and, for one that did not, the selector it
|
|
86
|
+
* failed on when one can be named. Somebody with no such policy gets an
|
|
87
|
+
* empty array rather than no key.
|
|
88
|
+
*
|
|
89
|
+
* Without the flag there is no `trace` at all. `EvaluationResult` keeps the
|
|
90
|
+
* field optional on every branch for that reason: the document describes
|
|
91
|
+
* both modes with one schema. The verdict itself is computed the same way
|
|
92
|
+
* either way.
|
|
33
93
|
*/
|
|
34
|
-
evaluate(input: EvaluationRequest
|
|
94
|
+
evaluate(input: EvaluationRequest, options?: {
|
|
95
|
+
explain?: boolean | undefined;
|
|
96
|
+
}): Promise<EvaluationResult>;
|
|
35
97
|
/**
|
|
36
|
-
* Current AML risk of an address.
|
|
98
|
+
* Current AML risk of an address. Call it BEFORE sending: the transfer form
|
|
99
|
+
* should show the recipient's risk before the button is pressed, not after.
|
|
100
|
+
*
|
|
101
|
+
* "Not checked" is NOT a value of `level` here. This endpoint either
|
|
102
|
+
* answers with a level or fails — 502 `AML_UNAVAILABLE` when the provider
|
|
103
|
+
* times out, 5xxs, or has no key configured, and 400 when the address
|
|
104
|
+
* matches neither the TRON nor the Ethereum shape. Treat the 502 as
|
|
105
|
+
* "could not check", never as a green badge; the `null` level that means
|
|
106
|
+
* "nobody ever checked" lives on OPERATIONS, not on this answer.
|
|
107
|
+
*
|
|
108
|
+
* What comes back is a snapshot cached for 24 hours — `cached` says whether
|
|
109
|
+
* an external call happened. `refresh` forces a fresh one and is the only
|
|
110
|
+
* way past the cache, so it belongs on an explicit user action ("check
|
|
111
|
+
* again"): it is slower and costs a provider call every time.
|
|
37
112
|
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
113
|
+
* Note what this is NOT: the risk recorded on a transfer or a deposit is a
|
|
114
|
+
* separate snapshot taken at the moment of the operation. This figure moves
|
|
115
|
+
* over time, so it will disagree with the one stored on an old operation,
|
|
116
|
+
* and that is the point of storing it there.
|
|
41
117
|
*/
|
|
42
|
-
amlScore(address: string
|
|
118
|
+
amlScore(address: string, options?: {
|
|
119
|
+
refresh?: boolean | undefined;
|
|
120
|
+
}): Promise<AmlScore>;
|
|
43
121
|
/**
|
|
44
122
|
* Registering a network. Administrators only.
|
|
45
123
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"registries.d.ts","sourceRoot":"","sources":["../../../src/resources/registries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,OAAO,EACP,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAE9B;;;;;;;GAOG;AACH,qBAAa,kBAAkB;;IAG7B,YAAY,IAAI,EAAE,UAAU,EAE3B;IAED,QAAQ,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAE7B;IAED,MAAM,CAAC,MAAM,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAExF;IAED,
|
|
1
|
+
{"version":3,"file":"registries.d.ts","sourceRoot":"","sources":["../../../src/resources/registries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,OAAO,EACP,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAE9B;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAA;IACf,kDAAkD;IAClD,KAAK,EAAE,MAAM,CAAA;IACb;;;;OAIG;IACH,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAA;IAC3B,iFAAiF;IACjF,UAAU,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAClD,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;IACtC,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAA;IACjB,mFAAmF;IACnF,SAAS,EAAE,MAAM,CAAA;IACjB,qEAAqE;IACrE,MAAM,EAAE,OAAO,CAAA;CAChB;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAkB;;IAG7B,YAAY,IAAI,EAAE,UAAU,EAE3B;IAED,QAAQ,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAE7B;IAED,MAAM,CAAC,MAAM,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAExF;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;KAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAE7F;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CACN,KAAK,EAAE,iBAAiB,EACxB,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAAO,GAC9C,OAAO,CAAC,gBAAgB,CAAC,CAK3B;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAI5F;IAED;;;;;;OAMG;IACH,aAAa,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAExD;IAED,2BAA2B;IAC3B,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAI1E;IAED;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAE7D;IAED;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAI7E;CACF"}
|
|
@@ -17,9 +17,20 @@ export class RegistriesResource {
|
|
|
17
17
|
tokens(params = {}) {
|
|
18
18
|
return this.#http.request('GET', '/api/v1/tokens', { query: { ...params } });
|
|
19
19
|
}
|
|
20
|
-
/**
|
|
21
|
-
|
|
22
|
-
|
|
20
|
+
/**
|
|
21
|
+
* USD rates used to value operations.
|
|
22
|
+
*
|
|
23
|
+
* `codes` narrows the answer to the tokens you name; without it every
|
|
24
|
+
* enabled token of the registry comes back. The parameter goes out as one
|
|
25
|
+
* comma-separated value, which is what the endpoint parses — an array is
|
|
26
|
+
* joined for you.
|
|
27
|
+
*
|
|
28
|
+
* Rates are fetched live on every call and NOT cached, so this is the
|
|
29
|
+
* "right now" figure. The rate stored on an operation is a separate thing:
|
|
30
|
+
* a snapshot taken when it was created.
|
|
31
|
+
*/
|
|
32
|
+
rates(params = {}) {
|
|
33
|
+
return this.#http.request('GET', '/api/v1/rates', { query: { ...params } });
|
|
23
34
|
}
|
|
24
35
|
/**
|
|
25
36
|
* Asks the policy engine what would happen, without doing it.
|
|
@@ -33,19 +44,51 @@ export class RegistriesResource {
|
|
|
33
44
|
* • it has no verdict for "there is nobody to sign". A chain that cannot
|
|
34
45
|
* be satisfied still previews as `requireApproval`, and the refusal
|
|
35
46
|
* arrives only when the request is actually created.
|
|
47
|
+
*
|
|
48
|
+
* `explain: true` adds a per-policy TRACE to the answer — why each policy
|
|
49
|
+
* did or did not apply, the main tool for debugging a rule set. All four
|
|
50
|
+
* decisions carry it then, a bare `deny` included, which is where it earns
|
|
51
|
+
* its keep: one entry per ENABLED policy the person has for this action,
|
|
52
|
+
* saying whether it applied and, for one that did not, the selector it
|
|
53
|
+
* failed on when one can be named. Somebody with no such policy gets an
|
|
54
|
+
* empty array rather than no key.
|
|
55
|
+
*
|
|
56
|
+
* Without the flag there is no `trace` at all. `EvaluationResult` keeps the
|
|
57
|
+
* field optional on every branch for that reason: the document describes
|
|
58
|
+
* both modes with one schema. The verdict itself is computed the same way
|
|
59
|
+
* either way.
|
|
36
60
|
*/
|
|
37
|
-
evaluate(input) {
|
|
38
|
-
return this.#http.request('POST', '/api/v1/evaluate', {
|
|
61
|
+
evaluate(input, options = {}) {
|
|
62
|
+
return this.#http.request('POST', '/api/v1/evaluate', {
|
|
63
|
+
body: input,
|
|
64
|
+
query: { ...options },
|
|
65
|
+
});
|
|
39
66
|
}
|
|
40
67
|
/**
|
|
41
|
-
* Current AML risk of an address.
|
|
68
|
+
* Current AML risk of an address. Call it BEFORE sending: the transfer form
|
|
69
|
+
* should show the recipient's risk before the button is pressed, not after.
|
|
70
|
+
*
|
|
71
|
+
* "Not checked" is NOT a value of `level` here. This endpoint either
|
|
72
|
+
* answers with a level or fails — 502 `AML_UNAVAILABLE` when the provider
|
|
73
|
+
* times out, 5xxs, or has no key configured, and 400 when the address
|
|
74
|
+
* matches neither the TRON nor the Ethereum shape. Treat the 502 as
|
|
75
|
+
* "could not check", never as a green badge; the `null` level that means
|
|
76
|
+
* "nobody ever checked" lives on OPERATIONS, not on this answer.
|
|
42
77
|
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
78
|
+
* What comes back is a snapshot cached for 24 hours — `cached` says whether
|
|
79
|
+
* an external call happened. `refresh` forces a fresh one and is the only
|
|
80
|
+
* way past the cache, so it belongs on an explicit user action ("check
|
|
81
|
+
* again"): it is slower and costs a provider call every time.
|
|
82
|
+
*
|
|
83
|
+
* Note what this is NOT: the risk recorded on a transfer or a deposit is a
|
|
84
|
+
* separate snapshot taken at the moment of the operation. This figure moves
|
|
85
|
+
* over time, so it will disagree with the one stored on an old operation,
|
|
86
|
+
* and that is the point of storing it there.
|
|
46
87
|
*/
|
|
47
|
-
amlScore(address) {
|
|
48
|
-
return this.#http.request('GET', '/api/v1/aml/score', {
|
|
88
|
+
amlScore(address, options = {}) {
|
|
89
|
+
return this.#http.request('GET', '/api/v1/aml/score', {
|
|
90
|
+
query: { address, ...options },
|
|
91
|
+
});
|
|
49
92
|
}
|
|
50
93
|
/**
|
|
51
94
|
* Registering a network. Administrators only.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"registries.js","sourceRoot":"","sources":["../../../src/resources/registries.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"registries.js","sourceRoot":"","sources":["../../../src/resources/registries.ts"],"names":[],"mappings":"AA8CA;;;;;;;GAOG;AACH,MAAM,OAAO,kBAAkB;IACpB,KAAK,CAAY;IAE1B,YAAY,IAAgB;QAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAY,KAAK,EAAE,kBAAkB,CAAC,CAAA;IACjE,CAAC;IAED,MAAM,CAAC,MAAM,GAA4C,EAAE;QACzD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAqB,KAAK,EAAE,gBAAgB,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAA;IAClG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,GAAuD,EAAE;QACnE,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAgB,KAAK,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAA;IAC5F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CACN,KAAwB,EACxB,OAAO,GAAsC,EAAE;QAE/C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAmB,MAAM,EAAE,kBAAkB,EAAE;YACtE,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE;SACtB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAO,GAAsC,EAAE;QACvE,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAW,KAAK,EAAE,mBAAmB,EAAE;YAC9D,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,KAAwB;QACpC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU,MAAM,EAAE,kBAAkB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACjF,CAAC;IAED,2BAA2B;IAC3B,aAAa,CAAC,SAAiB,EAAE,KAAuB;QACtD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU,OAAO,EAAE,oBAAoB,kBAAkB,CAAC,SAAS,CAAC,EAAE,EAAE;YAC/F,IAAI,EAAE,KAAK;SACZ,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,KAAsB;QAChC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAmB,MAAM,EAAE,gBAAgB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACxF,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,OAAe,EAAE,KAAqB;QAChD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAmB,OAAO,EAAE,kBAAkB,kBAAkB,CAAC,OAAO,CAAC,EAAE,EAAE;YACpG,IAAI,EAAE,KAAK;SACZ,CAAC,CAAA;IACJ,CAAC;CACF"}
|