@ardrive/turbo-sdk 1.0.0-alpha.22 → 1.0.0-alpha.24
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/README.md +54 -15
- package/bundles/web.bundle.min.js +116 -23
- package/lib/cjs/common/currency.js +42 -0
- package/lib/cjs/common/factory.js +23 -1
- package/lib/cjs/common/index.js +1 -0
- package/lib/cjs/common/payment.js +43 -9
- package/lib/cjs/common/turbo.js +16 -10
- package/lib/cjs/common/upload.js +4 -2
- package/lib/esm/common/currency.js +27 -0
- package/lib/esm/common/factory.js +24 -2
- package/lib/esm/common/index.js +1 -0
- package/lib/esm/common/payment.js +42 -8
- package/lib/esm/common/turbo.js +16 -10
- package/lib/esm/common/upload.js +3 -1
- package/lib/types/common/currency.d.ts +43 -0
- package/lib/types/common/currency.d.ts.map +1 -0
- package/lib/types/common/factory.d.ts +24 -2
- package/lib/types/common/factory.d.ts.map +1 -1
- package/lib/types/common/index.d.ts +1 -0
- package/lib/types/common/index.d.ts.map +1 -1
- package/lib/types/common/payment.d.ts +17 -7
- package/lib/types/common/payment.d.ts.map +1 -1
- package/lib/types/common/turbo.d.ts +8 -7
- package/lib/types/common/turbo.d.ts.map +1 -1
- package/lib/types/common/upload.d.ts +4 -2
- package/lib/types/common/upload.d.ts.map +1 -1
- package/lib/types/node/factory.d.ts +2 -2
- package/lib/types/node/factory.d.ts.map +1 -1
- package/lib/types/types.d.ts +47 -16
- package/lib/types/types.d.ts.map +1 -1
- package/lib/types/web/factory.d.ts +2 -2
- package/lib/types/web/factory.d.ts.map +1 -1
- package/package.json +1 -1
package/lib/types/types.d.ts
CHANGED
@@ -21,13 +21,21 @@ import { IAxiosRetryConfig } from 'axios-retry';
|
|
21
21
|
import { Readable } from 'node:stream';
|
22
22
|
import { ReadableStream } from 'node:stream/web';
|
23
23
|
import winston from 'winston';
|
24
|
+
import { CurrencyMap } from './common/currency.js';
|
24
25
|
import { JWKInterface } from './common/jwk.js';
|
25
26
|
export type Base64String = string;
|
26
27
|
export type PublicArweaveAddress = Base64String;
|
27
28
|
export type TransactionId = Base64String;
|
28
29
|
export type UserAddress = string | PublicArweaveAddress;
|
29
|
-
export type Currency = 'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | '
|
30
|
+
export type Currency = 'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'jpy' | 'inr' | 'sgd' | 'hkd' | 'brl';
|
30
31
|
export type Country = 'United States' | 'United Kingdom' | 'Canada';
|
32
|
+
export type Adjustment = {
|
33
|
+
name: string;
|
34
|
+
description: string;
|
35
|
+
operatorMagnitude: number;
|
36
|
+
operator: 'multiply' | 'add';
|
37
|
+
adjustmentAmount: string;
|
38
|
+
};
|
31
39
|
export type CurrencyLimit = {
|
32
40
|
minimumPaymentAmount: number;
|
33
41
|
maximumPaymentAmount: number;
|
@@ -36,7 +44,32 @@ export type CurrencyLimit = {
|
|
36
44
|
};
|
37
45
|
export type TurboPriceResponse = {
|
38
46
|
winc: string;
|
39
|
-
adjustments:
|
47
|
+
adjustments: Adjustment[];
|
48
|
+
};
|
49
|
+
export type TurboWincForFiatResponse = TurboPriceResponse & {
|
50
|
+
paymentAmount: number;
|
51
|
+
quotedPaymentAmount: number;
|
52
|
+
};
|
53
|
+
export type TurboWincForFiatParams = {
|
54
|
+
amount: CurrencyMap;
|
55
|
+
promoCodes?: string[];
|
56
|
+
};
|
57
|
+
export type TurboCheckoutSessionParams = TurboWincForFiatParams & {
|
58
|
+
owner: PublicArweaveAddress;
|
59
|
+
};
|
60
|
+
export type TopUpRawResponse = {
|
61
|
+
topUpQuote: {
|
62
|
+
paymentAmount: number;
|
63
|
+
quotedPaymentAmount: number;
|
64
|
+
winstonCreditAmount: string;
|
65
|
+
};
|
66
|
+
paymentSession: {
|
67
|
+
url: string;
|
68
|
+
};
|
69
|
+
adjustments: Adjustment[];
|
70
|
+
};
|
71
|
+
export type TurboCheckoutSessionResponse = TurboWincForFiatResponse & {
|
72
|
+
url: string;
|
40
73
|
};
|
41
74
|
export type TurboBalanceResponse = Omit<TurboPriceResponse, 'adjustments'>;
|
42
75
|
export type TurboFiatToArResponse = {
|
@@ -69,22 +102,22 @@ type TurboServiceConfiguration = {
|
|
69
102
|
retryConfig?: IAxiosRetryConfig;
|
70
103
|
logger?: winston.Logger;
|
71
104
|
};
|
72
|
-
export type
|
73
|
-
export type TurboAuthenticatedUploadServiceConfiguration =
|
74
|
-
export type
|
75
|
-
export type
|
76
|
-
export type
|
77
|
-
paymentServiceConfig?:
|
78
|
-
uploadServiceConfig?:
|
105
|
+
export type TurboUnauthenticatedUploadServiceConfiguration = TurboServiceConfiguration;
|
106
|
+
export type TurboAuthenticatedUploadServiceConfiguration = TurboUnauthenticatedUploadServiceConfiguration & TurboAuthConfiguration;
|
107
|
+
export type TurboUnauthenticatedPaymentServiceConfiguration = TurboServiceConfiguration;
|
108
|
+
export type TurboAuthenticatedPaymentServiceConfiguration = TurboUnauthenticatedPaymentServiceConfiguration & TurboAuthConfiguration;
|
109
|
+
export type TurboUnauthenticatedConfiguration = {
|
110
|
+
paymentServiceConfig?: TurboUnauthenticatedPaymentServiceConfiguration;
|
111
|
+
uploadServiceConfig?: TurboUnauthenticatedUploadServiceConfiguration;
|
79
112
|
};
|
80
|
-
export type
|
113
|
+
export type TurboAuthenticatedConfiguration = TurboUnauthenticatedConfiguration & {
|
81
114
|
privateKey: TurboWallet;
|
82
115
|
};
|
83
|
-
export type
|
116
|
+
export type TurboUnauthenticatedClientConfiguration = {
|
84
117
|
paymentService: TurboUnauthenticatedPaymentServiceInterface;
|
85
118
|
uploadService: TurboUnauthenticatedUploadServiceInterface;
|
86
119
|
};
|
87
|
-
export type
|
120
|
+
export type TurboAuthenticatedClientConfiguration = {
|
88
121
|
paymentService: TurboAuthenticatedPaymentServiceInterface;
|
89
122
|
uploadService: TurboAuthenticatedUploadServiceInterface;
|
90
123
|
};
|
@@ -128,13 +161,11 @@ export interface TurboUnauthenticatedPaymentServiceInterface {
|
|
128
161
|
currency: Currency;
|
129
162
|
}): Promise<TurboFiatToArResponse>;
|
130
163
|
getFiatRates(): Promise<TurboRatesResponse>;
|
131
|
-
getWincForFiat(
|
132
|
-
amount: number;
|
133
|
-
currency: Currency;
|
134
|
-
}): Promise<Omit<TurboPriceResponse, 'adjustments'>>;
|
164
|
+
getWincForFiat(params: TurboWincForFiatParams): Promise<TurboWincForFiatResponse>;
|
135
165
|
getUploadCosts({ bytes }: {
|
136
166
|
bytes: number[];
|
137
167
|
}): Promise<TurboPriceResponse[]>;
|
168
|
+
createCheckoutSession(params: TurboCheckoutSessionParams): Promise<TurboCheckoutSessionResponse>;
|
138
169
|
}
|
139
170
|
export interface TurboAuthenticatedPaymentServiceInterface extends TurboUnauthenticatedPaymentServiceInterface {
|
140
171
|
getBalance: () => Promise<TurboBalanceResponse>;
|
package/lib/types/types.d.ts.map
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC;AAChD,MAAM,MAAM,aAAa,GAAG,YAAY,CAAC;AACzC,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,oBAAoB,CAAC;AACxD,MAAM,MAAM,QAAQ,
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC;AAChD,MAAM,MAAM,aAAa,GAAG,YAAY,CAAC;AACzC,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,oBAAoB,CAAC;AACxD,MAAM,MAAM,QAAQ,GAChB,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,CAAC;AACV,MAAM,MAAM,OAAO,GAAG,eAAe,GAAG,gBAAgB,GAAG,QAAQ,CAAC;AAEpE,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,UAAU,GAAG,KAAK,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,mBAAmB,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,kBAAkB,GAAG;IAC1D,aAAa,EAAE,MAAM,CAAC;IACtB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,WAAW,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,sBAAsB,GAAG;IAChE,KAAK,EAAE,oBAAoB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE;QACV,aAAa,EAAE,MAAM,CAAC;QACtB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,mBAAmB,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,cAAc,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,wBAAwB,GAAG;IACpE,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;AAE3E,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG,kBAAkB,GACjD,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AAC3C,MAAM,MAAM,sBAAsB,GAAG,OAAO,EAAE,CAAC;AAC/C,MAAM,MAAM,uBAAuB,GAAG;IACpC,mBAAmB,EAAE,QAAQ,EAAE,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;CACzC,CAAC;AACF,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,EAAE,EAAE,aAAa,CAAC;IAClB,KAAK,EAAE,oBAAoB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC;AACvC,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAC5B,MAAM,EAAE,iBAAiB,CAAC;CAC3B,CAAC;AAEF,KAAK,yBAAyB,GAAG;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,8CAA8C,GACxD,yBAAyB,CAAC;AAC5B,MAAM,MAAM,4CAA4C,GACtD,8CAA8C,GAAG,sBAAsB,CAAC;AAE1E,MAAM,MAAM,+CAA+C,GACzD,yBAAyB,CAAC;AAC5B,MAAM,MAAM,6CAA6C,GACvD,+CAA+C,GAAG,sBAAsB,CAAC;AAE3E,MAAM,MAAM,iCAAiC,GAAG;IAC9C,oBAAoB,CAAC,EAAE,+CAA+C,CAAC;IACvE,mBAAmB,CAAC,EAAE,8CAA8C,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,+BAA+B,GACzC,iCAAiC,GAAG;IAClC,UAAU,EAAE,WAAW,CAAC;CACzB,CAAC;AAEJ,MAAM,MAAM,uCAAuC,GAAG;IACpD,cAAc,EAAE,2CAA2C,CAAC;IAC5D,aAAa,EAAE,0CAA0C,CAAC;CAC3D,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,cAAc,EAAE,yCAAyC,CAAC;IAC1D,aAAa,EAAE,wCAAwC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,iBAAiB,GACzB,CAAC,MAAM,QAAQ,CAAC,GAChB,CAAC,MAAM,cAAc,CAAC,GACtB,CAAC,MAAM,MAAM,CAAC,CAAC;AACnB,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;AACxD,MAAM,MAAM,iBAAiB,GAAG,MAAM,MAAM,CAAC;AAC7C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,eAAe,EAAE,iBAAiB,CAAC;CAEpC,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,mBAAmB,EAAE,iBAAiB,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,WAAW,yBAAyB;IACxC,GAAG,CAAC,CAAC,EAAE,EACL,QAAQ,EACR,MAAM,EACN,OAAO,EACP,eAAe,GAChB,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtE,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;KAC5B,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACf,IAAI,CAAC,CAAC,EAAE,EACN,QAAQ,EACR,MAAM,EACN,OAAO,EACP,eAAe,EACf,IAAI,GACL,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,WAAW,CAAC;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtE,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;QAC3B,IAAI,EAAE,QAAQ,GAAG,cAAc,GAAG,MAAM,CAAC;KAC1C,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,YAAY,CAAC,EACX,iBAAiB,EACjB,eAAe,GAChB,EAAE,gBAAgB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAC1D,4BAA4B,IAAI,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,2CAA2C;IAC1D,sBAAsB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC3D,qBAAqB,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACzD,WAAW,CAAC,EACV,QAAQ,GACT,EAAE;QACD,QAAQ,EAAE,QAAQ,CAAC;KACpB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACnC,YAAY,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC5C,cAAc,CACZ,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACrC,cAAc,CAAC,EAAE,KAAK,EAAE,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAC9E,qBAAqB,CACnB,MAAM,EAAE,0BAA0B,GACjC,OAAO,CAAC,4BAA4B,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,yCACf,SAAQ,2CAA2C;IACnD,UAAU,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,0CAA0C;IACzD,oBAAoB,CAAC,EACnB,qBAAqB,EACrB,MAAM,GACP,EAAE,0BAA0B,GAC3B,gBAAgB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;CAC3D;AAED,MAAM,WAAW,wCACf,SAAQ,0CAA0C;IAElD,UAAU,CAAC,EACT,iBAAiB,EACjB,eAAe,GAChB,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;CAC/E;AAED,MAAM,WAAW,mCACf,SAAQ,2CAA2C,EACjD,0CAA0C;CAAG;AACjD,MAAM,WAAW,iCACf,SAAQ,yCAAyC,EAC/C,wCAAwC;CAAG"}
|
@@ -16,8 +16,8 @@
|
|
16
16
|
*/
|
17
17
|
import { TurboBaseFactory } from '../common/factory.js';
|
18
18
|
import { TurboAuthenticatedClient } from '../common/index.js';
|
19
|
-
import {
|
19
|
+
import { TurboAuthenticatedConfiguration } from '../types.js';
|
20
20
|
export declare class TurboFactory extends TurboBaseFactory {
|
21
|
-
static authenticated({ privateKey, paymentServiceConfig, uploadServiceConfig, }:
|
21
|
+
static authenticated({ privateKey, paymentServiceConfig, uploadServiceConfig, }: TurboAuthenticatedConfiguration): TurboAuthenticatedClient;
|
22
22
|
}
|
23
23
|
//# sourceMappingURL=factory.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../src/web/factory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,wBAAwB,EAGzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,
|
1
|
+
{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../src/web/factory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,wBAAwB,EAGzB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,+BAA+B,EAAE,MAAM,aAAa,CAAC;AAG9D,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,MAAM,CAAC,aAAa,CAAC,EACnB,UAAU,EACV,oBAAyB,EACzB,mBAAwB,GACzB,EAAE,+BAA+B;CAenC"}
|