@algorandfoundation/algokit-utils 8.2.0-beta.2 → 8.2.0-beta.3

package/types/app-spec.mjs

@@ -1,6 +1,15 @@
 import algosdk from 'algosdk';
 
 var ABIMethod = algosdk.ABIMethod;
+/**
+ * Converts an ARC-32 Application Specification to an ARC-56 Contract
+ * @param appSpec The ARC-32 Application Specification
+ * @returns The ARC-56 Contract
+ * @example
+ * ```typescript
+ * const arc56AppSpec = arc32ToArc56(arc32AppSpec)
+ * ```
+ */
 function arc32ToArc56(appSpec) {
     const arc32Structs = Object.values(appSpec.hints).flatMap((hint) => Object.entries(hint.structs ?? {}));
     const structs = Object.fromEntries(arc32Structs.map(([_, struct]) => {

package/types/app-spec.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"app-spec.mjs","sources":["../../src/types/app-spec.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { Arc56Contract, Method as Arc56Method, StorageKey, StructField } from './app-arc56'\nimport ABIContractParams = algosdk.ABIContractParams\nimport ABIMethodParams = algosdk.ABIMethodParams\nimport ABIMethod = algosdk.ABIMethod\n\nexport function arc32ToArc56(appSpec: AppSpec): Arc56Contract {\n  const arc32Structs = Object.values(appSpec.hints).flatMap((hint) => Object.entries(hint.structs ?? {}))\n  const structs = Object.fromEntries(\n    arc32Structs.map(([_, struct]) => {\n      const fields = struct.elements.map((e) => ({ name: e[0], type: e[1] }))\n      return [struct.name, fields]\n    }),\n  ) satisfies { [structName: string]: StructField[] }\n  const hint = (m: ABIMethodParams) => appSpec.hints[new ABIMethod(m).getSignature()] as Hint | undefined\n  const actions = (m: ABIMethodParams, type: 'CREATE' | 'CALL') => {\n    // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain\n    return hint(m)?.call_config !== undefined ? callConfigToActions(hint(m)?.call_config!, type) : []\n  }\n  const bareActions = (type: 'CREATE' | 'CALL') => {\n    return callConfigToActions(appSpec.bare_call_config, type)\n  }\n  const callConfigToActions = (c: CallConfig, type: 'CREATE' | 'CALL') => {\n    const actions: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[] = []\n    if (c.close_out && ['ALL', type].includes(c.close_out)) actions.push('CloseOut')\n    if (c.delete_application && ['ALL', type].includes(c.delete_application)) actions.push('DeleteApplication')\n    if (c.no_op && ['ALL', type].includes(c.no_op)) actions.push('NoOp')\n    if (c.opt_in && ['ALL', type].includes(c.opt_in)) actions.push('OptIn')\n    if (c.update_application && ['ALL', type].includes(c.update_application)) actions.push('UpdateApplication')\n    return actions\n  }\n  const getDefaultArgValue = (\n    type: string,\n    defaultArg: DefaultArgument | undefined,\n  ): Arc56Contract['methods'][0]['args'][0]['defaultValue'] => {\n    if (!defaultArg) return undefined\n\n    if (defaultArg.source === 'abi-method') {\n      return {\n        source: 'method',\n        data: defaultArg.data.name,\n      }\n    }\n\n    return {\n      source: defaultArg.source === 'constant' ? 'literal' : defaultArg.source === 'global-state' ? 'global' : 'local',\n      data: Buffer.from(\n        typeof defaultArg.data === 'number' ? algosdk.ABIType.from('uint64').encode(defaultArg.data) : defaultArg.data,\n      ).toString('base64'),\n      type: type === 'string' ? 'AVMString' : type,\n    }\n  }\n\n  return {\n    arcs: [],\n    name: appSpec.contract.name,\n    desc: appSpec.contract.desc,\n    structs: structs,\n    methods: appSpec.contract.methods.map(\n      (m) =>\n        ({\n          name: m.name,\n          desc: m.desc,\n          args: m.args.map((a) => ({\n            name: a.name,\n            type: a.type,\n            desc: a.desc,\n            struct: a.name ? hint(m)?.structs?.[a.name]?.name : undefined,\n            defaultValue: getDefaultArgValue(a.type, !a.name ? undefined : hint(m)?.default_arguments?.[a.name]),\n          })),\n          returns: {\n            type: m.returns.type,\n            desc: m.returns.desc,\n            struct: hint(m)?.structs?.output?.name,\n          },\n          events: [],\n          readonly: hint(m)?.read_only,\n          actions: {\n            create: actions(m, 'CREATE') as Arc56Method['actions']['create'],\n            call: actions(m, 'CALL'),\n          },\n        }) satisfies Arc56Method,\n    ),\n    state: {\n      schema: {\n        global: {\n          ints: appSpec.state.global.num_uints,\n          bytes: appSpec.state.global.num_byte_slices,\n        },\n        local: {\n          ints: appSpec.state.local.num_uints,\n          bytes: appSpec.state.local.num_byte_slices,\n        },\n      },\n      keys: {\n        global: Object.fromEntries(\n          Object.entries(appSpec.schema.global.declared).map((s) => [\n            s[0],\n            {\n              key: Buffer.from(s[1].key, 'utf-8').toString('base64'),\n              keyType: 'AVMString',\n              valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',\n              desc: s[1].descr,\n            } satisfies StorageKey,\n          ]),\n        ),\n        local: Object.fromEntries(\n          Object.entries(appSpec.schema.local.declared).map((s) => [\n            s[0],\n            {\n              key: Buffer.from(s[1].key, 'utf-8').toString('base64'),\n              keyType: 'AVMString',\n              valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',\n              desc: s[1].descr,\n            } satisfies StorageKey,\n          ]),\n        ),\n        box: {},\n      },\n      maps: {\n        global: {},\n        local: {},\n        box: {},\n      },\n    },\n    source: appSpec.source,\n    bareActions: {\n      create: bareActions('CREATE') as unknown as Arc56Contract['bareActions']['create'],\n      call: bareActions('CALL'),\n    },\n    byteCode: undefined,\n    compilerInfo: undefined,\n    events: undefined,\n    networks: undefined,\n    scratchVariables: undefined,\n    sourceInfo: undefined,\n    templateVariables: undefined,\n  } satisfies Arc56Contract\n}\n\n/** An ARC-0032 Application Specification see https://github.com/algorandfoundation/ARCs/pull/150 */\nexport interface AppSpec {\n  /** Method call hints */\n  hints: HintSpec\n  /** The TEAL source */\n  source: AppSources\n  /** The ABI-0004 contract definition see https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0004.md */\n  contract: ABIContractParams\n  /** The values that make up the local and global state */\n  schema: SchemaSpec\n  /** The rolled-up schema allocation values for local and global state */\n  state: StateSchemaSpec\n  /** The config of all BARE calls (i.e. non ABI calls with no args) */\n  bare_call_config: CallConfig\n}\n\n/** A lookup of encoded method call spec to hint */\nexport type HintSpec = Record<string, Hint>\n\n/** The TEAL source of a contract */\nexport interface AppSources {\n  /** The TEAL source of the approval program */\n  approval: string\n  /** The TEAL source of the clear program */\n  clear: string\n}\n\n/** The various call configs:\n *  * `NEVER`: Will not be called\n *  * `CALL`: Can be called during a non-create call i.e. app id != 0\n *  * `CREATE`: Can be called during a create call i.e. app id = 0\n *  * `ALL`: Can be during a create OR non-create call\n **/\nexport type CallConfigValue = 'NEVER' | 'CALL' | 'CREATE' | 'ALL'\n\n/** Call configuration for a method */\nexport interface CallConfig {\n  /** NoOp call config */\n  no_op?: CallConfigValue\n  /** Opt-in call config */\n  opt_in?: CallConfigValue\n  /** Close out call config */\n  close_out?: CallConfigValue\n  /** Update call config */\n  update_application?: CallConfigValue\n  /** Delete call config */\n  delete_application?: CallConfigValue\n}\n\n/** Hint information for a given method call to allow client generation */\nexport interface Hint {\n  /** Any user-defined struct/tuple types used in the method call, keyed by parameter name or `output` for return type */\n  structs?: Record<string, Struct>\n  read_only?: boolean\n  default_arguments?: Record<string, DefaultArgument>\n  call_config: CallConfig\n}\n\n/** The name of a field */\nexport type FieldName = string\n\n/** The string name of an ABI type */\nexport type ABIType = string\n\n/** The elements of the struct/tuple: `FieldName`, `ABIType` */\nexport type StructElement = [FieldName, ABIType]\n\n/** A user-defined struct/tuple type */\nexport interface Struct {\n  /** The name of the type */\n  name: string\n  /** The elements (in order) that make up the struct/tuple */\n  elements: StructElement[]\n}\n\n/**\n * Defines a strategy for obtaining a default value for a given ABI arg.\n */\nexport type DefaultArgument =\n  | {\n      /**\n       * The default value should be fetched by invoking an ABI method\n       */\n      source: 'abi-method'\n      data: ABIMethodParams\n    }\n  | {\n      /**\n       * The default value should be fetched from global state\n       */\n      source: 'global-state'\n      /**\n       * The key of the state variable\n       */\n      data: string\n    }\n  | {\n      /**\n       * The default value should be fetched from the local state of the sender user\n       */\n      source: 'local-state'\n      /**\n       * The key of the state variable\n       */\n      data: string\n    }\n  | {\n      /**\n       * The default value is a constant.\n       */\n      source: 'constant'\n      /**\n       * The static default value to use.\n       */\n      data: string | number\n    }\n\n/** AVM data type */\nexport type AVMType = 'uint64' | 'bytes'\n\n/** Declared schema value specification */\nexport interface DeclaredSchemaValueSpec {\n  /** The type of value */\n  type: AVMType\n  /** The name of the key */\n  key: string\n  /** A description of the variable */\n  descr?: string\n  /** Whether or not the value is set statically (at create time only) or dynamically */\n  static?: boolean\n}\n\n/** Reserved schema value specification */\nexport interface ReservedSchemaValueSpec {\n  /** The type of value */\n  type: AVMType\n  /** The description of the reserved storage space */\n  descr: string\n  /** The maximum number of slots to reserve */\n  max_keys: number\n}\n\n/** The schema for global and local storage */\nexport interface SchemaSpec {\n  /** The local storage schema */\n  local: Schema\n  /** The global storage schema */\n  global: Schema\n}\n\n/** The storage schema definition */\nexport interface Schema {\n  /** Declared storage schema */\n  declared: Record<string, DeclaredSchemaValueSpec>\n  /** Reserved storage schema */\n  reserved: Record<string, ReservedSchemaValueSpec>\n}\n\n/** The rolled-up schema allocation specification for local and global state */\nexport interface StateSchemaSpec {\n  /** Global storage spec */\n  global: StateSchema\n  /** Local storage spec */\n  local: StateSchema\n}\n\n/** Schema spec summary for global or local storage */\nexport type StateSchema = {\n  /** Number of uint slots */\n  num_uints: number\n  /** Number of byte slots */\n  num_byte_slices: number\n}\n"],"names":[],"mappings":";;AAIA,IAAO,SAAS,GAAG,OAAO,CAAC,SAAS;AAE9B,SAAU,YAAY,CAAC,OAAgB,EAAA;AAC3C,IAAA,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;AACvG,IAAA,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAI;AAC/B,QAAA,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AACvE,QAAA,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC;KAC7B,CAAC,CAC+C;IACnD,MAAM,IAAI,GAAG,CAAC,CAAkB,KAAK,OAAO,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAqB;AACvG,IAAA,MAAM,OAAO,GAAG,CAAC,CAAkB,EAAE,IAAuB,KAAI;;QAE9D,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,KAAK,SAAS,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAY,EAAE,IAAI,CAAC,GAAG,EAAE;AACnG,KAAC;AACD,IAAA,MAAM,WAAW,GAAG,CAAC,IAAuB,KAAI;QAC9C,OAAO,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,CAAC;AAC5D,KAAC;AACD,IAAA,MAAM,mBAAmB,GAAG,CAAC,CAAa,EAAE,IAAuB,KAAI;QACrE,MAAM,OAAO,GAAiG,EAAE;AAChH,QAAA,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;AAChF,QAAA,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC;AAC3G,QAAA,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;AACpE,QAAA,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;AACvE,QAAA,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC;AAC3G,QAAA,OAAO,OAAO;AAChB,KAAC;AACD,IAAA,MAAM,kBAAkB,GAAG,CACzB,IAAY,EACZ,UAAuC,KACmB;AAC1D,QAAA,IAAI,CAAC,UAAU;AAAE,YAAA,OAAO,SAAS;AAEjC,QAAA,IAAI,UAAU,CAAC,MAAM,KAAK,YAAY,EAAE;YACtC,OAAO;AACL,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI;aAC3B;;QAGH,OAAO;YACL,MAAM,EAAE,UAAU,CAAC,MAAM,KAAK,UAAU,GAAG,SAAS,GAAG,UAAU,CAAC,MAAM,KAAK,cAAc,GAAG,QAAQ,GAAG,OAAO;AAChH,YAAA,IAAI,EAAE,MAAM,CAAC,IAAI,CACf,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,CAC/G,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACpB,IAAI,EAAE,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,IAAI;SAC7C;AACH,KAAC;IAED,OAAO;AACL,QAAA,IAAI,EAAE,EAAE;AACR,QAAA,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;AAC3B,QAAA,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;AAC3B,QAAA,OAAO,EAAE,OAAO;AAChB,QAAA,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CACnC,CAAC,CAAC,MACC;YACC,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,IAAI,EAAE,CAAC,CAAC,IAAI;AACZ,YAAA,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;gBACvB,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,MAAM,EAAE,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS;AAC7D,gBAAA,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;AACrG,aAAA,CAAC,CAAC;AACH,YAAA,OAAO,EAAE;AACP,gBAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI;AACpB,gBAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI;gBACpB,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI;AACvC,aAAA;AACD,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS;AAC5B,YAAA,OAAO,EAAE;AACP,gBAAA,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAqC;AAChE,gBAAA,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC;AACzB,aAAA;AACF,SAAA,CAAuB,CAC3B;AACD,QAAA,KAAK,EAAE;AACL,YAAA,MAAM,EAAE;AACN,gBAAA,MAAM,EAAE;AACN,oBAAA,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS;AACpC,oBAAA,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe;AAC5C,iBAAA;AACD,gBAAA,KAAK,EAAE;AACL,oBAAA,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS;AACnC,oBAAA,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe;AAC3C,iBAAA;AACF,aAAA;AACD,YAAA,IAAI,EAAE;gBACJ,MAAM,EAAE,MAAM,CAAC,WAAW,CACxB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK;oBACxD,CAAC,CAAC,CAAC,CAAC;AACJ,oBAAA;AACE,wBAAA,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;AACtD,wBAAA,OAAO,EAAE,WAAW;AACpB,wBAAA,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,UAAU;AAC5D,wBAAA,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;AACI,qBAAA;AACvB,iBAAA,CAAC,CACH;gBACD,KAAK,EAAE,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK;oBACvD,CAAC,CAAC,CAAC,CAAC;AACJ,oBAAA;AACE,wBAAA,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;AACtD,wBAAA,OAAO,EAAE,WAAW;AACpB,wBAAA,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,UAAU;AAC5D,wBAAA,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;AACI,qBAAA;AACvB,iBAAA,CAAC,CACH;AACD,gBAAA,GAAG,EAAE,EAAE;AACR,aAAA;AACD,YAAA,IAAI,EAAE;AACJ,gBAAA,MAAM,EAAE,EAAE;AACV,gBAAA,KAAK,EAAE,EAAE;AACT,gBAAA,GAAG,EAAE,EAAE;AACR,aAAA;AACF,SAAA;QACD,MAAM,EAAE,OAAO,CAAC,MAAM;AACtB,QAAA,WAAW,EAAE;AACX,YAAA,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAsD;AAClF,YAAA,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;AAC1B,SAAA;AACD,QAAA,QAAQ,EAAE,SAAS;AACnB,QAAA,YAAY,EAAE,SAAS;AACvB,QAAA,MAAM,EAAE,SAAS;AACjB,QAAA,QAAQ,EAAE,SAAS;AACnB,QAAA,gBAAgB,EAAE,SAAS;AAC3B,QAAA,UAAU,EAAE,SAAS;AACrB,QAAA,iBAAiB,EAAE,SAAS;KACL;AAC3B;;;;"}
+{"version":3,"file":"app-spec.mjs","sources":["../../src/types/app-spec.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { Arc56Contract, Method as Arc56Method, StorageKey, StructField } from './app-arc56'\nimport ABIContractParams = algosdk.ABIContractParams\nimport ABIMethodParams = algosdk.ABIMethodParams\nimport ABIMethod = algosdk.ABIMethod\n\n/**\n * Converts an ARC-32 Application Specification to an ARC-56 Contract\n * @param appSpec The ARC-32 Application Specification\n * @returns The ARC-56 Contract\n * @example\n * ```typescript\n * const arc56AppSpec = arc32ToArc56(arc32AppSpec)\n * ```\n */\nexport function arc32ToArc56(appSpec: AppSpec): Arc56Contract {\n  const arc32Structs = Object.values(appSpec.hints).flatMap((hint) => Object.entries(hint.structs ?? {}))\n  const structs = Object.fromEntries(\n    arc32Structs.map(([_, struct]) => {\n      const fields = struct.elements.map((e) => ({ name: e[0], type: e[1] }))\n      return [struct.name, fields]\n    }),\n  ) satisfies { [structName: string]: StructField[] }\n  const hint = (m: ABIMethodParams) => appSpec.hints[new ABIMethod(m).getSignature()] as Hint | undefined\n  const actions = (m: ABIMethodParams, type: 'CREATE' | 'CALL') => {\n    // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain\n    return hint(m)?.call_config !== undefined ? callConfigToActions(hint(m)?.call_config!, type) : []\n  }\n  const bareActions = (type: 'CREATE' | 'CALL') => {\n    return callConfigToActions(appSpec.bare_call_config, type)\n  }\n  const callConfigToActions = (c: CallConfig, type: 'CREATE' | 'CALL') => {\n    const actions: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[] = []\n    if (c.close_out && ['ALL', type].includes(c.close_out)) actions.push('CloseOut')\n    if (c.delete_application && ['ALL', type].includes(c.delete_application)) actions.push('DeleteApplication')\n    if (c.no_op && ['ALL', type].includes(c.no_op)) actions.push('NoOp')\n    if (c.opt_in && ['ALL', type].includes(c.opt_in)) actions.push('OptIn')\n    if (c.update_application && ['ALL', type].includes(c.update_application)) actions.push('UpdateApplication')\n    return actions\n  }\n  const getDefaultArgValue = (\n    type: string,\n    defaultArg: DefaultArgument | undefined,\n  ): Arc56Contract['methods'][0]['args'][0]['defaultValue'] => {\n    if (!defaultArg) return undefined\n\n    if (defaultArg.source === 'abi-method') {\n      return {\n        source: 'method',\n        data: defaultArg.data.name,\n      }\n    }\n\n    return {\n      source: defaultArg.source === 'constant' ? 'literal' : defaultArg.source === 'global-state' ? 'global' : 'local',\n      data: Buffer.from(\n        typeof defaultArg.data === 'number' ? algosdk.ABIType.from('uint64').encode(defaultArg.data) : defaultArg.data,\n      ).toString('base64'),\n      type: type === 'string' ? 'AVMString' : type,\n    }\n  }\n\n  return {\n    arcs: [],\n    name: appSpec.contract.name,\n    desc: appSpec.contract.desc,\n    structs: structs,\n    methods: appSpec.contract.methods.map(\n      (m) =>\n        ({\n          name: m.name,\n          desc: m.desc,\n          args: m.args.map((a) => ({\n            name: a.name,\n            type: a.type,\n            desc: a.desc,\n            struct: a.name ? hint(m)?.structs?.[a.name]?.name : undefined,\n            defaultValue: getDefaultArgValue(a.type, !a.name ? undefined : hint(m)?.default_arguments?.[a.name]),\n          })),\n          returns: {\n            type: m.returns.type,\n            desc: m.returns.desc,\n            struct: hint(m)?.structs?.output?.name,\n          },\n          events: [],\n          readonly: hint(m)?.read_only,\n          actions: {\n            create: actions(m, 'CREATE') as Arc56Method['actions']['create'],\n            call: actions(m, 'CALL'),\n          },\n        }) satisfies Arc56Method,\n    ),\n    state: {\n      schema: {\n        global: {\n          ints: appSpec.state.global.num_uints,\n          bytes: appSpec.state.global.num_byte_slices,\n        },\n        local: {\n          ints: appSpec.state.local.num_uints,\n          bytes: appSpec.state.local.num_byte_slices,\n        },\n      },\n      keys: {\n        global: Object.fromEntries(\n          Object.entries(appSpec.schema.global.declared).map((s) => [\n            s[0],\n            {\n              key: Buffer.from(s[1].key, 'utf-8').toString('base64'),\n              keyType: 'AVMString',\n              valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',\n              desc: s[1].descr,\n            } satisfies StorageKey,\n          ]),\n        ),\n        local: Object.fromEntries(\n          Object.entries(appSpec.schema.local.declared).map((s) => [\n            s[0],\n            {\n              key: Buffer.from(s[1].key, 'utf-8').toString('base64'),\n              keyType: 'AVMString',\n              valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',\n              desc: s[1].descr,\n            } satisfies StorageKey,\n          ]),\n        ),\n        box: {},\n      },\n      maps: {\n        global: {},\n        local: {},\n        box: {},\n      },\n    },\n    source: appSpec.source,\n    bareActions: {\n      create: bareActions('CREATE') as unknown as Arc56Contract['bareActions']['create'],\n      call: bareActions('CALL'),\n    },\n    byteCode: undefined,\n    compilerInfo: undefined,\n    events: undefined,\n    networks: undefined,\n    scratchVariables: undefined,\n    sourceInfo: undefined,\n    templateVariables: undefined,\n  } satisfies Arc56Contract\n}\n\n/** An ARC-0032 Application Specification see https://github.com/algorandfoundation/ARCs/pull/150 */\nexport interface AppSpec {\n  /** Method call hints */\n  hints: HintSpec\n  /** The TEAL source */\n  source: AppSources\n  /** The ABI-0004 contract definition see https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0004.md */\n  contract: ABIContractParams\n  /** The values that make up the local and global state */\n  schema: SchemaSpec\n  /** The rolled-up schema allocation values for local and global state */\n  state: StateSchemaSpec\n  /** The config of all BARE calls (i.e. non ABI calls with no args) */\n  bare_call_config: CallConfig\n}\n\n/** A lookup of encoded method call spec to hint */\nexport type HintSpec = Record<string, Hint>\n\n/** The TEAL source of a contract */\nexport interface AppSources {\n  /** The TEAL source of the approval program */\n  approval: string\n  /** The TEAL source of the clear program */\n  clear: string\n}\n\n/** The various call configs:\n *  * `NEVER`: Will not be called\n *  * `CALL`: Can be called during a non-create call i.e. app id != 0\n *  * `CREATE`: Can be called during a create call i.e. app id = 0\n *  * `ALL`: Can be during a create OR non-create call\n **/\nexport type CallConfigValue = 'NEVER' | 'CALL' | 'CREATE' | 'ALL'\n\n/** Call configuration for a method */\nexport interface CallConfig {\n  /** NoOp call config */\n  no_op?: CallConfigValue\n  /** Opt-in call config */\n  opt_in?: CallConfigValue\n  /** Close out call config */\n  close_out?: CallConfigValue\n  /** Update call config */\n  update_application?: CallConfigValue\n  /** Delete call config */\n  delete_application?: CallConfigValue\n}\n\n/** Hint information for a given method call to allow client generation */\nexport interface Hint {\n  /** Any user-defined struct/tuple types used in the method call, keyed by parameter name or `output` for return type */\n  structs?: Record<string, Struct>\n  read_only?: boolean\n  default_arguments?: Record<string, DefaultArgument>\n  call_config: CallConfig\n}\n\n/** The name of a field */\nexport type FieldName = string\n\n/** The string name of an ABI type */\nexport type ABIType = string\n\n/** The elements of the struct/tuple: `FieldName`, `ABIType` */\nexport type StructElement = [FieldName, ABIType]\n\n/** A user-defined struct/tuple type */\nexport interface Struct {\n  /** The name of the type */\n  name: string\n  /** The elements (in order) that make up the struct/tuple */\n  elements: StructElement[]\n}\n\n/**\n * Defines a strategy for obtaining a default value for a given ABI arg.\n */\nexport type DefaultArgument =\n  | {\n      /**\n       * The default value should be fetched by invoking an ABI method\n       */\n      source: 'abi-method'\n      data: ABIMethodParams\n    }\n  | {\n      /**\n       * The default value should be fetched from global state\n       */\n      source: 'global-state'\n      /**\n       * The key of the state variable\n       */\n      data: string\n    }\n  | {\n      /**\n       * The default value should be fetched from the local state of the sender user\n       */\n      source: 'local-state'\n      /**\n       * The key of the state variable\n       */\n      data: string\n    }\n  | {\n      /**\n       * The default value is a constant.\n       */\n      source: 'constant'\n      /**\n       * The static default value to use.\n       */\n      data: string | number\n    }\n\n/** AVM data type */\nexport type AVMType = 'uint64' | 'bytes'\n\n/** Declared schema value specification */\nexport interface DeclaredSchemaValueSpec {\n  /** The type of value */\n  type: AVMType\n  /** The name of the key */\n  key: string\n  /** A description of the variable */\n  descr?: string\n  /** Whether or not the value is set statically (at create time only) or dynamically */\n  static?: boolean\n}\n\n/** Reserved schema value specification */\nexport interface ReservedSchemaValueSpec {\n  /** The type of value */\n  type: AVMType\n  /** The description of the reserved storage space */\n  descr: string\n  /** The maximum number of slots to reserve */\n  max_keys: number\n}\n\n/** The schema for global and local storage */\nexport interface SchemaSpec {\n  /** The local storage schema */\n  local: Schema\n  /** The global storage schema */\n  global: Schema\n}\n\n/** The storage schema definition */\nexport interface Schema {\n  /** Declared storage schema */\n  declared: Record<string, DeclaredSchemaValueSpec>\n  /** Reserved storage schema */\n  reserved: Record<string, ReservedSchemaValueSpec>\n}\n\n/** The rolled-up schema allocation specification for local and global state */\nexport interface StateSchemaSpec {\n  /** Global storage spec */\n  global: StateSchema\n  /** Local storage spec */\n  local: StateSchema\n}\n\n/** Schema spec summary for global or local storage */\nexport type StateSchema = {\n  /** Number of uint slots */\n  num_uints: number\n  /** Number of byte slots */\n  num_byte_slices: number\n}\n"],"names":[],"mappings":";;AAIA,IAAO,SAAS,GAAG,OAAO,CAAC,SAAS;AAEpC;;;;;;;;AAQG;AACG,SAAU,YAAY,CAAC,OAAgB,EAAA;AAC3C,IAAA,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;AACvG,IAAA,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAI;AAC/B,QAAA,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AACvE,QAAA,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC;KAC7B,CAAC,CAC+C;IACnD,MAAM,IAAI,GAAG,CAAC,CAAkB,KAAK,OAAO,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAqB;AACvG,IAAA,MAAM,OAAO,GAAG,CAAC,CAAkB,EAAE,IAAuB,KAAI;;QAE9D,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,KAAK,SAAS,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAY,EAAE,IAAI,CAAC,GAAG,EAAE;AACnG,KAAC;AACD,IAAA,MAAM,WAAW,GAAG,CAAC,IAAuB,KAAI;QAC9C,OAAO,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,CAAC;AAC5D,KAAC;AACD,IAAA,MAAM,mBAAmB,GAAG,CAAC,CAAa,EAAE,IAAuB,KAAI;QACrE,MAAM,OAAO,GAAiG,EAAE;AAChH,QAAA,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;AAChF,QAAA,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC;AAC3G,QAAA,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;AACpE,QAAA,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;AACvE,QAAA,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC;AAC3G,QAAA,OAAO,OAAO;AAChB,KAAC;AACD,IAAA,MAAM,kBAAkB,GAAG,CACzB,IAAY,EACZ,UAAuC,KACmB;AAC1D,QAAA,IAAI,CAAC,UAAU;AAAE,YAAA,OAAO,SAAS;AAEjC,QAAA,IAAI,UAAU,CAAC,MAAM,KAAK,YAAY,EAAE;YACtC,OAAO;AACL,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI;aAC3B;;QAGH,OAAO;YACL,MAAM,EAAE,UAAU,CAAC,MAAM,KAAK,UAAU,GAAG,SAAS,GAAG,UAAU,CAAC,MAAM,KAAK,cAAc,GAAG,QAAQ,GAAG,OAAO;AAChH,YAAA,IAAI,EAAE,MAAM,CAAC,IAAI,CACf,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,CAC/G,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACpB,IAAI,EAAE,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,IAAI;SAC7C;AACH,KAAC;IAED,OAAO;AACL,QAAA,IAAI,EAAE,EAAE;AACR,QAAA,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;AAC3B,QAAA,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;AAC3B,QAAA,OAAO,EAAE,OAAO;AAChB,QAAA,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CACnC,CAAC,CAAC,MACC;YACC,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,IAAI,EAAE,CAAC,CAAC,IAAI;AACZ,YAAA,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;gBACvB,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,MAAM,EAAE,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS;AAC7D,gBAAA,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;AACrG,aAAA,CAAC,CAAC;AACH,YAAA,OAAO,EAAE;AACP,gBAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI;AACpB,gBAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI;gBACpB,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI;AACvC,aAAA;AACD,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS;AAC5B,YAAA,OAAO,EAAE;AACP,gBAAA,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAqC;AAChE,gBAAA,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC;AACzB,aAAA;AACF,SAAA,CAAuB,CAC3B;AACD,QAAA,KAAK,EAAE;AACL,YAAA,MAAM,EAAE;AACN,gBAAA,MAAM,EAAE;AACN,oBAAA,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS;AACpC,oBAAA,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe;AAC5C,iBAAA;AACD,gBAAA,KAAK,EAAE;AACL,oBAAA,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS;AACnC,oBAAA,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe;AAC3C,iBAAA;AACF,aAAA;AACD,YAAA,IAAI,EAAE;gBACJ,MAAM,EAAE,MAAM,CAAC,WAAW,CACxB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK;oBACxD,CAAC,CAAC,CAAC,CAAC;AACJ,oBAAA;AACE,wBAAA,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;AACtD,wBAAA,OAAO,EAAE,WAAW;AACpB,wBAAA,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,UAAU;AAC5D,wBAAA,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;AACI,qBAAA;AACvB,iBAAA,CAAC,CACH;gBACD,KAAK,EAAE,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK;oBACvD,CAAC,CAAC,CAAC,CAAC;AACJ,oBAAA;AACE,wBAAA,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;AACtD,wBAAA,OAAO,EAAE,WAAW;AACpB,wBAAA,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,UAAU;AAC5D,wBAAA,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;AACI,qBAAA;AACvB,iBAAA,CAAC,CACH;AACD,gBAAA,GAAG,EAAE,EAAE;AACR,aAAA;AACD,YAAA,IAAI,EAAE;AACJ,gBAAA,MAAM,EAAE,EAAE;AACV,gBAAA,KAAK,EAAE,EAAE;AACT,gBAAA,GAAG,EAAE,EAAE;AACR,aAAA;AACF,SAAA;QACD,MAAM,EAAE,OAAO,CAAC,MAAM;AACtB,QAAA,WAAW,EAAE;AACX,YAAA,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAsD;AAClF,YAAA,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;AAC1B,SAAA;AACD,QAAA,QAAQ,EAAE,SAAS;AACnB,QAAA,YAAY,EAAE,SAAS;AACvB,QAAA,MAAM,EAAE,SAAS;AACjB,QAAA,QAAQ,EAAE,SAAS;AACnB,QAAA,gBAAgB,EAAE,SAAS;AAC3B,QAAA,UAAU,EAAE,SAAS;AACrB,QAAA,iBAAiB,EAAE,SAAS;KACL;AAC3B;;;;"}

package/types/asset-manager.d.ts

@@ -147,7 +147,7 @@ export declare class AssetManager {
      * ```typescript
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
      * const assetId = 123345n;
-     * const accountInfo = await algorand.asset.getAccountInformation(address, assetId);
+     * const accountInfo = await assetManager.getAccountInformation(address, assetId);
      * ```
      *
      * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)
@@ -167,9 +167,9 @@ export declare class AssetManager {
      * @example Example using AlgorandClient
      * ```typescript
      * // Basic example
-     * algorand.asset.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
+     * assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
      * // With configuration
-     * algorand.asset.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })
+     * assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })
      * ```
      * @returns An array of records matching asset ID to transaction ID of the opt in
      */
@@ -185,9 +185,9 @@ export declare class AssetManager {
      * @example Example using AlgorandClient
      * ```typescript
      * // Basic example
-     * algorand.asset.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
+     * assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
      * // With configuration
-     * algorand.asset.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })
+     * assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })
      * ```
      * @returns An array of records matching asset ID to transaction ID of the opt in
      */

package/types/asset-manager.js

@@ -58,7 +58,7 @@ class AssetManager {
      * ```typescript
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
      * const assetId = 123345n;
-     * const accountInfo = await algorand.asset.getAccountInformation(address, assetId);
+     * const accountInfo = await assetManager.getAccountInformation(address, assetId);
      * ```
      *
      * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)
@@ -86,9 +86,9 @@ class AssetManager {
      * @example Example using AlgorandClient
      * ```typescript
      * // Basic example
-     * algorand.asset.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
+     * assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
      * // With configuration
-     * algorand.asset.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })
+     * assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })
      * ```
      * @returns An array of records matching asset ID to transaction ID of the opt in
      */
@@ -123,9 +123,9 @@ class AssetManager {
      * @example Example using AlgorandClient
      * ```typescript
      * // Basic example
-     * algorand.asset.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
+     * assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
      * // With configuration
-     * algorand.asset.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })
+     * assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })
      * ```
      * @returns An array of records matching asset ID to transaction ID of the opt in
      */

package/types/asset-manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"asset-manager.js","sources":["../../src/types/asset-manager.ts"],"sourcesContent":["import algosdk, { Address } from 'algosdk'\nimport { Config } from '../config'\nimport { chunkArray } from '../util'\nimport { AccountAssetInformation } from './account'\nimport { CommonTransactionParams, MAX_TRANSACTION_GROUP_SIZE, TransactionComposer } from './composer'\nimport { SendParams } from './transaction'\n\n/** Individual result from performing a bulk opt-in or bulk opt-out for an account against a series of assets. */\nexport interface BulkAssetOptInOutResult {\n  /** The ID of the asset opted into / out of */\n  assetId: bigint\n  /** The transaction ID of the resulting opt in / out */\n  transactionId: string\n}\n\n/** Information about an asset. */\nexport interface AssetInformation {\n  /** The ID of the asset. */\n  assetId: bigint\n\n  /** The address of the account that created the asset.\n   *\n   * This is the address where the parameters for this asset can be found,\n   * and also the address where unwanted asset units can be sent when\n   * closing out an asset position and opting-out of the asset.\n   */\n  creator: string\n\n  /** The total amount of the smallest divisible (decimal) units that were created of the asset.\n   *\n   * For example, if `decimals` is, say, 2, then for every 100 `total` there is 1 whole unit.\n   */\n  total: bigint\n\n  /** The amount of decimal places the asset was created with.\n   *\n   * * If 0, the asset is not divisible;\n   * * If 1, the base unit of the asset is in tenths;\n   * * If 2, the base unit of the asset is in hundredths;\n   * * If 3, the base unit of the asset is in thousandths;\n   * * and so on up to 19 decimal places.\n   */\n  decimals: number\n\n  /** Whether the asset was frozen by default for all accounts.\n   *\n   * If `true` then for anyone apart from the creator to hold the\n   * asset it needs to be unfrozen per account using an asset freeze\n   * transaction from the `freeze` account.\n   */\n  defaultFrozen?: boolean\n\n  /** The address of the optional account that can manage the configuration of the asset and destroy it.\n   *\n   * If not set the asset is permanently immutable.\n   */\n  manager?: string\n\n  /**\n   * The address of the optional account that holds the reserve (uncirculated supply) units of the asset.\n   *\n   * This address has no specific authority in the protocol itself and is informational only.\n   *\n   * Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md)\n   * rely on this field to hold meaningful data.\n   *\n   * It can be used in the case where you want to signal to holders of your asset that the uncirculated units\n   * of the asset reside in an account that is different from the default creator account.\n   *\n   * If not set the field is permanently empty.\n   */\n  reserve?: string\n\n  /**\n   * The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account.\n   *\n   * If empty, freezing is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  freeze?: string\n\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * The clawback account has the ability to **unconditionally take assets from any account**.\n   *\n   * If empty, clawback is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  clawback?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitName?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitNameAsBytes?: Uint8Array\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetName?: string\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetNameAsBytes?: Uint8Array\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  url?: string\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  urlAsBytes?: Uint8Array\n\n  /** 32-byte hash of some metadata that is relevant to the asset and/or asset holders.\n   *\n   * The format of this metadata is up to the application.\n   */\n  metadataHash?: Uint8Array\n}\n\n/** Allows management of asset information. */\nexport class AssetManager {\n  private _algod: algosdk.Algodv2\n  private _newGroup: () => TransactionComposer\n\n  /**\n   * Create a new asset manager.\n   * @param algod An algod client\n   * @param newGroup A function that creates a new `TransactionComposer` transaction group\n   * @example Create a new asset manager\n   * ```typescript\n   * const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams}))\n   * ```\n   */\n  constructor(algod: algosdk.Algodv2, newGroup: () => TransactionComposer) {\n    this._algod = algod\n    this._newGroup = newGroup\n  }\n\n  /**\n   * Returns the current asset information for the asset with the given ID.\n   *\n   * @example\n   * ```typescript\n   * const assetInfo = await assetManager.getById(12353n);\n   * ```\n   *\n   * @param assetId The ID of the asset\n   * @returns The asset information\n   */\n  public async getById(assetId: bigint): Promise<AssetInformation> {\n    const asset = await this._algod.getAssetByID(Number(assetId)).do()\n\n    return {\n      assetId: BigInt(asset.index),\n      total: BigInt(asset.params.total),\n      decimals: Number(asset.params.decimals),\n      assetName: asset.params.name,\n      assetNameAsBytes: asset.params.nameB64,\n      unitName: asset.params.unitName,\n      unitNameAsBytes: asset.params.unitNameB64,\n      url: asset.params.url,\n      urlAsBytes: asset.params.urlB64,\n      creator: asset.params.creator,\n      manager: asset.params.manager,\n      clawback: asset.params.clawback,\n      freeze: asset.params.freeze,\n      reserve: asset.params.reserve,\n      defaultFrozen: asset.params.defaultFrozen,\n      metadataHash: asset.params.metadataHash,\n    }\n  }\n\n  /**\n   * Returns the given sender account's asset holding for a given asset.\n   *\n   * @example\n   * ```typescript\n   * const address = \"XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA\";\n   * const assetId = 123345n;\n   * const accountInfo = await algorand.asset.getAccountInformation(address, assetId);\n   * ```\n   *\n   * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)\n   * @param sender The address of the sender/account to look up\n   * @param assetId The ID of the asset to return a holding for\n   * @returns The account asset holding information\n   */\n  public async getAccountInformation(sender: string | Address, assetId: bigint): Promise<AccountAssetInformation> {\n    const info = await this._algod.accountAssetInformation(sender, Number(assetId)).do()\n\n    return {\n      assetId: BigInt(assetId),\n      balance: BigInt(info.assetHolding?.amount ?? 0),\n      frozen: info.assetHolding?.isFrozen === true,\n      round: BigInt(info['round']),\n    }\n  }\n\n  /**\n   * Opt an account in to a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-in to\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * algorand.asset.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * algorand.asset.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptIn(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> & SendParams,\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptIn({\n          ...options,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted in ${account} for assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n\n  /**\n   * Opt an account out of a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-out of\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * algorand.asset.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * algorand.asset.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptOut(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> &\n      SendParams & {\n        /** Whether or not to check if the account has a zero balance for each asset first or not.\n         *\n         * Defaults to `true`.\n         *\n         * If this is set to `true` and the account has an asset balance it will throw an error.\n         *\n         * If this is set to `false` and the account has an asset balance it will lose those assets to the asset creator.\n         */\n        ensureZeroBalance?: boolean\n      },\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      const notOptedInAssetIds: bigint[] = []\n      const nonZeroBalanceAssetIds: bigint[] = []\n      for (const assetId of assetGroup) {\n        if (options?.ensureZeroBalance !== false) {\n          try {\n            const accountAssetInfo = await this.getAccountInformation(account, assetId)\n            if (accountAssetInfo.balance !== 0n) {\n              nonZeroBalanceAssetIds.push(BigInt(assetId))\n            }\n          } catch {\n            notOptedInAssetIds.push(BigInt(assetId))\n          }\n        }\n      }\n\n      if (notOptedInAssetIds.length > 0 || nonZeroBalanceAssetIds.length > 0) {\n        throw new Error(\n          `Account ${account}${notOptedInAssetIds.length > 0 ? ` is not opted-in to Asset${notOptedInAssetIds.length > 1 ? 's' : ''} ${notOptedInAssetIds.join(', ')}` : ''}${\n            nonZeroBalanceAssetIds.length > 0\n              ? ` has non-zero balance for Asset${nonZeroBalanceAssetIds.length > 1 ? 's' : ''} ${nonZeroBalanceAssetIds.join(', ')}`\n              : ''\n          }; can't opt-out.`,\n        )\n      }\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptOut({\n          ...options,\n          creator: (await this.getById(BigInt(assetId))).creator,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted ${account} out of assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n}\n"],"names":["chunkArray","MAX_TRANSACTION_GROUP_SIZE","Config"],"mappings":";;;;;;AAwIA;MACa,YAAY,CAAA;AAIvB;;;;;;;;AAQG;IACH,WAAY,CAAA,KAAsB,EAAE,QAAmC,EAAA;AACrE,QAAA,IAAI,CAAC,MAAM,GAAG,KAAK;AACnB,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ;;AAG3B;;;;;;;;;;AAUG;IACI,MAAM,OAAO,CAAC,OAAe,EAAA;AAClC,QAAA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAElE,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC5B,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;YACjC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;AACvC,YAAA,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;AAC5B,YAAA,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AACtC,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW;AACzC,YAAA,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG;AACrB,YAAA,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC/B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC3B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa;AACzC,YAAA,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,YAAY;SACxC;;AAGH;;;;;;;;;;;;;;AAcG;AACI,IAAA,MAAM,qBAAqB,CAAC,MAAwB,EAAE,OAAe,EAAA;AAC1E,QAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAEpF,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC,CAAC;AAC/C,YAAA,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,KAAK,IAAI;AAC5C,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;;AAGH;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,SAAS,CACb,OAAyB,EACzB,QAAkB,EAClB,OAA8D,EAAA;QAE9D,MAAM,OAAO,GAA8B,EAAE;QAE7C,KAAK,MAAM,UAAU,IAAIA,eAAU,CAAC,QAAQ,EAAEC,yCAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE;AAEjC,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,aAAa,CAAC;AACrB,oBAAA,GAAG,OAAO;AACV,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC;;YAGJ,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;AAE3C,YAAAC,aAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAyB,sBAAA,EAAA,OAAO,CAAe,YAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;AAChF,aAAC,CAAC;;AAGJ,QAAA,OAAO,OAAO;;AAGhB;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,UAAU,CACd,OAAyB,EACzB,QAAkB,EAClB,OAWG,EAAA;QAEH,MAAM,OAAO,GAA8B,EAAE;QAE7C,KAAK,MAAM,UAAU,IAAIF,eAAU,CAAC,QAAQ,EAAEC,yCAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE;YAEjC,MAAM,kBAAkB,GAAa,EAAE;YACvC,MAAM,sBAAsB,GAAa,EAAE;AAC3C,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;AAChC,gBAAA,IAAI,OAAO,EAAE,iBAAiB,KAAK,KAAK,EAAE;AACxC,oBAAA,IAAI;wBACF,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC;AAC3E,wBAAA,IAAI,gBAAgB,CAAC,OAAO,KAAK,EAAE,EAAE;4BACnC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;;AAE9C,oBAAA,MAAM;wBACN,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;;;AAK9C,YAAA,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtE,MAAM,IAAI,KAAK,CACb,CAAA,QAAA,EAAW,OAAO,CAAG,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,CAA4B,yBAAA,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA,GAAG,EAAE,GAC/J,sBAAsB,CAAC,MAAM,GAAG;sBAC5B,kCAAkC,sBAAsB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAI,CAAA,EAAA,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE;AACvH,sBAAE,EACN,CAAkB,gBAAA,CAAA,CACnB;;AAGH,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,cAAc,CAAC;AACtB,oBAAA,GAAG,OAAO;AACV,oBAAA,OAAO,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO;AACtD,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC;;YAGJ,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;AAE3C,YAAAC,aAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAsB,mBAAA,EAAA,OAAO,CAAkB,eAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;AAChF,aAAC,CAAC;;AAGJ,QAAA,OAAO,OAAO;;AAEjB;;;;"}
+{"version":3,"file":"asset-manager.js","sources":["../../src/types/asset-manager.ts"],"sourcesContent":["import algosdk, { Address } from 'algosdk'\nimport { Config } from '../config'\nimport { chunkArray } from '../util'\nimport { AccountAssetInformation } from './account'\nimport { CommonTransactionParams, MAX_TRANSACTION_GROUP_SIZE, TransactionComposer } from './composer'\nimport { SendParams } from './transaction'\n\n/** Individual result from performing a bulk opt-in or bulk opt-out for an account against a series of assets. */\nexport interface BulkAssetOptInOutResult {\n  /** The ID of the asset opted into / out of */\n  assetId: bigint\n  /** The transaction ID of the resulting opt in / out */\n  transactionId: string\n}\n\n/** Information about an asset. */\nexport interface AssetInformation {\n  /** The ID of the asset. */\n  assetId: bigint\n\n  /** The address of the account that created the asset.\n   *\n   * This is the address where the parameters for this asset can be found,\n   * and also the address where unwanted asset units can be sent when\n   * closing out an asset position and opting-out of the asset.\n   */\n  creator: string\n\n  /** The total amount of the smallest divisible (decimal) units that were created of the asset.\n   *\n   * For example, if `decimals` is, say, 2, then for every 100 `total` there is 1 whole unit.\n   */\n  total: bigint\n\n  /** The amount of decimal places the asset was created with.\n   *\n   * * If 0, the asset is not divisible;\n   * * If 1, the base unit of the asset is in tenths;\n   * * If 2, the base unit of the asset is in hundredths;\n   * * If 3, the base unit of the asset is in thousandths;\n   * * and so on up to 19 decimal places.\n   */\n  decimals: number\n\n  /** Whether the asset was frozen by default for all accounts.\n   *\n   * If `true` then for anyone apart from the creator to hold the\n   * asset it needs to be unfrozen per account using an asset freeze\n   * transaction from the `freeze` account.\n   */\n  defaultFrozen?: boolean\n\n  /** The address of the optional account that can manage the configuration of the asset and destroy it.\n   *\n   * If not set the asset is permanently immutable.\n   */\n  manager?: string\n\n  /**\n   * The address of the optional account that holds the reserve (uncirculated supply) units of the asset.\n   *\n   * This address has no specific authority in the protocol itself and is informational only.\n   *\n   * Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md)\n   * rely on this field to hold meaningful data.\n   *\n   * It can be used in the case where you want to signal to holders of your asset that the uncirculated units\n   * of the asset reside in an account that is different from the default creator account.\n   *\n   * If not set the field is permanently empty.\n   */\n  reserve?: string\n\n  /**\n   * The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account.\n   *\n   * If empty, freezing is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  freeze?: string\n\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * The clawback account has the ability to **unconditionally take assets from any account**.\n   *\n   * If empty, clawback is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  clawback?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitName?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitNameAsBytes?: Uint8Array\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetName?: string\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetNameAsBytes?: Uint8Array\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  url?: string\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  urlAsBytes?: Uint8Array\n\n  /** 32-byte hash of some metadata that is relevant to the asset and/or asset holders.\n   *\n   * The format of this metadata is up to the application.\n   */\n  metadataHash?: Uint8Array\n}\n\n/** Allows management of asset information. */\nexport class AssetManager {\n  private _algod: algosdk.Algodv2\n  private _newGroup: () => TransactionComposer\n\n  /**\n   * Create a new asset manager.\n   * @param algod An algod client\n   * @param newGroup A function that creates a new `TransactionComposer` transaction group\n   * @example Create a new asset manager\n   * ```typescript\n   * const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams}))\n   * ```\n   */\n  constructor(algod: algosdk.Algodv2, newGroup: () => TransactionComposer) {\n    this._algod = algod\n    this._newGroup = newGroup\n  }\n\n  /**\n   * Returns the current asset information for the asset with the given ID.\n   *\n   * @example\n   * ```typescript\n   * const assetInfo = await assetManager.getById(12353n);\n   * ```\n   *\n   * @param assetId The ID of the asset\n   * @returns The asset information\n   */\n  public async getById(assetId: bigint): Promise<AssetInformation> {\n    const asset = await this._algod.getAssetByID(Number(assetId)).do()\n\n    return {\n      assetId: BigInt(asset.index),\n      total: BigInt(asset.params.total),\n      decimals: Number(asset.params.decimals),\n      assetName: asset.params.name,\n      assetNameAsBytes: asset.params.nameB64,\n      unitName: asset.params.unitName,\n      unitNameAsBytes: asset.params.unitNameB64,\n      url: asset.params.url,\n      urlAsBytes: asset.params.urlB64,\n      creator: asset.params.creator,\n      manager: asset.params.manager,\n      clawback: asset.params.clawback,\n      freeze: asset.params.freeze,\n      reserve: asset.params.reserve,\n      defaultFrozen: asset.params.defaultFrozen,\n      metadataHash: asset.params.metadataHash,\n    }\n  }\n\n  /**\n   * Returns the given sender account's asset holding for a given asset.\n   *\n   * @example\n   * ```typescript\n   * const address = \"XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA\";\n   * const assetId = 123345n;\n   * const accountInfo = await assetManager.getAccountInformation(address, assetId);\n   * ```\n   *\n   * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)\n   * @param sender The address of the sender/account to look up\n   * @param assetId The ID of the asset to return a holding for\n   * @returns The account asset holding information\n   */\n  public async getAccountInformation(sender: string | Address, assetId: bigint): Promise<AccountAssetInformation> {\n    const info = await this._algod.accountAssetInformation(sender, Number(assetId)).do()\n\n    return {\n      assetId: BigInt(assetId),\n      balance: BigInt(info.assetHolding?.amount ?? 0),\n      frozen: info.assetHolding?.isFrozen === true,\n      round: BigInt(info['round']),\n    }\n  }\n\n  /**\n   * Opt an account in to a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-in to\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * assetManager.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * assetManager.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptIn(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> & SendParams,\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptIn({\n          ...options,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted in ${account} for assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n\n  /**\n   * Opt an account out of a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-out of\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * assetManager.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * assetManager.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptOut(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> &\n      SendParams & {\n        /** Whether or not to check if the account has a zero balance for each asset first or not.\n         *\n         * Defaults to `true`.\n         *\n         * If this is set to `true` and the account has an asset balance it will throw an error.\n         *\n         * If this is set to `false` and the account has an asset balance it will lose those assets to the asset creator.\n         */\n        ensureZeroBalance?: boolean\n      },\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      const notOptedInAssetIds: bigint[] = []\n      const nonZeroBalanceAssetIds: bigint[] = []\n      for (const assetId of assetGroup) {\n        if (options?.ensureZeroBalance !== false) {\n          try {\n            const accountAssetInfo = await this.getAccountInformation(account, assetId)\n            if (accountAssetInfo.balance !== 0n) {\n              nonZeroBalanceAssetIds.push(BigInt(assetId))\n            }\n          } catch {\n            notOptedInAssetIds.push(BigInt(assetId))\n          }\n        }\n      }\n\n      if (notOptedInAssetIds.length > 0 || nonZeroBalanceAssetIds.length > 0) {\n        throw new Error(\n          `Account ${account}${notOptedInAssetIds.length > 0 ? ` is not opted-in to Asset${notOptedInAssetIds.length > 1 ? 's' : ''} ${notOptedInAssetIds.join(', ')}` : ''}${\n            nonZeroBalanceAssetIds.length > 0\n              ? ` has non-zero balance for Asset${nonZeroBalanceAssetIds.length > 1 ? 's' : ''} ${nonZeroBalanceAssetIds.join(', ')}`\n              : ''\n          }; can't opt-out.`,\n        )\n      }\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptOut({\n          ...options,\n          creator: (await this.getById(BigInt(assetId))).creator,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted ${account} out of assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n}\n"],"names":["chunkArray","MAX_TRANSACTION_GROUP_SIZE","Config"],"mappings":";;;;;;AAwIA;MACa,YAAY,CAAA;AAIvB;;;;;;;;AAQG;IACH,WAAY,CAAA,KAAsB,EAAE,QAAmC,EAAA;AACrE,QAAA,IAAI,CAAC,MAAM,GAAG,KAAK;AACnB,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ;;AAG3B;;;;;;;;;;AAUG;IACI,MAAM,OAAO,CAAC,OAAe,EAAA;AAClC,QAAA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAElE,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC5B,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;YACjC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;AACvC,YAAA,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;AAC5B,YAAA,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AACtC,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW;AACzC,YAAA,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG;AACrB,YAAA,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC/B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC3B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa;AACzC,YAAA,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,YAAY;SACxC;;AAGH;;;;;;;;;;;;;;AAcG;AACI,IAAA,MAAM,qBAAqB,CAAC,MAAwB,EAAE,OAAe,EAAA;AAC1E,QAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAEpF,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC,CAAC;AAC/C,YAAA,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,KAAK,IAAI;AAC5C,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;;AAGH;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,SAAS,CACb,OAAyB,EACzB,QAAkB,EAClB,OAA8D,EAAA;QAE9D,MAAM,OAAO,GAA8B,EAAE;QAE7C,KAAK,MAAM,UAAU,IAAIA,eAAU,CAAC,QAAQ,EAAEC,yCAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE;AAEjC,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,aAAa,CAAC;AACrB,oBAAA,GAAG,OAAO;AACV,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC;;YAGJ,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;AAE3C,YAAAC,aAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAyB,sBAAA,EAAA,OAAO,CAAe,YAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;AAChF,aAAC,CAAC;;AAGJ,QAAA,OAAO,OAAO;;AAGhB;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,UAAU,CACd,OAAyB,EACzB,QAAkB,EAClB,OAWG,EAAA;QAEH,MAAM,OAAO,GAA8B,EAAE;QAE7C,KAAK,MAAM,UAAU,IAAIF,eAAU,CAAC,QAAQ,EAAEC,yCAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE;YAEjC,MAAM,kBAAkB,GAAa,EAAE;YACvC,MAAM,sBAAsB,GAAa,EAAE;AAC3C,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;AAChC,gBAAA,IAAI,OAAO,EAAE,iBAAiB,KAAK,KAAK,EAAE;AACxC,oBAAA,IAAI;wBACF,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC;AAC3E,wBAAA,IAAI,gBAAgB,CAAC,OAAO,KAAK,EAAE,EAAE;4BACnC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;;AAE9C,oBAAA,MAAM;wBACN,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;;;AAK9C,YAAA,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtE,MAAM,IAAI,KAAK,CACb,CAAA,QAAA,EAAW,OAAO,CAAG,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,CAA4B,yBAAA,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA,GAAG,EAAE,GAC/J,sBAAsB,CAAC,MAAM,GAAG;sBAC5B,kCAAkC,sBAAsB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAI,CAAA,EAAA,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE;AACvH,sBAAE,EACN,CAAkB,gBAAA,CAAA,CACnB;;AAGH,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,cAAc,CAAC;AACtB,oBAAA,GAAG,OAAO;AACV,oBAAA,OAAO,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO;AACtD,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC;;YAGJ,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;AAE3C,YAAAC,aAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAsB,mBAAA,EAAA,OAAO,CAAkB,eAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;AAChF,aAAC,CAAC;;AAGJ,QAAA,OAAO,OAAO;;AAEjB;;;;"}

package/types/asset-manager.mjs

@@ -56,7 +56,7 @@ class AssetManager {
      * ```typescript
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
      * const assetId = 123345n;
-     * const accountInfo = await algorand.asset.getAccountInformation(address, assetId);
+     * const accountInfo = await assetManager.getAccountInformation(address, assetId);
      * ```
      *
      * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)
@@ -84,9 +84,9 @@ class AssetManager {
      * @example Example using AlgorandClient
      * ```typescript
      * // Basic example
-     * algorand.asset.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
+     * assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n])
      * // With configuration
-     * algorand.asset.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })
+     * assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })
      * ```
      * @returns An array of records matching asset ID to transaction ID of the opt in
      */
@@ -121,9 +121,9 @@ class AssetManager {
      * @example Example using AlgorandClient
      * ```typescript
      * // Basic example
-     * algorand.asset.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
+     * assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n])
      * // With configuration
-     * algorand.asset.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })
+     * assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })
      * ```
      * @returns An array of records matching asset ID to transaction ID of the opt in
      */

package/types/asset-manager.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"asset-manager.mjs","sources":["../../src/types/asset-manager.ts"],"sourcesContent":["import algosdk, { Address } from 'algosdk'\nimport { Config } from '../config'\nimport { chunkArray } from '../util'\nimport { AccountAssetInformation } from './account'\nimport { CommonTransactionParams, MAX_TRANSACTION_GROUP_SIZE, TransactionComposer } from './composer'\nimport { SendParams } from './transaction'\n\n/** Individual result from performing a bulk opt-in or bulk opt-out for an account against a series of assets. */\nexport interface BulkAssetOptInOutResult {\n  /** The ID of the asset opted into / out of */\n  assetId: bigint\n  /** The transaction ID of the resulting opt in / out */\n  transactionId: string\n}\n\n/** Information about an asset. */\nexport interface AssetInformation {\n  /** The ID of the asset. */\n  assetId: bigint\n\n  /** The address of the account that created the asset.\n   *\n   * This is the address where the parameters for this asset can be found,\n   * and also the address where unwanted asset units can be sent when\n   * closing out an asset position and opting-out of the asset.\n   */\n  creator: string\n\n  /** The total amount of the smallest divisible (decimal) units that were created of the asset.\n   *\n   * For example, if `decimals` is, say, 2, then for every 100 `total` there is 1 whole unit.\n   */\n  total: bigint\n\n  /** The amount of decimal places the asset was created with.\n   *\n   * * If 0, the asset is not divisible;\n   * * If 1, the base unit of the asset is in tenths;\n   * * If 2, the base unit of the asset is in hundredths;\n   * * If 3, the base unit of the asset is in thousandths;\n   * * and so on up to 19 decimal places.\n   */\n  decimals: number\n\n  /** Whether the asset was frozen by default for all accounts.\n   *\n   * If `true` then for anyone apart from the creator to hold the\n   * asset it needs to be unfrozen per account using an asset freeze\n   * transaction from the `freeze` account.\n   */\n  defaultFrozen?: boolean\n\n  /** The address of the optional account that can manage the configuration of the asset and destroy it.\n   *\n   * If not set the asset is permanently immutable.\n   */\n  manager?: string\n\n  /**\n   * The address of the optional account that holds the reserve (uncirculated supply) units of the asset.\n   *\n   * This address has no specific authority in the protocol itself and is informational only.\n   *\n   * Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md)\n   * rely on this field to hold meaningful data.\n   *\n   * It can be used in the case where you want to signal to holders of your asset that the uncirculated units\n   * of the asset reside in an account that is different from the default creator account.\n   *\n   * If not set the field is permanently empty.\n   */\n  reserve?: string\n\n  /**\n   * The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account.\n   *\n   * If empty, freezing is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  freeze?: string\n\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * The clawback account has the ability to **unconditionally take assets from any account**.\n   *\n   * If empty, clawback is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  clawback?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitName?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitNameAsBytes?: Uint8Array\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetName?: string\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetNameAsBytes?: Uint8Array\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  url?: string\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  urlAsBytes?: Uint8Array\n\n  /** 32-byte hash of some metadata that is relevant to the asset and/or asset holders.\n   *\n   * The format of this metadata is up to the application.\n   */\n  metadataHash?: Uint8Array\n}\n\n/** Allows management of asset information. */\nexport class AssetManager {\n  private _algod: algosdk.Algodv2\n  private _newGroup: () => TransactionComposer\n\n  /**\n   * Create a new asset manager.\n   * @param algod An algod client\n   * @param newGroup A function that creates a new `TransactionComposer` transaction group\n   * @example Create a new asset manager\n   * ```typescript\n   * const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams}))\n   * ```\n   */\n  constructor(algod: algosdk.Algodv2, newGroup: () => TransactionComposer) {\n    this._algod = algod\n    this._newGroup = newGroup\n  }\n\n  /**\n   * Returns the current asset information for the asset with the given ID.\n   *\n   * @example\n   * ```typescript\n   * const assetInfo = await assetManager.getById(12353n);\n   * ```\n   *\n   * @param assetId The ID of the asset\n   * @returns The asset information\n   */\n  public async getById(assetId: bigint): Promise<AssetInformation> {\n    const asset = await this._algod.getAssetByID(Number(assetId)).do()\n\n    return {\n      assetId: BigInt(asset.index),\n      total: BigInt(asset.params.total),\n      decimals: Number(asset.params.decimals),\n      assetName: asset.params.name,\n      assetNameAsBytes: asset.params.nameB64,\n      unitName: asset.params.unitName,\n      unitNameAsBytes: asset.params.unitNameB64,\n      url: asset.params.url,\n      urlAsBytes: asset.params.urlB64,\n      creator: asset.params.creator,\n      manager: asset.params.manager,\n      clawback: asset.params.clawback,\n      freeze: asset.params.freeze,\n      reserve: asset.params.reserve,\n      defaultFrozen: asset.params.defaultFrozen,\n      metadataHash: asset.params.metadataHash,\n    }\n  }\n\n  /**\n   * Returns the given sender account's asset holding for a given asset.\n   *\n   * @example\n   * ```typescript\n   * const address = \"XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA\";\n   * const assetId = 123345n;\n   * const accountInfo = await algorand.asset.getAccountInformation(address, assetId);\n   * ```\n   *\n   * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)\n   * @param sender The address of the sender/account to look up\n   * @param assetId The ID of the asset to return a holding for\n   * @returns The account asset holding information\n   */\n  public async getAccountInformation(sender: string | Address, assetId: bigint): Promise<AccountAssetInformation> {\n    const info = await this._algod.accountAssetInformation(sender, Number(assetId)).do()\n\n    return {\n      assetId: BigInt(assetId),\n      balance: BigInt(info.assetHolding?.amount ?? 0),\n      frozen: info.assetHolding?.isFrozen === true,\n      round: BigInt(info['round']),\n    }\n  }\n\n  /**\n   * Opt an account in to a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-in to\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * algorand.asset.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * algorand.asset.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptIn(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> & SendParams,\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptIn({\n          ...options,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted in ${account} for assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n\n  /**\n   * Opt an account out of a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-out of\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * algorand.asset.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * algorand.asset.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptOut(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> &\n      SendParams & {\n        /** Whether or not to check if the account has a zero balance for each asset first or not.\n         *\n         * Defaults to `true`.\n         *\n         * If this is set to `true` and the account has an asset balance it will throw an error.\n         *\n         * If this is set to `false` and the account has an asset balance it will lose those assets to the asset creator.\n         */\n        ensureZeroBalance?: boolean\n      },\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      const notOptedInAssetIds: bigint[] = []\n      const nonZeroBalanceAssetIds: bigint[] = []\n      for (const assetId of assetGroup) {\n        if (options?.ensureZeroBalance !== false) {\n          try {\n            const accountAssetInfo = await this.getAccountInformation(account, assetId)\n            if (accountAssetInfo.balance !== 0n) {\n              nonZeroBalanceAssetIds.push(BigInt(assetId))\n            }\n          } catch {\n            notOptedInAssetIds.push(BigInt(assetId))\n          }\n        }\n      }\n\n      if (notOptedInAssetIds.length > 0 || nonZeroBalanceAssetIds.length > 0) {\n        throw new Error(\n          `Account ${account}${notOptedInAssetIds.length > 0 ? ` is not opted-in to Asset${notOptedInAssetIds.length > 1 ? 's' : ''} ${notOptedInAssetIds.join(', ')}` : ''}${\n            nonZeroBalanceAssetIds.length > 0\n              ? ` has non-zero balance for Asset${nonZeroBalanceAssetIds.length > 1 ? 's' : ''} ${nonZeroBalanceAssetIds.join(', ')}`\n              : ''\n          }; can't opt-out.`,\n        )\n      }\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptOut({\n          ...options,\n          creator: (await this.getById(BigInt(assetId))).creator,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted ${account} out of assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n}\n"],"names":[],"mappings":";;;;AAwIA;MACa,YAAY,CAAA;AAIvB;;;;;;;;AAQG;IACH,WAAY,CAAA,KAAsB,EAAE,QAAmC,EAAA;AACrE,QAAA,IAAI,CAAC,MAAM,GAAG,KAAK;AACnB,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ;;AAG3B;;;;;;;;;;AAUG;IACI,MAAM,OAAO,CAAC,OAAe,EAAA;AAClC,QAAA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAElE,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC5B,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;YACjC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;AACvC,YAAA,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;AAC5B,YAAA,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AACtC,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW;AACzC,YAAA,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG;AACrB,YAAA,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC/B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC3B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa;AACzC,YAAA,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,YAAY;SACxC;;AAGH;;;;;;;;;;;;;;AAcG;AACI,IAAA,MAAM,qBAAqB,CAAC,MAAwB,EAAE,OAAe,EAAA;AAC1E,QAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAEpF,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC,CAAC;AAC/C,YAAA,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,KAAK,IAAI;AAC5C,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;;AAGH;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,SAAS,CACb,OAAyB,EACzB,QAAkB,EAClB,OAA8D,EAAA;QAE9D,MAAM,OAAO,GAA8B,EAAE;QAE7C,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,QAAQ,EAAE,0BAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE;AAEjC,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,aAAa,CAAC;AACrB,oBAAA,GAAG,OAAO;AACV,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC;;YAGJ,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;AAE3C,YAAA,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAyB,sBAAA,EAAA,OAAO,CAAe,YAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;AAChF,aAAC,CAAC;;AAGJ,QAAA,OAAO,OAAO;;AAGhB;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,UAAU,CACd,OAAyB,EACzB,QAAkB,EAClB,OAWG,EAAA;QAEH,MAAM,OAAO,GAA8B,EAAE;QAE7C,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,QAAQ,EAAE,0BAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE;YAEjC,MAAM,kBAAkB,GAAa,EAAE;YACvC,MAAM,sBAAsB,GAAa,EAAE;AAC3C,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;AAChC,gBAAA,IAAI,OAAO,EAAE,iBAAiB,KAAK,KAAK,EAAE;AACxC,oBAAA,IAAI;wBACF,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC;AAC3E,wBAAA,IAAI,gBAAgB,CAAC,OAAO,KAAK,EAAE,EAAE;4BACnC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;;AAE9C,oBAAA,MAAM;wBACN,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;;;AAK9C,YAAA,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtE,MAAM,IAAI,KAAK,CACb,CAAA,QAAA,EAAW,OAAO,CAAG,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,CAA4B,yBAAA,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA,GAAG,EAAE,GAC/J,sBAAsB,CAAC,MAAM,GAAG;sBAC5B,kCAAkC,sBAAsB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAI,CAAA,EAAA,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE;AACvH,sBAAE,EACN,CAAkB,gBAAA,CAAA,CACnB;;AAGH,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,cAAc,CAAC;AACtB,oBAAA,GAAG,OAAO;AACV,oBAAA,OAAO,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO;AACtD,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC;;YAGJ,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;AAE3C,YAAA,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAsB,mBAAA,EAAA,OAAO,CAAkB,eAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;AAChF,aAAC,CAAC;;AAGJ,QAAA,OAAO,OAAO;;AAEjB;;;;"}
+{"version":3,"file":"asset-manager.mjs","sources":["../../src/types/asset-manager.ts"],"sourcesContent":["import algosdk, { Address } from 'algosdk'\nimport { Config } from '../config'\nimport { chunkArray } from '../util'\nimport { AccountAssetInformation } from './account'\nimport { CommonTransactionParams, MAX_TRANSACTION_GROUP_SIZE, TransactionComposer } from './composer'\nimport { SendParams } from './transaction'\n\n/** Individual result from performing a bulk opt-in or bulk opt-out for an account against a series of assets. */\nexport interface BulkAssetOptInOutResult {\n  /** The ID of the asset opted into / out of */\n  assetId: bigint\n  /** The transaction ID of the resulting opt in / out */\n  transactionId: string\n}\n\n/** Information about an asset. */\nexport interface AssetInformation {\n  /** The ID of the asset. */\n  assetId: bigint\n\n  /** The address of the account that created the asset.\n   *\n   * This is the address where the parameters for this asset can be found,\n   * and also the address where unwanted asset units can be sent when\n   * closing out an asset position and opting-out of the asset.\n   */\n  creator: string\n\n  /** The total amount of the smallest divisible (decimal) units that were created of the asset.\n   *\n   * For example, if `decimals` is, say, 2, then for every 100 `total` there is 1 whole unit.\n   */\n  total: bigint\n\n  /** The amount of decimal places the asset was created with.\n   *\n   * * If 0, the asset is not divisible;\n   * * If 1, the base unit of the asset is in tenths;\n   * * If 2, the base unit of the asset is in hundredths;\n   * * If 3, the base unit of the asset is in thousandths;\n   * * and so on up to 19 decimal places.\n   */\n  decimals: number\n\n  /** Whether the asset was frozen by default for all accounts.\n   *\n   * If `true` then for anyone apart from the creator to hold the\n   * asset it needs to be unfrozen per account using an asset freeze\n   * transaction from the `freeze` account.\n   */\n  defaultFrozen?: boolean\n\n  /** The address of the optional account that can manage the configuration of the asset and destroy it.\n   *\n   * If not set the asset is permanently immutable.\n   */\n  manager?: string\n\n  /**\n   * The address of the optional account that holds the reserve (uncirculated supply) units of the asset.\n   *\n   * This address has no specific authority in the protocol itself and is informational only.\n   *\n   * Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md)\n   * rely on this field to hold meaningful data.\n   *\n   * It can be used in the case where you want to signal to holders of your asset that the uncirculated units\n   * of the asset reside in an account that is different from the default creator account.\n   *\n   * If not set the field is permanently empty.\n   */\n  reserve?: string\n\n  /**\n   * The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account.\n   *\n   * If empty, freezing is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  freeze?: string\n\n  /**\n   * The address of the optional account that can clawback holdings of this asset from any account.\n   *\n   * The clawback account has the ability to **unconditionally take assets from any account**.\n   *\n   * If empty, clawback is not permitted.\n   *\n   * If not set the field is permanently empty.\n   */\n  clawback?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitName?: string\n\n  /** The optional name of the unit of this asset (e.g. ticker name).\n   *\n   * Max size is 8 bytes.\n   */\n  unitNameAsBytes?: Uint8Array\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetName?: string\n\n  /** The optional name of the asset.\n   *\n   * Max size is 32 bytes.\n   */\n  assetNameAsBytes?: Uint8Array\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  url?: string\n\n  /** Optional URL where more information about the asset can be retrieved (e.g. metadata).\n   *\n   * Max size is 96 bytes.\n   */\n  urlAsBytes?: Uint8Array\n\n  /** 32-byte hash of some metadata that is relevant to the asset and/or asset holders.\n   *\n   * The format of this metadata is up to the application.\n   */\n  metadataHash?: Uint8Array\n}\n\n/** Allows management of asset information. */\nexport class AssetManager {\n  private _algod: algosdk.Algodv2\n  private _newGroup: () => TransactionComposer\n\n  /**\n   * Create a new asset manager.\n   * @param algod An algod client\n   * @param newGroup A function that creates a new `TransactionComposer` transaction group\n   * @example Create a new asset manager\n   * ```typescript\n   * const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams}))\n   * ```\n   */\n  constructor(algod: algosdk.Algodv2, newGroup: () => TransactionComposer) {\n    this._algod = algod\n    this._newGroup = newGroup\n  }\n\n  /**\n   * Returns the current asset information for the asset with the given ID.\n   *\n   * @example\n   * ```typescript\n   * const assetInfo = await assetManager.getById(12353n);\n   * ```\n   *\n   * @param assetId The ID of the asset\n   * @returns The asset information\n   */\n  public async getById(assetId: bigint): Promise<AssetInformation> {\n    const asset = await this._algod.getAssetByID(Number(assetId)).do()\n\n    return {\n      assetId: BigInt(asset.index),\n      total: BigInt(asset.params.total),\n      decimals: Number(asset.params.decimals),\n      assetName: asset.params.name,\n      assetNameAsBytes: asset.params.nameB64,\n      unitName: asset.params.unitName,\n      unitNameAsBytes: asset.params.unitNameB64,\n      url: asset.params.url,\n      urlAsBytes: asset.params.urlB64,\n      creator: asset.params.creator,\n      manager: asset.params.manager,\n      clawback: asset.params.clawback,\n      freeze: asset.params.freeze,\n      reserve: asset.params.reserve,\n      defaultFrozen: asset.params.defaultFrozen,\n      metadataHash: asset.params.metadataHash,\n    }\n  }\n\n  /**\n   * Returns the given sender account's asset holding for a given asset.\n   *\n   * @example\n   * ```typescript\n   * const address = \"XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA\";\n   * const assetId = 123345n;\n   * const accountInfo = await assetManager.getAccountInformation(address, assetId);\n   * ```\n   *\n   * [Response data schema details](https://developer.algorand.org/docs/rest-apis/algod/#get-v2accountsaddressassetsasset-id)\n   * @param sender The address of the sender/account to look up\n   * @param assetId The ID of the asset to return a holding for\n   * @returns The account asset holding information\n   */\n  public async getAccountInformation(sender: string | Address, assetId: bigint): Promise<AccountAssetInformation> {\n    const info = await this._algod.accountAssetInformation(sender, Number(assetId)).do()\n\n    return {\n      assetId: BigInt(assetId),\n      balance: BigInt(info.assetHolding?.amount ?? 0),\n      frozen: info.assetHolding?.isFrozen === true,\n      round: BigInt(info['round']),\n    }\n  }\n\n  /**\n   * Opt an account in to a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-in to\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * assetManager.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * assetManager.bulkOptIn(\"ACCOUNTADDRESS\", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptIn(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> & SendParams,\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptIn({\n          ...options,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted in ${account} for assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n\n  /**\n   * Opt an account out of a list of Algorand Standard Assets.\n   *\n   * Transactions will be sent in batches of 16 as transaction groups.\n   *\n   * @param account The account to opt-in\n   * @param assetIds The list of asset IDs to opt-out of\n   * @param options Any parameters to control the transaction or execution of the transaction\n   * @example Example using AlgorandClient\n   * ```typescript\n   * // Basic example\n   * assetManager.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n])\n   * // With configuration\n   * assetManager.bulkOptOut(\"ACCOUNTADDRESS\", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true })\n   * ```\n   * @returns An array of records matching asset ID to transaction ID of the opt in\n   */\n  async bulkOptOut(\n    account: string | Address,\n    assetIds: bigint[],\n    options?: Omit<CommonTransactionParams, 'sender'> &\n      SendParams & {\n        /** Whether or not to check if the account has a zero balance for each asset first or not.\n         *\n         * Defaults to `true`.\n         *\n         * If this is set to `true` and the account has an asset balance it will throw an error.\n         *\n         * If this is set to `false` and the account has an asset balance it will lose those assets to the asset creator.\n         */\n        ensureZeroBalance?: boolean\n      },\n  ): Promise<BulkAssetOptInOutResult[]> {\n    const results: BulkAssetOptInOutResult[] = []\n\n    for (const assetGroup of chunkArray(assetIds, MAX_TRANSACTION_GROUP_SIZE)) {\n      const composer = this._newGroup()\n\n      const notOptedInAssetIds: bigint[] = []\n      const nonZeroBalanceAssetIds: bigint[] = []\n      for (const assetId of assetGroup) {\n        if (options?.ensureZeroBalance !== false) {\n          try {\n            const accountAssetInfo = await this.getAccountInformation(account, assetId)\n            if (accountAssetInfo.balance !== 0n) {\n              nonZeroBalanceAssetIds.push(BigInt(assetId))\n            }\n          } catch {\n            notOptedInAssetIds.push(BigInt(assetId))\n          }\n        }\n      }\n\n      if (notOptedInAssetIds.length > 0 || nonZeroBalanceAssetIds.length > 0) {\n        throw new Error(\n          `Account ${account}${notOptedInAssetIds.length > 0 ? ` is not opted-in to Asset${notOptedInAssetIds.length > 1 ? 's' : ''} ${notOptedInAssetIds.join(', ')}` : ''}${\n            nonZeroBalanceAssetIds.length > 0\n              ? ` has non-zero balance for Asset${nonZeroBalanceAssetIds.length > 1 ? 's' : ''} ${nonZeroBalanceAssetIds.join(', ')}`\n              : ''\n          }; can't opt-out.`,\n        )\n      }\n\n      for (const assetId of assetGroup) {\n        composer.addAssetOptOut({\n          ...options,\n          creator: (await this.getById(BigInt(assetId))).creator,\n          sender: account,\n          assetId: BigInt(assetId),\n        })\n      }\n\n      const result = await composer.send(options)\n\n      Config.getLogger(options?.suppressLog).info(\n        `Successfully opted ${account} out of assets ${assetGroup.join(', ')} with transaction IDs ${result.txIds.join(', ')}` +\n          `\\n  Grouped under ${result.groupId} in round ${result.confirmations?.[0]?.confirmedRound}.`,\n      )\n\n      assetGroup.forEach((assetId, index) => {\n        results.push({ assetId: BigInt(assetId), transactionId: result.txIds[index] })\n      })\n    }\n\n    return results\n  }\n}\n"],"names":[],"mappings":";;;;AAwIA;MACa,YAAY,CAAA;AAIvB;;;;;;;;AAQG;IACH,WAAY,CAAA,KAAsB,EAAE,QAAmC,EAAA;AACrE,QAAA,IAAI,CAAC,MAAM,GAAG,KAAK;AACnB,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ;;AAG3B;;;;;;;;;;AAUG;IACI,MAAM,OAAO,CAAC,OAAe,EAAA;AAClC,QAAA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAElE,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC5B,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;YACjC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;AACvC,YAAA,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;AAC5B,YAAA,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AACtC,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW;AACzC,YAAA,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG;AACrB,YAAA,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC/B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ;AAC/B,YAAA,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;AAC3B,YAAA,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO;AAC7B,YAAA,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa;AACzC,YAAA,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,YAAY;SACxC;;AAGH;;;;;;;;;;;;;;AAcG;AACI,IAAA,MAAM,qBAAqB,CAAC,MAAwB,EAAE,OAAe,EAAA;AAC1E,QAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAEpF,OAAO;AACL,YAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;YACxB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC,CAAC;AAC/C,YAAA,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,KAAK,IAAI;AAC5C,YAAA,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;;AAGH;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,SAAS,CACb,OAAyB,EACzB,QAAkB,EAClB,OAA8D,EAAA;QAE9D,MAAM,OAAO,GAA8B,EAAE;QAE7C,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,QAAQ,EAAE,0BAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE;AAEjC,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,aAAa,CAAC;AACrB,oBAAA,GAAG,OAAO;AACV,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC;;YAGJ,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;AAE3C,YAAA,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAyB,sBAAA,EAAA,OAAO,CAAe,YAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;AAChF,aAAC,CAAC;;AAGJ,QAAA,OAAO,OAAO;;AAGhB;;;;;;;;;;;;;;;;AAgBG;AACH,IAAA,MAAM,UAAU,CACd,OAAyB,EACzB,QAAkB,EAClB,OAWG,EAAA;QAEH,MAAM,OAAO,GAA8B,EAAE;QAE7C,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,QAAQ,EAAE,0BAA0B,CAAC,EAAE;AACzE,YAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE;YAEjC,MAAM,kBAAkB,GAAa,EAAE;YACvC,MAAM,sBAAsB,GAAa,EAAE;AAC3C,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;AAChC,gBAAA,IAAI,OAAO,EAAE,iBAAiB,KAAK,KAAK,EAAE;AACxC,oBAAA,IAAI;wBACF,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC;AAC3E,wBAAA,IAAI,gBAAgB,CAAC,OAAO,KAAK,EAAE,EAAE;4BACnC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;;AAE9C,oBAAA,MAAM;wBACN,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;;;;AAK9C,YAAA,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtE,MAAM,IAAI,KAAK,CACb,CAAA,QAAA,EAAW,OAAO,CAAG,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,CAA4B,yBAAA,EAAA,kBAAkB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA,GAAG,EAAE,GAC/J,sBAAsB,CAAC,MAAM,GAAG;sBAC5B,kCAAkC,sBAAsB,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAI,CAAA,EAAA,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE;AACvH,sBAAE,EACN,CAAkB,gBAAA,CAAA,CACnB;;AAGH,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;gBAChC,QAAQ,CAAC,cAAc,CAAC;AACtB,oBAAA,GAAG,OAAO;AACV,oBAAA,OAAO,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO;AACtD,oBAAA,MAAM,EAAE,OAAO;AACf,oBAAA,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;AACzB,iBAAA,CAAC;;YAGJ,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC;AAE3C,YAAA,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,IAAI,CACzC,CAAsB,mBAAA,EAAA,OAAO,CAAkB,eAAA,EAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA;AACpH,gBAAA,CAAA,kBAAA,EAAqB,MAAM,CAAC,OAAO,CAAA,UAAA,EAAa,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,cAAc,CAAA,CAAA,CAAG,CAC/F;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,KAAI;gBACpC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;AAChF,aAAC,CAAC;;AAGJ,QAAA,OAAO,OAAO;;AAEjB;;;;"}