Interface ChainAccount

Low level object that supports queries and operations for an account on a remote chain.

interface ChainAccount {
    close: (() => Promise<void>);
    deposit: ((payment) => Promise<void>);
    executeEncodedTx: ((msgs) => Promise<string>);
    executeTx: ((msgs) => Promise<string>);
    getAddress: (() => ChainAddress);
    getPurse: ((brand) => Promise<Purse>);
    prepareTransfer: (() => Promise<Invitation>);
}

Properties

close deposit executeEncodedTx executeTx getAddress getPurse prepareTransfer

Properties

close

close: (() => Promise<void>)

Close the remote account

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

deposit

deposit: ((payment) => Promise<void>)

deposit payment from zoe to the account

Type declaration

    • (payment): Promise<void>

    • Parameters

      • payment: Payment

      Returns Promise<void>

executeEncodedTx

executeEncodedTx: ((msgs) => Promise<string>)

Submit a transaction on behalf of the remote account for execution on the remote chain.

Type declaration

    • (msgs): Promise<string>

    • Parameters

      Returns Promise<string>

Returns

acknowledge string

executeTx

executeTx: ((msgs) => Promise<string>)

Submit a transaction on behalf of the remote account for execution on the remote chain.

Type declaration

    • (msgs): Promise<string>

    • Parameters

      Returns Promise<string>

Returns

acknowledgement string

getAddress

getAddress: (() => ChainAddress)

Type declaration

Returns

the address of the account on the remote chain

getPurse

getPurse: ((brand) => Promise<Purse>)

get Purse for a brand to .withdraw() a Payment from the account

Type declaration

    • (brand): Promise<Purse>

    • Parameters

      • brand: Brand

      Returns Promise<Purse>

prepareTransfer

prepareTransfer: (() => Promise<Invitation>)

Type declaration

    • (): Promise<Invitation>

    • Returns Promise<Invitation>

Settings

Member Visibility

Theme

On This Page

closedepositexecuteEncodedTxexecuteTxgetAddressgetPurseprepareTransfer