@bsv/sdk 1.4.22 → 1.4.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/dist/cjs/package.json +1 -1
- package/dist/cjs/src/auth/certificates/VerifiableCertificate.js +10 -0
- package/dist/cjs/src/auth/certificates/VerifiableCertificate.js.map +1 -1
- package/dist/cjs/src/auth/clients/AuthFetch.js.map +1 -1
- package/dist/cjs/src/transaction/broadcasters/Teranode.js +64 -0
- package/dist/cjs/src/transaction/broadcasters/Teranode.js.map +1 -0
- package/dist/cjs/src/transaction/broadcasters/index.js +3 -1
- package/dist/cjs/src/transaction/broadcasters/index.js.map +1 -1
- package/dist/cjs/src/transaction/http/BinaryFetchClient.js +94 -0
- package/dist/cjs/src/transaction/http/BinaryFetchClient.js.map +1 -0
- package/dist/cjs/src/transaction/http/NodejsHttpClient.js.map +1 -1
- package/dist/cjs/src/transaction/http/index.js +3 -1
- package/dist/cjs/src/transaction/http/index.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/auth/certificates/VerifiableCertificate.js +10 -0
- package/dist/esm/src/auth/certificates/VerifiableCertificate.js.map +1 -1
- package/dist/esm/src/auth/clients/AuthFetch.js.map +1 -1
- package/dist/esm/src/transaction/broadcasters/Teranode.js +62 -0
- package/dist/esm/src/transaction/broadcasters/Teranode.js.map +1 -0
- package/dist/esm/src/transaction/broadcasters/index.js +1 -0
- package/dist/esm/src/transaction/broadcasters/index.js.map +1 -1
- package/dist/esm/src/transaction/http/BinaryFetchClient.js +90 -0
- package/dist/esm/src/transaction/http/BinaryFetchClient.js.map +1 -0
- package/dist/esm/src/transaction/http/NodejsHttpClient.js.map +1 -1
- package/dist/esm/src/transaction/http/index.js +1 -0
- package/dist/esm/src/transaction/http/index.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/auth/certificates/VerifiableCertificate.d.ts +9 -1
- package/dist/types/src/auth/certificates/VerifiableCertificate.d.ts.map +1 -1
- package/dist/types/src/auth/clients/AuthFetch.d.ts.map +1 -1
- package/dist/types/src/transaction/broadcasters/Teranode.d.ts +25 -0
- package/dist/types/src/transaction/broadcasters/Teranode.d.ts.map +1 -0
- package/dist/types/src/transaction/broadcasters/index.d.ts +1 -0
- package/dist/types/src/transaction/broadcasters/index.d.ts.map +1 -1
- package/dist/types/src/transaction/http/BinaryFetchClient.d.ts +50 -0
- package/dist/types/src/transaction/http/BinaryFetchClient.d.ts.map +1 -0
- package/dist/types/src/transaction/http/index.d.ts +1 -0
- package/dist/types/src/transaction/http/index.d.ts.map +1 -1
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/dist/umd/bundle.js +1 -1
- package/docs/auth.md +120 -46
- package/docs/compat.md +48 -24
- package/docs/identity.md +14 -8
- package/docs/kvstore.md +9 -3
- package/docs/messages.md +4 -4
- package/docs/overlay-tools.md +69 -21
- package/docs/primitives.md +379 -235
- package/docs/registry.md +20 -14
- package/docs/script.md +87 -33
- package/docs/storage.md +17 -11
- package/docs/totp.md +11 -5
- package/docs/transaction.md +145 -67
- package/docs/wallet.md +169 -133
- package/package.json +1 -1
- package/src/auth/certificates/VerifiableCertificate.ts +24 -0
- package/src/auth/certificates/__tests/VerifiableCertificate.test.ts +28 -1
- package/src/auth/clients/AuthFetch.ts +2 -0
- package/src/transaction/broadcasters/Teranode.ts +77 -0
- package/src/transaction/broadcasters/index.ts +1 -0
- package/src/transaction/http/BinaryFetchClient.ts +141 -0
- package/src/transaction/http/NodejsHttpClient.ts +1 -1
- package/src/transaction/http/index.ts +1 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AuthFetch.d.ts","sourceRoot":"","sources":["../../../../../src/auth/clients/AuthFetch.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAEjC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAIhF,UAAU,6BAA6B;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,UAAU,QAAQ;IAChB,IAAI,EAAE,IAAI,CAAA;IACV,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,0BAA0B,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;CACxC;AAID;;;;;;;GAOG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAC/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,SAAS,CAA8D;IAC/E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA8B;IACnE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAyB;IAChE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAK;IAEpC;;;;MAIE;gBACU,MAAM,EAAE,eAAe,EAAE,qBAAqB,CAAC,EAAE,uBAAuB,EAAE,cAAc,CAAC,EAAE,cAAc;IAMrH;;;;;;;;;;;;OAYG;IACG,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,6BAAkC,GAAG,OAAO,CAAC,QAAQ,CAAC;IAqLvF;;;;OAIG;IACG,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,qBAAqB,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAuC/H;;OAEG;IACI,2BAA2B,IAAI,qBAAqB,EAAE;IAI7D;;;;;;;;;;;OAWG;YACW,gBAAgB;IAqG9B;;OAEG;YACW,sBAAsB;IAgBpC;;;OAGG;YACW,qBAAqB;
|
|
1
|
+
{"version":3,"file":"AuthFetch.d.ts","sourceRoot":"","sources":["../../../../../src/auth/clients/AuthFetch.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AAEjC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAIhF,UAAU,6BAA6B;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,UAAU,QAAQ;IAChB,IAAI,EAAE,IAAI,CAAA;IACV,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,0BAA0B,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;CACxC;AAID;;;;;;;GAOG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAC/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,SAAS,CAA8D;IAC/E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA8B;IACnE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAyB;IAChE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAK;IAEpC;;;;MAIE;gBACU,MAAM,EAAE,eAAe,EAAE,qBAAqB,CAAC,EAAE,uBAAuB,EAAE,cAAc,CAAC,EAAE,cAAc;IAMrH;;;;;;;;;;;;OAYG;IACG,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,6BAAkC,GAAG,OAAO,CAAC,QAAQ,CAAC;IAqLvF;;;;OAIG;IACG,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,qBAAqB,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAuC/H;;OAEG;IACI,2BAA2B,IAAI,qBAAqB,EAAE;IAI7D;;;;;;;;;;;OAWG;YACW,gBAAgB;IAqG9B;;OAEG;YACW,sBAAsB;IAgBpC;;;OAGG;YACW,qBAAqB;YAyErB,0BAA0B;CAwDzC"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { BroadcastResponse, BroadcastFailure, Broadcaster } from '../Broadcaster.js';
|
|
2
|
+
import Transaction from '../Transaction.js';
|
|
3
|
+
import { HttpClient } from '../http/index.js';
|
|
4
|
+
/**
|
|
5
|
+
* Represents an Teranode transaction broadcaster.
|
|
6
|
+
*/
|
|
7
|
+
export default class Teranode implements Broadcaster {
|
|
8
|
+
readonly URL: string;
|
|
9
|
+
readonly httpClient: HttpClient;
|
|
10
|
+
/**
|
|
11
|
+
* Constructs an instance of the Teranode broadcaster.
|
|
12
|
+
*
|
|
13
|
+
* @param {string} URL - The URL endpoint for the Teranode API.
|
|
14
|
+
* @param {HttpClient} httpClient - The HTTP client used to make requests to the API, binaryHttpClient by default.
|
|
15
|
+
*/
|
|
16
|
+
constructor(URL: string, httpClient?: HttpClient);
|
|
17
|
+
/**
|
|
18
|
+
* Broadcasts a transaction via Teranode.
|
|
19
|
+
*
|
|
20
|
+
* @param {Transaction} tx - The transaction to be broadcasted.
|
|
21
|
+
* @returns {Promise<BroadcastResponse | BroadcastFailure>} A promise that resolves to either a success or failure response.
|
|
22
|
+
*/
|
|
23
|
+
broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure>;
|
|
24
|
+
}
|
|
25
|
+
//# sourceMappingURL=Teranode.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Teranode.d.ts","sourceRoot":"","sources":["../../../../../src/transaction/broadcasters/Teranode.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACZ,MAAM,mBAAmB,CAAA;AAC1B,OAAO,WAAW,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAoB,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE/D;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,YAAW,WAAW;IAClD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAA;IAE/B;;;;;OAKG;gBAED,GAAG,EAAE,MAAM,EACX,UAAU,GAAE,UAA+B;IAM7C;;;;;OAKG;IACG,SAAS,CACb,EAAE,EAAE,WAAW,GACd,OAAO,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;CAuCjD"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export { default as ARC } from './ARC.js';
|
|
2
2
|
export type { ArcConfig } from './ARC.js';
|
|
3
3
|
export { default as WhatsOnChainBroadcaster } from './WhatsOnChainBroadcaster.js';
|
|
4
|
+
export { default as Teranode } from './Teranode.js';
|
|
4
5
|
export { defaultBroadcaster } from './DefaultBroadcaster.js';
|
|
5
6
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/transaction/broadcasters/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,UAAU,CAAA;AACzC,YAAY,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AACjF,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/transaction/broadcasters/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,GAAG,EAAE,MAAM,UAAU,CAAA;AACzC,YAAY,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AACjF,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/// <reference types="node" resolution-mode="require"/>
|
|
2
|
+
/// <reference types="node" resolution-mode="require"/>
|
|
3
|
+
import { HttpClient, HttpClientRequestOptions, HttpClientResponse } from './HttpClient.js';
|
|
4
|
+
/** Node Https module interface limited to options needed by ts-sdk */
|
|
5
|
+
export interface BinaryHttpsNodejs {
|
|
6
|
+
request: (url: string, options: HttpClientRequestOptions, callback: (res: any) => void) => BinaryNodejsHttpClientRequest;
|
|
7
|
+
}
|
|
8
|
+
/** Nodejs result of the Node https.request call limited to options needed by ts-sdk */
|
|
9
|
+
export interface BinaryNodejsHttpClientRequest {
|
|
10
|
+
write: (chunk: Buffer) => void;
|
|
11
|
+
on: (event: string, callback: (data: any) => void) => void;
|
|
12
|
+
end: (() => void) & (() => void);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Adapter for Node Https module to be used as HttpClient
|
|
16
|
+
*/
|
|
17
|
+
export declare class BinaryNodejsHttpClient implements HttpClient {
|
|
18
|
+
private readonly https;
|
|
19
|
+
constructor(https: BinaryHttpsNodejs);
|
|
20
|
+
request(url: string, requestOptions: HttpClientRequestOptions): Promise<HttpClientResponse>;
|
|
21
|
+
}
|
|
22
|
+
/** fetch function interface limited to options needed by ts-sdk */
|
|
23
|
+
/**
|
|
24
|
+
* Makes a request to the server.
|
|
25
|
+
* @param url The URL to make the request to.
|
|
26
|
+
* @param options The request configuration.
|
|
27
|
+
*/
|
|
28
|
+
export type Fetch = (url: string, options: FetchOptions) => Promise<Response>;
|
|
29
|
+
/**
|
|
30
|
+
* An interface for configuration of the request to be passed to the fetch method
|
|
31
|
+
* limited to options needed by ts-sdk.
|
|
32
|
+
*/
|
|
33
|
+
export interface FetchOptions {
|
|
34
|
+
/** A string to set request's method. */
|
|
35
|
+
method?: string;
|
|
36
|
+
/** An object literal set request's headers. */
|
|
37
|
+
headers?: Record<string, string>;
|
|
38
|
+
/** An object or null to set request's body. */
|
|
39
|
+
body?: Buffer | Uint8Array | Blob | null;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Adapter for Node Https module to be used as HttpClient
|
|
43
|
+
*/
|
|
44
|
+
export declare class BinaryFetchClient implements HttpClient {
|
|
45
|
+
private readonly fetch;
|
|
46
|
+
constructor(fetch: Fetch);
|
|
47
|
+
request<D>(url: string, options: HttpClientRequestOptions): Promise<HttpClientResponse<D>>;
|
|
48
|
+
}
|
|
49
|
+
export declare function binaryHttpClient(): HttpClient;
|
|
50
|
+
//# sourceMappingURL=BinaryFetchClient.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BinaryFetchClient.d.ts","sourceRoot":"","sources":["../../../../../src/transaction/http/BinaryFetchClient.ts"],"names":[],"mappings":";;AAAA,OAAO,EACL,UAAU,EACV,wBAAwB,EACxB,kBAAkB,EACnB,MAAM,iBAAiB,CAAA;AAExB,sEAAsE;AACtE,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,CACP,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,wBAAwB,EACjC,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,KACzB,6BAA6B,CAAA;CACnC;AAED,uFAAuF;AACvF,MAAM,WAAW,6BAA6B;IAC5C,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAE9B,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,KAAK,IAAI,CAAA;IAE1D,GAAG,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,CAAA;CACjC;AAED;;GAEG;AACH,qBAAa,sBAAuB,YAAW,UAAU;IAC3C,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,iBAAiB;IAE/C,OAAO,CACX,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,wBAAwB,GACvC,OAAO,CAAC,kBAAkB,CAAC;CAiC/B;AAED,mEAAmE;AACnE;;;;GAIG;AACH,MAAM,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;AAE7E;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,CAAA;CACzC;AAED;;GAEG;AACH,qBAAa,iBAAkB,YAAW,UAAU;IACtC,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,KAAK;IAEnC,OAAO,CAAC,CAAC,EACb,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;CAiBlC;AAED,wBAAgB,gBAAgB,IAAI,UAAU,CAuB7C"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export type { HttpClient, HttpClientResponse, HttpClientRequestOptions } from './HttpClient.js';
|
|
2
2
|
export { defaultHttpClient } from './DefaultHttpClient.js';
|
|
3
|
+
export { binaryHttpClient } from './BinaryFetchClient.js';
|
|
3
4
|
export { NodejsHttpClient } from './NodejsHttpClient.js';
|
|
4
5
|
export { FetchHttpClient } from './FetchHttpClient.js';
|
|
5
6
|
export type { Fetch, FetchOptions } from './FetchHttpClient.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/transaction/http/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,UAAU,EACV,kBAAkB,EAClB,wBAAwB,EACzB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAC/D,YAAY,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/transaction/http/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,UAAU,EACV,kBAAkB,EAClB,wBAAwB,EACzB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAC/D,YAAY,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAA"}
|