dckc
commented
2 months ago OrchestrationAccount.transfer() works on LocalOrchestrationAccount, which you can get from Orchestrator.makeLocalAccount(). I made a quick diagram of relevant parts of orchestration-api.ts and cosmos-api.ts:
classDiagram
class Orchestrator {
makeLocalAccount()
getChain(name)
}
Orchestrator --> LocalOrchestrationAccount: makeLocalAccount
Orchestrator --> CosmosChain: getChain
OrchestrationAccount <|-- LocalAccountMethods
LocalAccountMethods <|-- LocalOrchestrationAccount
OrchestrationAccount <|-- CosmosOrchestrationAccount
class OrchestrationAccount {
getAddress()
transfer(amt, destAddr, opts?)
}
class CosmosChain {
makeAccount()
}
CosmosChain --> CosmosOrchestrationAccount: makeAccount
class LocalAccountMethods {
deposit(pmt, amtShape?)
}
class LocalOrchestrationAccount {
}
class CosmosOrchestrationAccount {
transfer(amt, destAddr, opts?) // TODO #9784
}Note that transfer() on CosmosOrchestrationAccount is (currently) TODO:
LocalOrchestrationAccount has deposit(), which is a method that goes beyond the OrchestrationAccount interface. So a contract flow might do...
const localAcct = await orch.makeLocalAccount();
const amt = await localAcct.deposit(pmt);(TODO: Docs for OrchstrationAccount.deposit() should have this as an @example.)
Then:
const amtTxfrd = await localAcct.transfer(amt, destAddr);The destAddr might come from...
const destChain = await orch.getChain('osmosis');
const destAcct = await destChain.makeAccount();
const destAddr = destAcct.getAddress();The pmt might come from the offer handler seat by way of zoeTools.localTransfer:
await localTransfer(seat, localAcct, give);more docs TODOs:
- the
depositdocstring inLocalAccountMethodsshould have a@see { ZoeTools.localTransfer }- maybe on
withdraw()too. - or maybe just on
LocalAccountMethods - and we might need to
@import { ZoeTools } ...in order to get the link to work in the generated docs
- maybe on
zoeTools.localTransferandwithdrawFromSeatshould have the "contracts don't usually manage payments directly" hazard noted
Jovonni
Context
In our call with @Jovonni on 2024-07-30, he mentioned this idea.
Problem Definition
Currently, the frontend sends toy tokens (BLD, IST) to Osmosis by executing the IBC transfer inside the browser instead of triggering an offer to have a smart contract to do it. I believe below method is the relevant part for this in frontend code; https://github.com/Agoric/dapp-orchestration-basics/blob/ea55e9ce09d80cee729931ad7bf929fc84c41326/ui/src/components/Orchestration/Orchestration.tsx#L100
In order to demonstrate orchestration features and do this incrementally, we can have a smart contract execute simple IBC transfer as our next step.