Deployer | @algo-builder/algob

Hierarchy

Deployer

Properties

accounts

accounts: runtime.rtypes.Account[]

accountsByName

accountsByName: AccountMap

algodClient

algodClient: default

asa

asa: Map<string, ASAInfo>

Mapping of ASA name to deployment log

checkpoint

checkpoint: CheckpointFunctions

isDeployMode

isDeployMode: boolean

Allows user to know whether a script is running in a deploy or run mode.

Methods

addCheckpointKV

addCheckpointKV(key: string, value: string): void

- Defined in packages/algob/src/types.ts:435
Sets metadata key value for a current network in the chckpoint file based on the current deployment script. If run in a non deployment mode (eg algob run script_name.js) it will throw an exception.

Parameters
- key: string
- value: string
Returns void

assertCPNotDeleted

assertCPNotDeleted(execParams: ExecParams | ExecParams[]): void

- Defined in packages/algob/src/types.ts:713
Checks if checkpoint is deleted for a particular transaction if checkpoint exists and is marked as deleted, throw error(except for opt-out transactions), else pass

Parameters
- execParams: ExecParams | ExecParams[]
  
  Transaction execution parameters
Returns void

assertNoApp

assertNoApp(appName: string): void

- Defined in packages/algob/src/types.ts:474
Parameters
- appName: string
Returns void

assertNoAsset

assertNoAsset(name: string): void

- Defined in packages/algob/src/types.ts:472
Parameters
- name: string
Returns void

assertNoLsig

assertNoLsig(lsigName: string): void

- Defined in packages/algob/src/types.ts:473
Parameters
- lsigName: string
Returns void

compileASC

compileASC(name: string, scTmplParams?: types.SCParams, force?: boolean): Promise<ASCCache>

- Defined in packages/algob/src/types.ts:693
Returns ASCCache (with compiled code)

Parameters
- name: string
- Optional scTmplParams: types.SCParams
- Optional force: boolean
Returns Promise<ASCCache>

compileApplication

compileApplication(appName: string, source: SmartContract, scTmplParams?: types.SCParams): Promise<SourceCompiled>

- Defined in packages/algob/src/types.ts:695
Parameters
- appName: string
- source: SmartContract
- Optional scTmplParams: types.SCParams
Returns Promise<SourceCompiled>

deployASA

deployASA(name: string, flags: ASADeploymentFlags, asaParams?: Partial<{ clawback?: string; decimals: number | bigint; defaultFrozen?: boolean; freeze?: string; manager?: string; metadataHash?: string | Uint8Array | Buffer; name?: string; note?: string; noteb64?: string; optInAccNames?: string[]; reserve?: string; total: string | number | bigint; unitName?: string; url?: string }>): Promise<ASAInfo>

- Defined in packages/algob/src/types.ts:447
Creates and deploys ASA defined in asa.yaml.

name
ASA name - deployer will search for the ASA in the /assets/asa.yaml file

flags
deployment flags

Parameters
- name: string
- flags: ASADeploymentFlags
- Optional asaParams: Partial<{ clawback?: string; decimals: number | bigint; defaultFrozen?: boolean; freeze?: string; manager?: string; metadataHash?: string | Uint8Array | Buffer; name?: string; note?: string; noteb64?: string; optInAccNames?: string[]; reserve?: string; total: string | number | bigint; unitName?: string; url?: string }>
Returns Promise<ASAInfo>

deployASADef

deployASADef(name: string, asaDef: { clawback?: string; decimals: number | bigint; defaultFrozen?: boolean; freeze?: string; manager?: string; metadataHash?: string | Uint8Array | Buffer; name?: string; note?: string; noteb64?: string; optInAccNames?: string[]; reserve?: string; total: string | number | bigint; unitName?: string; url?: string }, flags: ASADeploymentFlags): Promise<ASAInfo>

- Defined in packages/algob/src/types.ts:459
Creates and deploys ASA without using asa.yaml.

name
ASA name

asadef
ASA definitions

flags
deployment flags

