@aeternity/aepp-sdk 13.3.3 → 14.0.0

package/es/utils/encoder.js

@@ -0,0 +1,104 @@
+import { Buffer as _Buffer } from "buffer";
+import bs58 from 'bs58';
+// js extension is required for mjs build, not importing the whole package to reduce bundle size
+// eslint-disable-next-line import/extensions
+import Sha256 from 'sha.js/sha256.js';
+import { DecodeError, ArgumentError, InvalidChecksumError, PayloadLengthError } from './errors.js';
+import { concatBuffers, isKeyOfObject } from './other.js';
+import * as Encoded from './encoder-types.js';
+import { Encoding } from './encoder-types.js';
+export { Encoded, Encoding };
+
+/**
+ * Calculate SHA256 hash of `input`
+ * @param input - Data to hash
+ * @returns Hash
+ */
+export function sha256hash(input) {
+  return new Sha256().update(input).digest();
+}
+
+/**
+ * @see {@link https://github.com/aeternity/aeserialization/blob/eb68fe331bd476910394966b7f5ede7a74d37e35/src/aeser_api_encoder.erl#L177-L202}
+ */
+const base64Types = [Encoding.ContractBytearray, Encoding.ContractStoreKey, Encoding.ContractStoreValue, Encoding.Transaction, Encoding.OracleQuery, Encoding.OracleResponse, Encoding.State, Encoding.Poi, Encoding.StateTrees, Encoding.CallStateTree, Encoding.Bytearray];
+const base58Types = [Encoding.KeyBlockHash, Encoding.MicroBlockHash, Encoding.BlockPofHash, Encoding.BlockTxHash, Encoding.BlockStateHash, Encoding.Channel, Encoding.ContractAddress, Encoding.TxHash, Encoding.OracleAddress, Encoding.OracleQueryId, Encoding.AccountAddress, Encoding.AccountSecretKey, Encoding.Signature, Encoding.Commitment, Encoding.PeerPubkey, Encoding.Name];
+
+/**
+ * @see {@link https://github.com/aeternity/aeserialization/blob/eb68fe331bd476910394966b7f5ede7a74d37e35/src/aeser_api_encoder.erl#L261-L286}
+ */
+const byteSizeForType = {
+  [Encoding.KeyBlockHash]: 32,
+  [Encoding.MicroBlockHash]: 32,
+  [Encoding.BlockPofHash]: 32,
+  [Encoding.BlockTxHash]: 32,
+  [Encoding.BlockStateHash]: 32,
+  [Encoding.Channel]: 32,
+  [Encoding.ContractAddress]: 32,
+  [Encoding.TxHash]: 32,
+  [Encoding.OracleAddress]: 32,
+  [Encoding.OracleQueryId]: 32,
+  [Encoding.AccountAddress]: 32,
+  [Encoding.AccountSecretKey]: 32,
+  [Encoding.Signature]: 64,
+  [Encoding.Commitment]: 32,
+  [Encoding.PeerPubkey]: 32,
+  [Encoding.State]: 32
+};
+function ensureValidLength(data, type) {
+  if (!isKeyOfObject(type, byteSizeForType)) return;
+  const reqLen = byteSizeForType[type];
+  if (reqLen == null || data.length === reqLen) return;
+  throw new PayloadLengthError(`Payload should be ${reqLen} bytes, got ${data.length} instead`);
+}
+const getChecksum = payload => sha256hash(sha256hash(payload)).slice(0, 4);
+const addChecksum = payload => concatBuffers([payload, getChecksum(payload)]);
+function getPayload(buffer) {
+  const payload = buffer.slice(0, -4);
+  if (!getChecksum(payload).equals(buffer.slice(-4))) throw new InvalidChecksumError();
+  return payload;
+}
+const base64 = {
+  encode: buffer => addChecksum(buffer).toString('base64'),
+  decode: string => getPayload(_Buffer.from(string, 'base64'))
+};
+const base58 = {
+  encode: buffer => bs58.encode(addChecksum(buffer)),
+  decode: string => getPayload(_Buffer.from(bs58.decode(string)))
+};
+const parseType = maybeType => {
+  const base64Type = base64Types.find(t => t === maybeType);
+  if (base64Type != null) return [base64Type, base64];
+  const base58Type = base58Types.find(t => t === maybeType);
+  if (base58Type != null) return [base58Type, base58];
+  throw new ArgumentError('prefix', `one of ${[...base58Types, ...base64Types].join(', ')}`, maybeType);
+};
+
+/**
+ * Decode data using the default encoding/decoding algorithm
+ * @param data - An Base58/64check encoded and prefixed string
+ * (ex tx_..., sg_..., ak_....)
+ * @returns Decoded data
+ */
+export function decode(data) {
+  const [prefix, encodedPayload, extra] = data.split('_');
+  if (encodedPayload == null) throw new DecodeError(`Encoded string missing payload: ${data}`);
+  if (extra != null) throw new DecodeError(`Encoded string have extra parts: ${data}`);
+  const [type, encoder] = parseType(prefix);
+  const payload = encoder.decode(encodedPayload);
+  ensureValidLength(payload, type);
+  return payload;
+}
+
+/**
+ * Encode data using the default encoding/decoding algorithm
+ * @param data - An decoded data
+ * @param type - Prefix of Transaction
+ * @returns Encoded string Base58check or Base64check data
+ */
+export function encode(data, type) {
+  const [, encoder] = parseType(type);
+  ensureValidLength(data, type);
+  return `${type}_${encoder.encode(data)}`;
+}
+//# sourceMappingURL=encoder.js.map

