@agoric/orchestration 0.1.1-dev-d756c83.0.d756c83 → 0.1.1-dev-e9efaa1.0.e9efaa1

package/src/orchestration-api.js

@@ -0,0 +1,405 @@
+/**
+ * @file General API of orchestration
+ * - must not have chain-specific types without runtime narrowing by chain id
+ * - should remain relatively stable.
+ */
+                                                                          
+// eslint-disable-next-line @typescript-eslint/no-unused-vars -- fails to notice the @see uses
+                                                                                   
+                                              
+                                                                  
+                                                                                     
+                                              
+                                                   
+             
+                     
+                            
+                  
+                        
+              
+                      
+                   
+                 
+               
+                
+                  
+                    
+
+                                                                          
+
+                                    
+                                    
+  
+
+                                                    
+                         
+  
+
+/**
+ * Options relevant to all queries (non-mutating).
+ */
+                                              
+                                  
+  
+
+/**
+ * Options relevant to all actions (mutating).
+ */
+                                             
+                               
+  
+
+/**
+ * A denom that designates a path to a token type on some blockchain.
+ *
+ * Multiple denoms may designate the same underlying base denom (e.g., `uist`,
+ * `uatom`) on different Chains or on the same Chain via different paths. On
+ * Cosmos chains, all but the base denom are IBC style denoms, but that may vary
+ * across other chains. All the denoms that designate the same underlying base
+ * denom form an equivalence class, along with the unique Brand on the local
+ * Chain. Some operations accept any member of the equivalence class to
+ * effectively designate the corresponding token type on the target chain.
+ */
+                            // ibc/... or uist
+
+// ??? when multiple Denoms provide paths to the same remote token type,
+// should the brand be 1:1 with that equivalence class or each Denom?
+/**
+ * In many cases, either a denom string or a local Brand can be used to
+ * designate a remote token type.
+ */
+                                            
+
+/**
+ * Count of some fungible token on some blockchain.
+ *
+ * @see {@link Orchestrator.asAmount} to convert to an Amount surjectively
+ */
+                           
+               
+                       
+  
+
+/** Amounts can be provided as pure data using denoms or as ERTP Amounts */
+                                                    
+
+/**
+ * Per `chain_id` in CAIP-2. In that spec all chain IDs are scoped
+ * (namespace:reference) but in the Cosmos ecosystem the namespace is implied
+ * and they use `chain_id`/`chainId` for what CAIP-2 calls the `reference`. We
+ * qualify the term here to avoid confusion.
+ *
+ * @see {@link https://chainagnostic.org/CAIPs/caip-2}
+ */
+                                                
+
+/**
+ * à la CAIP-10
+ *
+ *   account_id:        chain_id + ":" + account_address
+ *   chain_id:          [-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32} (See [CAIP-2][])
+ *   account_address:   [-.%a-zA-Z0-9]{1,128}
+ *
+ * @see {@link https://chainagnostic.org/CAIPs/caip-10}
+ */
+                                                   
+
+/**
+ * Specific to Cosmos chains
+ * @see {AccountId} for universal account identifier
+ */
+                                  
+                                                                      
+                  
+                                        
+                       
+                     
+  
+
+/**
+ * Info used to identify blockchains across ecosystems
+ * @see {@link https://chainagnostic.org/CAIPs/caip-2}
+ */
+                                                                           
+                                                  
+               
+                                                
+                                                       
+     
+                                   
+                                                                             
+     
+                                 
+ 
+
+/**
+ * Shape that `ChainHub` is expecting
+ */
+                                                                  
+                                                          
+
+/**
+ * A value that can be converted mechanically to an AccountId.
+ * @see {@link ChainHub.resolveAccountId}
+ */
+                                                          
+
+                            
+                    
+                    
+                         
+  
+
+/**
+ * Object that controls an account on a particular chain.
+ *
+ * The methods available depend on the chain and its capabilities.
+ */
+                                                                 
+                              
+                                   
+                                               
+                             
+                                                
+                                                        
+                                         
+                
+
+/**
+ * An object for access the core functions of a remote chain.
+ *
+ * Note that "remote" can mean the local chain; it's just that
+ * accounts are treated as remote/arms length for consistency.
+ */
+                                                       
+                                  
+
+                                                     
+                                                                                                
+     
+                                                              
+                                                 
+     
+                
+                                
+                                     
+                                       
+            
+                                                               
+
+                                        
+                      
+                                    
+                                               
+                     
+               
+              
+
+                                                                            
+ 
+
+/**
+ * Used with `orch.getDenomInfo('ibc/1234')`. See {@link Orchestrator.getDenomInfo}
+ */
+                           
+                                         
+                                         
+   
+                                                            
+                
+                                                                                           
+                                          
+                                                             
+                                         
+                                                               
+                   
+ 
+
+/**
+ * Provided in the callback to `orchestrate()`.
+ */
+                               
+     
+                                                         
+    
+                                                                                                   
+     
+                               
+                 
+               
+                                                               
+                                                        
+    
+
+     
+                                                                           
+                                                                          
+                                    
+                 
+     
+                 
+                                           
+                                           
+    
+                 
+                               
+                                             
+
+     
+                                                                              
+                                         
+                                                   
+     
+                                               
+ 
+
+/**
+ * An object that supports high-level operations for an account on a remote chain.
+ */
+                                             
+     
+                                                            
+     
+                                       
+
+     
+                                                                   
+    
+                                                                          
+     
+                                                                 
+
+     
+                                                              
+    
+                                                                          
+     
+                                                                               
+
+     
+                                                                                  
+                          
+     
+                                             
+
+     
+                                                                                                             
+                                                                                    
+                                       
+                                                   
+                     
+     
+         
+                            
+                      
+                         
+                        
+
+     
+                                                                                                                       
+                                                                                    
+                                         
+                                                   
+                     
+     
+            
+                                  
+                         
+                         
+                        
+
+     
+                                                                       
+                                                       
+                                                                                                          
+                                                                
+                                                                                                                                 
+                                                                                                         
+                                                                              
+                                                                      
+     
+             
+                              
+                      
+                                 
+                        
+
+     
+                                                                                      
+                                                 
+                                           
+                                                                 
+                     
+     
+                                                                           
+
+     
+                                                                      
+                                                                            
+                                                     
+     
+                                                                  
+
+     
+                                                                             
+                                               
+                                                                     
+                                                    
+     
+                                                                               
+ 
+
+/**
+ * Flows to orchestrate are regular Javascript functions but have some
+ * constraints to fulfill the requirements of resumability after termination of
+ * the enclosing vat. Some requirements for each orchestration flow:
+ * - must not close over any values that could change between invocations
+ * - must satisfy the `OrchestrationFlow` interface
+ * - must be hardened
+ * - must not use `E()` (eventual send)
+ *
+ * The call to `orchestrate` using a flow function in reincarnations of the vat
+ * must have the same `durableName` as before. To help enforce these
+ * constraints, we recommend:
+ *
+ * - keeping flows in a `.flows.js` module
+ * - importing them all with `import * as flows` to get a single object keyed by
+ *   the export name
+ * - using `orchestrateAll` to treat each export name as the `durableName` of
+ *   the flow
+ * - adopting `@agoric/eslint-config` that has rules to help detect problems
+ */
+                                                  
+                                                                      
+ 
+
+/**
+ * Internal structure for TransferMsgs.
+ * The type must be able to express transfers across different chains and transports.
+ *
+ * NOTE Expected to change, so consider an opaque structure.
+ * @internal
+ */
+                              
+                                
+                      
+                     
+                
+ 
+
+/** @alpha */
+                              
+                    
+                                  
+ 
+/** @alpha */
+                            
+                   
+                    
+ 
+/** @alpha */
+                                  
+                   
+                  
+                   
+ 

package/src/types.js

@@ -0,0 +1,27 @@
+/** @file Rollup of all type definitions in the package, for local import and external export */
+
+                                       
+
+                                     
+                                     
+                                         
+                                                         
+                                                         
+                                              
+                                               
+                                                  
+                                                  
+                                                    
+                                            
+                                            
+                                             
+                                         
+
+/**
+ * ({@link ZCF})-like tools for use in {@link OrchestrationFlow}s.
+ */
+                           
+                                                  
+                                          
+                                        
+ 

package/src/utils/abitype.js

@@ -0,0 +1,13 @@
+                                                        
+
+// Redefine abitype's TypedDataParameter to make it generic
+                               
+                             
+                     
+                   
+                     
+                                           
+     
+           
+           
+