Parameters
- name: string
- asaDef: { clawback?: string; decimals: number | bigint; defaultFrozen?: boolean; freeze?: string; manager?: string; metadataHash?: string | Uint8Array | Buffer; name?: string; note?: string; noteb64?: string; optInAccNames?: string[]; reserve?: string; total: string | number | bigint; unitName?: string; url?: string }
  - Optional clawback?: string
  - decimals: number | bigint
  - Optional defaultFrozen?: boolean
  - Optional freeze?: string
  - Optional manager?: string
  - Optional metadataHash?: string | Uint8Array | Buffer
  - Optional name?: string
  - Optional note?: string
  - Optional noteb64?: string
  - Optional optInAccNames?: string[]
  - Optional reserve?: string
  - total: string | number | bigint
  - Optional unitName?: string
  - Optional url?: string
- flags: ASADeploymentFlags
Returns Promise<ASAInfo>

deployApp

deployApp(creator: default, appDefinition: AppDefinitionFromFile, payFlags: TxParams, scTmplParams?: types.SCParams, appName?: string): Promise<AppInfo>

- Defined in packages/algob/src/types.ts:560
Deploys stateful smart contract.

approvalprogram
approval program filename (must be present in assets folder)

clearprogram
clear program filename (must be present in assets folder)

flags
AppDeploymentFlags

payflags
Transaction Parameters

sctmplparams
Smart contract template parameters (used only when compiling PyTEAL to TEAL)

appname
name of the app to deploy. This name (if passed) will be used as the checkpoint "key", and app information will be stored agaisnt this name

Parameters
- creator: default
- appDefinition: AppDefinitionFromFile
- payFlags: TxParams
- Optional scTmplParams: types.SCParams
- Optional appName: string
Returns Promise<AppInfo>

ensureCompiled

ensureCompiled(name: string, force?: boolean, scTmplParams?: types.SCParams): Promise<ASCCache>

- Defined in packages/algob/src/types.ts:684
Alias to this.compileASC

deprecated
this function will be removed in the next release.

Parameters
- name: string
- Optional force: boolean
- Optional scTmplParams: types.SCParams
Returns Promise<ASCCache>

executeTx

executeTx(transactions: ExecParams[] | TransactionAndSign[]): Promise<ConfirmedTxInfo[]>

- Defined in packages/algob/src/types.ts:723
Execute single transaction or group of transactions (atomic transaction) executes ExecParams or Transaction Object, SDK Transaction object passed to this function will be signed and sent to network. User can use SDK functions to create transactions. Note: If passing transaction object a signer/s must be provided.

Parameters
- transactions: ExecParams[] | TransactionAndSign[]
Returns Promise<ConfirmedTxInfo[]>

fundLsig

fundLsig(lsigName: string, flags: FundASCFlags, payFlags: TxParams): void

- Defined in packages/algob/src/types.ts:520
This function will send Algos to ASC account in "Contract Mode".

Parameters
- lsigName: string
  
  name of the smart signature (passed by user during mkContractLsig/mkDelegatedLsig)
- flags: FundASCFlags
  
  Deployments flags (as per SPEC)
- payFlags: TxParams
  
  as per SPEC
Returns void

fundLsigByFile

fundLsigByFile(fileName: string, flags: FundASCFlags, payFlags: TxParams, scTmplParams?: types.SCParams): void

- Defined in packages/algob/src/types.ts:506
Funds logic signature account (Contract Account).

filename:
filename with a Smart Signature code (must be present in the assets folder)

payflags
Transaction Parameters

sctmplparams
Smart contract template parameters (used only when compiling PyTEAL to TEAL)

Parameters
- fileName: string
- flags: FundASCFlags
- payFlags: TxParams
- Optional scTmplParams: types.SCParams
Returns void

getASADef

getASADef(name: string, asaParams?: Partial<{ clawback?: string; decimals: number | bigint; defaultFrozen?: boolean; freeze?: string; manager?: string; metadataHash?: string | Uint8Array | Buffer; name?: string; note?: string; noteb64?: string; optInAccNames?: string[]; reserve?: string; total: string | number | bigint; unitName?: string; url?: string }>): { clawback?: string; decimals: number | bigint; defaultFrozen?: boolean; freeze?: string; manager?: string; metadataHash?: string | Uint8Array | Buffer; name?: string; note?: string; noteb64?: string; optInAccNames?: string[]; reserve?: string; total: string | number | bigint; unitName?: string; url?: string }