package/es/utils/encoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoder.js","names":["bs58","Sha256","DecodeError","ArgumentError","InvalidChecksumError","PayloadLengthError","concatBuffers","isKeyOfObject","Encoded","Encoding","sha256hash","input","update","digest","base64Types","ContractBytearray","ContractStoreKey","ContractStoreValue","Transaction","OracleQuery","OracleResponse","State","Poi","StateTrees","CallStateTree","Bytearray","base58Types","KeyBlockHash","MicroBlockHash","BlockPofHash","BlockTxHash","BlockStateHash","Channel","ContractAddress","TxHash","OracleAddress","OracleQueryId","AccountAddress","AccountSecretKey","Signature","Commitment","PeerPubkey","Name","byteSizeForType","ensureValidLength","data","type","reqLen","length","getChecksum","payload","slice","addChecksum","getPayload","buffer","equals","base64","encode","toString","decode","string","_Buffer","from","base58","parseType","maybeType","base64Type","find","t","base58Type","join","prefix","encodedPayload","extra","split","encoder"],"sources":["../../src/utils/encoder.ts"],"sourcesContent":["import bs58 from 'bs58';\n// js extension is required for mjs build, not importing the whole package to reduce bundle size\n// eslint-disable-next-line import/extensions\nimport Sha256 from 'sha.js/sha256.js';\nimport { DecodeError, ArgumentError, InvalidChecksumError, PayloadLengthError } from './errors.js';\nimport { concatBuffers, isKeyOfObject } from './other.js';\nimport * as Encoded from './encoder-types.js';\nimport { Encoding } from './encoder-types.js';\n\nexport { Encoded, Encoding };\n\n/**\n * Calculate SHA256 hash of `input`\n * @param input - Data to hash\n * @returns Hash\n */\nexport function sha256hash(input: Uint8Array | string): Buffer {\n  return new Sha256().update(input).digest();\n}\n\n/**\n * @see {@link https://github.com/aeternity/aeserialization/blob/eb68fe331bd476910394966b7f5ede7a74d37e35/src/aeser_api_encoder.erl#L177-L202}\n */\nconst base64Types = [\n  Encoding.ContractBytearray,\n  Encoding.ContractStoreKey,\n  Encoding.ContractStoreValue,\n  Encoding.Transaction,\n  Encoding.OracleQuery,\n  Encoding.OracleResponse,\n  Encoding.State,\n  Encoding.Poi,\n  Encoding.StateTrees,\n  Encoding.CallStateTree,\n  Encoding.Bytearray,\n] as const;\nconst base58Types = [\n  Encoding.KeyBlockHash,\n  Encoding.MicroBlockHash,\n  Encoding.BlockPofHash,\n  Encoding.BlockTxHash,\n  Encoding.BlockStateHash,\n  Encoding.Channel,\n  Encoding.ContractAddress,\n  Encoding.TxHash,\n  Encoding.OracleAddress,\n  Encoding.OracleQueryId,\n  Encoding.AccountAddress,\n  Encoding.AccountSecretKey,\n  Encoding.Signature,\n  Encoding.Commitment,\n  Encoding.PeerPubkey,\n  Encoding.Name,\n] as const;\n\n/**\n * @see {@link https://github.com/aeternity/aeserialization/blob/eb68fe331bd476910394966b7f5ede7a74d37e35/src/aeser_api_encoder.erl#L261-L286}\n */\nconst byteSizeForType = {\n  [Encoding.KeyBlockHash]: 32,\n  [Encoding.MicroBlockHash]: 32,\n  [Encoding.BlockPofHash]: 32,\n  [Encoding.BlockTxHash]: 32,\n  [Encoding.BlockStateHash]: 32,\n  [Encoding.Channel]: 32,\n  [Encoding.ContractAddress]: 32,\n  [Encoding.TxHash]: 32,\n  [Encoding.OracleAddress]: 32,\n  [Encoding.OracleQueryId]: 32,\n  [Encoding.AccountAddress]: 32,\n  [Encoding.AccountSecretKey]: 32,\n  [Encoding.Signature]: 64,\n  [Encoding.Commitment]: 32,\n  [Encoding.PeerPubkey]: 32,\n  [Encoding.State]: 32,\n} as const;\n\nfunction ensureValidLength(data: Uint8Array, type: Encoding): void {\n  if (!isKeyOfObject(type, byteSizeForType)) return;\n  const reqLen = byteSizeForType[type];\n  if (reqLen == null || data.length === reqLen) return;\n  throw new PayloadLengthError(`Payload should be ${reqLen} bytes, got ${data.length} instead`);\n}\n\nconst getChecksum = (payload: Uint8Array): Buffer => sha256hash(sha256hash(payload)).slice(0, 4);\n\nconst addChecksum = (payload: Uint8Array): Buffer => concatBuffers([payload, getChecksum(payload)]);\n\nfunction getPayload(buffer: Buffer): Buffer {\n  const payload = buffer.slice(0, -4);\n  if (!getChecksum(payload).equals(buffer.slice(-4))) throw new InvalidChecksumError();\n  return payload;\n}\n\nconst base64 = {\n  encode: (buffer: Uint8Array) => addChecksum(buffer).toString('base64'),\n  decode: (string: string) => getPayload(Buffer.from(string, 'base64')),\n};\n\nconst base58 = {\n  encode: (buffer: Uint8Array) => bs58.encode(addChecksum(buffer)),\n  decode: (string: string) => getPayload(Buffer.from(bs58.decode(string))),\n};\n\nconst parseType = (maybeType: unknown): [Encoding, typeof base64] => {\n  const base64Type = base64Types.find((t) => t === maybeType);\n  if (base64Type != null) return [base64Type, base64];\n  const base58Type = base58Types.find((t) => t === maybeType);\n  if (base58Type != null) return [base58Type, base58];\n  throw new ArgumentError(\n    'prefix',\n    `one of ${[...base58Types, ...base64Types].join(', ')}`,\n    maybeType,\n  );\n};\n\n/**\n * Decode data using the default encoding/decoding algorithm\n * @param data - An Base58/64check encoded and prefixed string\n * (ex tx_..., sg_..., ak_....)\n * @returns Decoded data\n */\nexport function decode(data: Encoded.Any): Buffer {\n  const [prefix, encodedPayload, extra] = data.split('_');\n  if (encodedPayload == null) throw new DecodeError(`Encoded string missing payload: ${data}`);\n  if (extra != null) throw new DecodeError(`Encoded string have extra parts: ${data}`);\n  const [type, encoder] = parseType(prefix);\n  const payload = encoder.decode(encodedPayload);\n  ensureValidLength(payload, type);\n  return payload;\n}\n\n/**\n * Encode data using the default encoding/decoding algorithm\n * @param data - An decoded data\n * @param type - Prefix of Transaction\n * @returns Encoded string Base58check or Base64check data\n */\nexport function encode<Type extends Encoding>(data: Uint8Array, type: Type): Encoded.Generic<Type> {\n  const [, encoder] = parseType(type);\n  ensureValidLength(data, type);\n  return `${type}_${encoder.encode(data)}`;\n}\n"],"mappings":";AAAA,OAAOA,IAAI,MAAM,MAAM;AACvB;AACA;AACA,OAAOC,MAAM,MAAM,kBAAkB;AACrC,SAASC,WAAW,EAAEC,aAAa,EAAEC,oBAAoB,EAAEC,kBAAkB,QAAQ,aAAa;AAClG,SAASC,aAAa,EAAEC,aAAa,QAAQ,YAAY;AACzD,OAAO,KAAKC,OAAO,MAAM,oBAAoB;AAC7C,SAASC,QAAQ,QAAQ,oBAAoB;AAE7C,SAASD,OAAO,EAAEC,QAAQ;;AAE1B;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,UAAUA,CAACC,KAA0B,EAAU;EAC7D,OAAO,IAAIV,MAAM,CAAC,CAAC,CAACW,MAAM,CAACD,KAAK,CAAC,CAACE,MAAM,CAAC,CAAC;AAC5C;;AAEA;AACA;AACA;AACA,MAAMC,WAAW,GAAG,CAClBL,QAAQ,CAACM,iBAAiB,EAC1BN,QAAQ,CAACO,gBAAgB,EACzBP,QAAQ,CAACQ,kBAAkB,EAC3BR,QAAQ,CAACS,WAAW,EACpBT,QAAQ,CAACU,WAAW,EACpBV,QAAQ,CAACW,cAAc,EACvBX,QAAQ,CAACY,KAAK,EACdZ,QAAQ,CAACa,GAAG,EACZb,QAAQ,CAACc,UAAU,EACnBd,QAAQ,CAACe,aAAa,EACtBf,QAAQ,CAACgB,SAAS,CACV;AACV,MAAMC,WAAW,GAAG,CAClBjB,QAAQ,CAACkB,YAAY,EACrBlB,QAAQ,CAACmB,cAAc,EACvBnB,QAAQ,CAACoB,YAAY,EACrBpB,QAAQ,CAACqB,WAAW,EACpBrB,QAAQ,CAACsB,cAAc,EACvBtB,QAAQ,CAACuB,OAAO,EAChBvB,QAAQ,CAACwB,eAAe,EACxBxB,QAAQ,CAACyB,MAAM,EACfzB,QAAQ,CAAC0B,aAAa,EACtB1B,QAAQ,CAAC2B,aAAa,EACtB3B,QAAQ,CAAC4B,cAAc,EACvB5B,QAAQ,CAAC6B,gBAAgB,EACzB7B,QAAQ,CAAC8B,SAAS,EAClB9B,QAAQ,CAAC+B,UAAU,EACnB/B,QAAQ,CAACgC,UAAU,EACnBhC,QAAQ,CAACiC,IAAI,CACL;;AAEV;AACA;AACA;AACA,MAAMC,eAAe,GAAG;EACtB,CAAClC,QAAQ,CAACkB,YAAY,GAAG,EAAE;EAC3B,CAAClB,QAAQ,CAACmB,cAAc,GAAG,EAAE;EAC7B,CAACnB,QAAQ,CAACoB,YAAY,GAAG,EAAE;EAC3B,CAACpB,QAAQ,CAACqB,WAAW,GAAG,EAAE;EAC1B,CAACrB,QAAQ,CAACsB,cAAc,GAAG,EAAE;EAC7B,CAACtB,QAAQ,CAACuB,OAAO,GAAG,EAAE;EACtB,CAACvB,QAAQ,CAACwB,eAAe,GAAG,EAAE;EAC9B,CAACxB,QAAQ,CAACyB,MAAM,GAAG,EAAE;EACrB,CAACzB,QAAQ,CAAC0B,aAAa,GAAG,EAAE;EAC5B,CAAC1B,QAAQ,CAAC2B,aAAa,GAAG,EAAE;EAC5B,CAAC3B,QAAQ,CAAC4B,cAAc,GAAG,EAAE;EAC7B,CAAC5B,QAAQ,CAAC6B,gBAAgB,GAAG,EAAE;EAC/B,CAAC7B,QAAQ,CAAC8B,SAAS,GAAG,EAAE;EACxB,CAAC9B,QAAQ,CAAC+B,UAAU,GAAG,EAAE;EACzB,CAAC/B,QAAQ,CAACgC,UAAU,GAAG,EAAE;EACzB,CAAChC,QAAQ,CAACY,KAAK,GAAG;AACpB,CAAU;AAEV,SAASuB,iBAAiBA,CAACC,IAAgB,EAAEC,IAAc,EAAQ;EACjE,IAAI,CAACvC,aAAa,CAACuC,IAAI,EAAEH,eAAe,CAAC,EAAE;EAC3C,MAAMI,MAAM,GAAGJ,eAAe,CAACG,IAAI,CAAC;EACpC,IAAIC,MAAM,IAAI,IAAI,IAAIF,IAAI,CAACG,MAAM,KAAKD,MAAM,EAAE;EAC9C,MAAM,IAAI1C,kBAAkB,CAAC,qBAAqB0C,MAAM,eAAeF,IAAI,CAACG,MAAM,UAAU,CAAC;AAC/F;AAEA,MAAMC,WAAW,GAAIC,OAAmB,IAAaxC,UAAU,CAACA,UAAU,CAACwC,OAAO,CAAC,CAAC,CAACC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;AAEhG,MAAMC,WAAW,GAAIF,OAAmB,IAAa5C,aAAa,CAAC,CAAC4C,OAAO,EAAED,WAAW,CAACC,OAAO,CAAC,CAAC,CAAC;AAEnG,SAASG,UAAUA,CAACC,MAAc,EAAU;EAC1C,MAAMJ,OAAO,GAAGI,MAAM,CAACH,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;EACnC,IAAI,CAACF,WAAW,CAACC,OAAO,CAAC,CAACK,MAAM,CAACD,MAAM,CAACH,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI/C,oBAAoB,CAAC,CAAC;EACpF,OAAO8C,OAAO;AAChB;AAEA,MAAMM,MAAM,GAAG;EACbC,MAAM,EAAGH,MAAkB,IAAKF,WAAW,CAACE,MAAM,CAAC,CAACI,QAAQ,CAAC,QAAQ,CAAC;EACtEC,MAAM,EAAGC,MAAc,IAAKP,UAAU,CAACQ,OAAA,CAAOC,IAAI,CAACF,MAAM,EAAE,QAAQ,CAAC;AACtE,CAAC;AAED,MAAMG,MAAM,GAAG;EACbN,MAAM,EAAGH,MAAkB,IAAKtD,IAAI,CAACyD,MAAM,CAACL,WAAW,CAACE,MAAM,CAAC,CAAC;EAChEK,MAAM,EAAGC,MAAc,IAAKP,UAAU,CAACQ,OAAA,CAAOC,IAAI,CAAC9D,IAAI,CAAC2D,MAAM,CAACC,MAAM,CAAC,CAAC;AACzE,CAAC;AAED,MAAMI,SAAS,GAAIC,SAAkB,IAAgC;EACnE,MAAMC,UAAU,GAAGpD,WAAW,CAACqD,IAAI,CAAEC,CAAC,IAAKA,CAAC,KAAKH,SAAS,CAAC;EAC3D,IAAIC,UAAU,IAAI,IAAI,EAAE,OAAO,CAACA,UAAU,EAAEV,MAAM,CAAC;EACnD,MAAMa,UAAU,GAAG3C,WAAW,CAACyC,IAAI,CAAEC,CAAC,IAAKA,CAAC,KAAKH,SAAS,CAAC;EAC3D,IAAII,UAAU,IAAI,IAAI,EAAE,OAAO,CAACA,UAAU,EAAEN,MAAM,CAAC;EACnD,MAAM,IAAI5D,aAAa,CACrB,QAAQ,EACR,UAAU,CAAC,GAAGuB,WAAW,EAAE,GAAGZ,WAAW,CAAC,CAACwD,IAAI,CAAC,IAAI,CAAC,EAAE,EACvDL,SACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASN,MAAMA,CAACd,IAAiB,EAAU;EAChD,MAAM,CAAC0B,MAAM,EAAEC,cAAc,EAAEC,KAAK,CAAC,GAAG5B,IAAI,CAAC6B,KAAK,CAAC,GAAG,CAAC;EACvD,IAAIF,cAAc,IAAI,IAAI,EAAE,MAAM,IAAItE,WAAW,CAAC,mCAAmC2C,IAAI,EAAE,CAAC;EAC5F,IAAI4B,KAAK,IAAI,IAAI,EAAE,MAAM,IAAIvE,WAAW,CAAC,oCAAoC2C,IAAI,EAAE,CAAC;EACpF,MAAM,CAACC,IAAI,EAAE6B,OAAO,CAAC,GAAGX,SAAS,CAACO,MAAM,CAAC;EACzC,MAAMrB,OAAO,GAAGyB,OAAO,CAAChB,MAAM,CAACa,cAAc,CAAC;EAC9C5B,iBAAiB,CAACM,OAAO,EAAEJ,IAAI,CAAC;EAChC,OAAOI,OAAO;AAChB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASO,MAAMA,CAAwBZ,IAAgB,EAAEC,IAAU,EAAyB;EACjG,MAAM,GAAG6B,OAAO,CAAC,GAAGX,SAAS,CAAClB,IAAI,CAAC;EACnCF,iBAAiB,CAACC,IAAI,EAAEC,IAAI,CAAC;EAC7B,OAAO,GAAGA,IAAI,IAAI6B,OAAO,CAAClB,MAAM,CAACZ,IAAI,CAAC,EAAE;AAC1C","ignoreList":[]}

package/es/utils/errors.d.ts

@@ -1,6 +1,6 @@
-import BigNumber from 'bignumber.js';
-import { AensName, Int } from '../tx/builder/constants';
-import * as Encoded from './encoder-types';
+import { BigNumber } from 'bignumber.js';
+import { AensName, Int } from '../tx/builder/constants.js';
+import * as Encoded from './encoder-types.js';
 /**
  * aepp-sdk originated error
  * @category exception
@@ -144,7 +144,7 @@ export declare class NotImplementedError extends BaseError {
  * @category exception
  */
 export declare class UnsupportedVersionError extends BaseError {
-    constructor(dependency: string, version: string, geVersion: string, ltVersion: string);
+    constructor(dependency: string, version: string, geVersion: string, ltVersion?: string);
 }
 /**
  * @category exception
@@ -345,12 +345,6 @@ export declare class AmbiguousEventDefinitionError extends ContractError {
 export declare class InvalidChecksumError extends CryptographyError {
     constructor();
 }
-/**
- * @category exception
- */
-export declare class InvalidPasswordError extends CryptographyError {
-    constructor();
-}
 /**
  * @category exception
  */