- Defined in packages/algob/src/types.ts:476
Parameters
- name: string
- Optional asaParams: Partial<{ clawback?: string; decimals: number | bigint; defaultFrozen?: boolean; freeze?: string; manager?: string; metadataHash?: string | Uint8Array | Buffer; name?: string; note?: string; noteb64?: string; optInAccNames?: string[]; reserve?: string; total: string | number | bigint; unitName?: string; url?: string }>
Returns { clawback?: string; decimals: number | bigint; defaultFrozen?: boolean; freeze?: string; manager?: string; metadataHash?: string | Uint8Array | Buffer; name?: string; note?: string; noteb64?: string; optInAccNames?: string[]; reserve?: string; total: string | number | bigint; unitName?: string; url?: string }
- Optional clawback?: string
- decimals: number | bigint
- Optional defaultFrozen?: boolean
- Optional freeze?: string
- Optional manager?: string
- Optional metadataHash?: string | Uint8Array | Buffer
- Optional name?: string
- Optional note?: string
- Optional noteb64?: string
- Optional optInAccNames?: string[]
- Optional reserve?: string
- total: string | number | bigint
- Optional unitName?: string
- Optional url?: string

getASAInfo

getASAInfo(name: string): ASAInfo

- Defined in packages/algob/src/types.ts:429
Parameters
- name: string
Returns ASAInfo

getApp

getApp(appName: string): AppInfo

- Defined in packages/algob/src/types.ts:663
Queries a stateful smart contract info from checkpoint name passed by user during deployment

Parameters
- appName: string
Returns AppInfo

getAssetByID

getAssetByID(assetIndex: number | bigint): Promise<Asset>

- Defined in packages/algob/src/types.ts:606
Queries blockchain using algodv2 for asset information by index

Parameters
- assetIndex: number | bigint
Returns Promise<Asset>

getCheckpointKV

getCheckpointKV(key: string): undefined | string

- Defined in packages/algob/src/types.ts:441
Queries metadata key in all checkpoint files of current network. If the key is not defined in any checkpoint then undefined is returned. Can be run in both run and deploy mode.

Parameters
- key: string
Returns undefined | string

getDeployedASC

getDeployedASC(name: string): Promise<undefined | ASCCache | AppCache>

- Defined in packages/algob/src/types.ts:705
Returns cached program (from artifacts/cache) ASCCache object by app/lsig name.

Parameters
- name: string
  
  App/Lsig name used during deployment
Returns Promise<undefined | ASCCache | AppCache>

getLsig

getLsig(lsigName: string): LogicSigAccount

- Defined in packages/algob/src/types.ts:670
Loads logic signature info(contract or delegated) from checkpoint (by lsig name)

Parameters
- lsigName: string
  
  name of the smart signture (defined by user during mkContractLsig/mkDelegatedLsig)
Returns LogicSigAccount

getReceiptTxns

getReceiptTxns(txns: Transaction[]): Promise<ConfirmedTxInfo[]>

- Defined in packages/algob/src/types.ts:497
Return receipts for each transaction in group txn

Parameters
- txns: Transaction[]
  
  list transaction in group
Returns Promise<ConfirmedTxInfo[]>
confirmed tx info of group

isDefined

isDefined(name: string): boolean

- Defined in packages/algob/src/types.ts:596
Returns true if ASA or DelegatedLsig or SSC were deployed in any script. Checks even for checkpoints which are out of scope from the execution session and are not obtainable using get methods.

Parameters
- name: string
Returns boolean

loadASADef

loadASADef(asaName: string): undefined | { clawback?: string; decimals: number | bigint; defaultFrozen?: boolean; freeze?: string; manager?: string; metadataHash?: string | Uint8Array | Buffer; name?: string; note?: string; noteb64?: string; optInAccNames?: string[]; reserve?: string; total: string | number | bigint; unitName?: string; url?: string }

- Defined in packages/algob/src/types.ts:470
Loads deployed asset definition from checkpoint. NOTE: This function returns "deployed" ASADef, as immutable properties of asaDef could be updated during tx execution (eg. update asset clawback)

name
ASA name - name of ASA in the /assets/asa.yaml file

Parameters
- asaName: string
Returns undefined | { clawback?: string; decimals: number | bigint; defaultFrozen?: boolean; freeze?: string; manager?: string; metadataHash?: string | Uint8Array | Buffer; name?: string; note?: string; noteb64?: string; optInAccNames?: string[]; reserve?: string; total: string | number | bigint; unitName?: string; url?: string }

loadLogicByFile

loadLogicByFile(name: string, scTmplParams?: types.SCParams): Promise<LogicSigAccount>

- Defined in packages/algob/src/types.ts:678
Loads contract mode logic signature (TEAL or PyTEAL)

name
Smart Contract filename (must be present in assets folder)

sctmplparams
Smart contract template parameters (used only when compiling PyTEAL to TEAL)

Parameters
- name: string
- Optional scTmplParams: types.SCParams
Returns Promise<LogicSigAccount>

loadMultiSig

loadMultiSig(name: string): Promise<LogicSig>

- Defined in packages/algob/src/types.ts:658
Extracts multi signed logic signature file from assets/.

Parameters
- name: string
Returns Promise<LogicSig>

log

log(msg: string, obj: any): void

- Defined in packages/algob/src/types.ts:654
Create an entry in a script log (stored in artifacts/scripts/.log) file.

Parameters
- msg: string
- obj: any
Returns void

logTx

logTx(message: string, txConfirmation: ConfirmedTxInfo): void

- Defined in packages/algob/src/types.ts:484
Parameters
- message: string
- txConfirmation: ConfirmedTxInfo
Returns void

mkContractLsig

mkContractLsig(lsigName: string, fileName: string, scTmplParams?: types.SCParams): Promise<LsigInfo>

- Defined in packages/algob/src/types.ts:543
Stores logic signature info in checkpoint for contract mode

lsigname
name of lsig (checkpoint info will be stored against this name)

filename
ASC file name

sctmplparams
: Smart contract template parameters (used only when compiling PyTEAL to TEAL)

Parameters
- lsigName: string
- fileName: string
- Optional scTmplParams: types.SCParams
Returns Promise<LsigInfo>

mkDelegatedLsig

mkDelegatedLsig(lsigName: string, fileName: string, signer: runtime.rtypes.Account, scTmplParams?: types.SCParams): Promise<LsigInfo>

- Defined in packages/algob/src/types.ts:530
Makes delegated logic signature signed by the signer.

lsigname
name of smart signature (checkpoint info will be stored against this name)

filename
Smart Signature filename (must be present in assets folder)

signer
Signer Account which will sign the smart contract

sctmplparams
Smart contract template parameters (used only when compiling PyTEAL to TEAL)

Parameters
- lsigName: string
- fileName: string
- signer: runtime.rtypes.Account
- Optional scTmplParams: types.SCParams
Returns Promise<LsigInfo>

optInAccountToASA

optInAccountToASA(asa: string, accountName: string, flags: TxParams): Promise<void>

- Defined in packages/algob/src/types.ts:611
Creates an opt-in transaction for given ASA name, which must be defined in /assets/asa.yaml file. The opt-in transaction is signed by the account secret key

Parameters
- asa: string
- accountName: string
- flags: TxParams
Returns Promise<void>

optInAccountToApp

optInAccountToApp(sender: runtime.rtypes.Account, appID: number, payFlags: TxParams, flags: runtime.rtypes.AppOptionalFlags): Promise<void>

- Defined in packages/algob/src/types.ts:630
Opt-In to stateful smart contract (SSC) for a single account signed by account secret key

Parameters
- sender: runtime.rtypes.Account
  
  sender account
- appID: number
  
  application index
- payFlags: TxParams
  
  Transaction flags
- flags: runtime.rtypes.AppOptionalFlags
  
  Optional parameters to SSC (accounts, args..)
Returns Promise<void>

optInLsigToASA

optInLsigToASA(asa: string, lsig: LogicSigAccount, flags: TxParams): Promise<void>

- Defined in packages/algob/src/types.ts:620
Creates an opt-in transaction for given ASA name, which must be defined in /assets/asa.yaml file. The opt-in transaction is signed by the logic signature

Parameters
- asa: string
- lsig: LogicSigAccount
- flags: TxParams
Returns Promise<void>

optInLsigToApp

optInLsigToApp(appID: number, lsig: LogicSigAccount, payFlags: TxParams, flags: runtime.rtypes.AppOptionalFlags): Promise<void>

- Defined in packages/algob/src/types.ts:645
Opt-In to stateful smart contract (SSC) for a contract account The opt-in transaction is signed by the logic signature

Parameters
- appID: number
  
  application index
- lsig: LogicSigAccount
- payFlags: TxParams
  
  Transaction flags
- flags: runtime.rtypes.AppOptionalFlags
  
  Optional parameters to SSC (accounts, args..)
Returns Promise<void>

persistCP

persistCP(): void

- Defined in packages/algob/src/types.ts:478
Returns void

registerASAInfo

registerASAInfo(name: string, asaInfo: ASAInfo): void

- Defined in packages/algob/src/types.ts:480
Parameters
- name: string
- asaInfo: ASAInfo
Returns void

registerSSCInfo

registerSSCInfo(name: string, sscInfo: AppInfo): void

- Defined in packages/algob/src/types.ts:482
Parameters
- name: string
- sscInfo: AppInfo
Returns void

sendAndWait

sendAndWait(rawTxns: Uint8Array | Uint8Array[]): Promise<ConfirmedTxInfo>

- Defined in packages/algob/src/types.ts:490
Send signed transaction to network and wait for confirmation

Parameters
- rawTxns: Uint8Array | Uint8Array[]
  
  Signed Transaction(s)
Returns Promise<ConfirmedTxInfo>

updateApp

updateApp(appName: string, sender: default, payFlags: TxParams, appID: number, newAppCode: SmartContract, flags: runtime.rtypes.AppOptionalFlags, scTmplParams?: types.SCParams): Promise<AppInfo>

- Defined in packages/algob/src/types.ts:581
Update programs(approval, clear) for a stateful smart contract.

Parameters
- appName: string
  
  name of the app to deploy. This name (if passed) will be used as the checkpoint "key", and app information will be stored agaisnt this name
- sender: default
  
  Account from which call needs to be made
- payFlags: TxParams
  
  Transaction Flags
- appID: number
  
  ID of the application being configured or empty if creating
- newAppCode: SmartContract
- flags: runtime.rtypes.AppOptionalFlags
  
  Optional parameters to SSC (accounts, args..)
- Optional scTmplParams: types.SCParams
Returns Promise<AppInfo>

waitForConfirmation

waitForConfirmation(txId: string): Promise<ConfirmedTxInfo>

- Defined in packages/algob/src/types.ts:602
Queries blockchain for a given transaction and waits until it will be processed.

Parameters
- txId: string
Returns Promise<ConfirmedTxInfo>

Hierarchy

Index

Properties

Methods

Properties

accounts

accountsByName

algodClient

asa

checkpoint

isDeployMode

Methods

addCheckpointKV

Parameters

key: string

value: string

Returns void

assertCPNotDeleted

Parameters

execParams: ExecParams | ExecParams[]

Returns void

assertNoApp

Parameters

appName: string

Returns void

assertNoAsset

Parameters

name: string

Returns void

assertNoLsig

Parameters

lsigName: string

Returns void

compileASC

Parameters

name: string

Optional scTmplParams: types.SCParams

Optional force: boolean

Returns Promise<ASCCache>

compileApplication

Parameters

appName: string

source: SmartContract

Optional scTmplParams: types.SCParams

Returns Promise<SourceCompiled>

deployASA

Parameters

name: string

flags: ASADeploymentFlags

Returns Promise<ASAInfo>

deployASADef

Parameters

name: string

Optional clawback?: string

decimals: number | bigint

Optional defaultFrozen?: boolean

Optional freeze?: string

Optional manager?: string

Optional metadataHash?: string | Uint8Array | Buffer

Optional name?: string

Optional note?: string

Optional noteb64?: string

Optional optInAccNames?: string[]

Optional reserve?: string

total: string | number | bigint

Optional unitName?: string

Optional url?: string

flags: ASADeploymentFlags

Returns Promise<ASAInfo>

deployApp

Parameters

creator: default

appDefinition: AppDefinitionFromFile

payFlags: TxParams

Optional scTmplParams: types.SCParams

Optional appName: string

Returns Promise<AppInfo>

ensureCompiled

Parameters

name: string